Event (Topic) List

Access token Related Event
- app_installation_token/create
- app_installation_token/revoke
App Metafields Related Event
- app_metafields/create
- app_metafields/remove
- app_metafields/update
App Subscription Related Event
- application_subscription/create
- application_subscription/delete
- application_subscription/update
Application Related Event
- application/install
- application/uninstall
Bulk operation Related Event
- bulk_operation/status_update
Category Related Event
- category/create
- category/remove
- category/update
Customer Related Event
- customer/create
- customer/membership_tier_update
- customer/mobile_sign_in
- customer/remove
- customer/sign_in
- customer/update
Flash price campaign Related Event
- flash_price_campaign/activate
- flash_price_campaign/expire
- flash_price_campaign/terminate
Invoice Related Event
- invoice/create
Member Point Related Event
- member_point/create
Merchant Related Event
- merchant/update
Metafield Definitions Related Event
- metafield_definitions/create
- metafield_definitions/remove
Metafields Related Event
- metafields/create
- metafields/remove
- metafields/update
Order Related Event
- order/cancel
- order/complete
- order/confirm
- order/create
- order/pending
- order/product_detail_notify_customer
- order/remove
- order/status_notify_customer
- order/update
Order Delivery Related Event
- order_delivery/status_notify_customer
- order_delivery/update
Order Payment Related Event
- order_payment/complete
- order_payment/refund
- order_payment/status_notify_customer
- order_payment/update
Persistent cart Related Event
- persistent_cart/abandoned_cart
Product Related Event
- product/create
- product/inventory_update
- product/remove
- product/update
- stock/update
Product Review Comments Related Event
- product_review_comment/create
Promotion Related Event
- promotion/redeeem
Subscription Record Related Event
- subscription_record/end
- subscription_record/start
Tag Related Event
- tag/create
- tag/remove
User Credit Related Event
- user_credit/create
- user_credit/update
Warehouse Related Event
- warehouse/create

Access token Related Event

app_installation_token/create

Topic Name:

app_installation_token/create

Description:

App installation (前題是該APP DC有enabled App Installation Token)

Required Scopes in DC App Scope page:

no scope is required, but you need to enable this in OAuth Strategy

Payload Example:

{
  "event": "AccessToken",
  "is_devstore": true,
  "merchant_id": "5f0e8941c68746000897e1f7",
  "resource": {
    "_id": "645120c39b5a04000df887cc",
    "application_id": "642e3aed696d9f000e94c99c",
    "created_at": "2023-05-02T14:40:03.887Z",
    "expires_at": "2340-03-22T08:26:42.887Z",
    "expires_in": 9999999999,
    "is_app_installation_token": true,
    "resource_owner_id": {
      "id": "5f0e8941c68746000897e1f7",
      "performer_id": "5f0e894156baf200189ce906"
    },
    "scopes": "products orders pages addon_products",
    "token": "ey******7I",
    "updated_at": "2023-05-02T14:40:03.892Z",
    "version_type": "TESTING"
  },
  "topic": "access_token/app_installation_token_create",
  "trace_id": "79021955-9239-4435-a6bc-62dc2a685eca",
  "ts": "1683038404039389949"
}

app_installation_token/revoke

Topic Name:

app_installation_token/revoke

Description:

App uninstallation (前題是該APP DC有enabled App Installation Token)
subscription 過期自動trigger revoke

Required Scopes in DC App Scope page:

no scope is required, but you need to enable this in OAuth Strategy

Payload Example:

{
  "event": "AccessToken",
  "is_devstore": true,
  "merchant_id": "5f0e8941c68746000897e1f7",
  "resource": {
    "_id": "64367871931544000bf889f8",
    "application_id": "642e3aed696d9f000e94c99c",
    "created_at": "2023-04-12T09:22:57.906Z",
    "expires_at": "2340-03-02T03:09:36.906Z",
    "expires_in": 9999999999,
    "is_app_installation_token": true,
    "resource_owner_id": {
      "id": "5f0e8941c68746000897e1f7",
      "performer_id": "5f0e894156baf200189ce906"
    },
    "revoked_at": "2023-05-02T14:39:27.88Z",
    "scopes": "products orders pages addon_products",
    "token": "ey******7I",
    "updated_at": "2023-05-02T14:39:27.88Z",
    "version_type": "TESTING"
  },
  "topic": "access_token/app_installation_token_revoke",
  "trace_id": "1c52daca-9e70-4bfd-9d61-642467e4f972",
  "ts": "1683038367979744724"
}

App Metafields Related Event

app_metafields/create

Topic Name:

app_metafields/create

Required Scopes in DC App Scope page:

App Metafields - index, or;
App Metafields - show, or;
App Metafields - all;

Trigger Point:

Products & Categories > Products > Edit

Payload Example:

{
  "application_id": "678f4a22faaebc8f69be46f8",
  "event": "AppMetafields",
  "merchant_id": "6780d87211a9230008048d60",
  "resource": {
    "application_id": "678f4a22faaebc8f69be46f8",
    "created_at": "2025-03-05T04:53:57.570+00:00",
    "field_type": "single_line_text_field",
    "field_value": "text-size-guild",
    "id": "67c7d8e57bf8c65836af561d",
    "key": "sizeguild",
    "merchant_id": "6780d87211a9230008048d60",
    "metafield_type": "app",
    "namespace": "678f4a22faaebc8f69be46f8",
    "resource_id": "67a3715d68ad6f003bba73d7",
    "resource_type": "product",
    "updated_at": "2025-03-05T04:53:57.570+00:00"
  },
  "topic": "app_metafields/create",
  "trace_id": "3a44dde2-0270-4d6d-bade-b37f1bae4695",
  "ts": "1741150437668948939"
}

app_metafields/remove

Topic Name:

app_metafields/remove

Required Scopes in DC App Scope page:

App Metafields - index, or;
App Metafields - show, or;
App Metafields - all;

Trigger Point:

目前UI上沒有remove，需要call OPENAPI Trigger
例子在swagger xxx/app_metafields/{metafield_id} 和和xxx/app_metafields/bulk

Payload Example:

{
  "application_id": "678f4a22faaebc8f69be46f8",
  "event": "AppMetafields",
  "merchant_id": "6780d87211a9230008048d60",
  "resource": {
    "id": "67c7da4d7bf8c65836af70a1"
  },
  "topic": "app_metafields/remove",
  "trace_id": "5cd21e0e-d2ad-4ce8-9958-e566446b5f2e",
  "ts": "1741258529442410539"
}

app_metafields/update

Topic Name:

app_metafields/update

Required Scopes in DC App Scope page:

App Metafields - index, or;
App Metafields - show, or;
App Metafields - all;

Trigger Point:

Products & Categories > Products > Edit

Payload Example:

{
  "application_id": "678f4a22faaebc8f69be46f8",
  "event": "AppMetafields",
  "merchant_id": "6780d87211a9230008048d60",
  "resource": {
    "application_id": "678f4a22faaebc8f69be46f8",
    "created_at": "2025-03-05T04:53:57.570+00:00",
    "field_type": "single_line_text_field",
    "field_value": "text-size-guild-updated",
    "id": "67c7d8e57bf8c65836af561d",
    "key": "sizeguild",
    "merchant_id": "6780d87211a9230008048d60",
    "metafield_type": "app",
    "namespace": "678f4a22faaebc8f69be46f8",
    "resource_id": "67a3715d68ad6f003bba73d7",
    "resource_type": "product",
    "updated_at": "2025-03-05T04:54:36.665+00:00"
  },
  "topic": "app_metafields/update",
  "trace_id": "31931a79-7525-47a4-868a-c354e908c6fe",
  "ts": "1741150476712731105"
}

App Subscription Related Event

application_subscription/create

Topic Name:

application_subscription/create

Description:

AppSubscription.subscribeMany

Required Scopes in DC App Scope page:

no scope is required

Trigger Point:

When a user begins a paid app subscription
When a user starts a free trial of an application
When a user converts from the free trial to a paid app subscription
When a user begins a custom subscription.

Payload Example:

{
  "event": "ApplicationSubscription",
  "merchant_id": "657fe76b11d72b1c22fb4aaf",
  "resource": {
    "_id": "657ff0c1a6851fa1163e7e65",
    "application_id": "65795f6cb5d36bccbb40fb70",
    "merchant_id": "657fe76b11d72b1c22fb4aaf"
  },
  "topic": "application_subscription/create",
  "trace_id": "e0d0fa95-ad55-415f-bb96-b1c0101af11c",
  "ts": "1741146106262000000"
}

application_subscription/delete

Topic Name:

application_subscription/delete

Description:

AppSubscription.unsubscribeMany

Required Scopes in DC App Scope page:

no scope is required

Trigger Point:

When a user's SHOPLINE main subscription ends, and the application is not included in the next subscription
When a user converts from the free trial to a paid app subscription
When a free trial period of an application ends
When main / app subscription grace period ends

Payload Example:

{
  "event": "ApplicationSubscription",
  "merchant_id": "657fe76b11d72b1c22fb4aaf",
  "resource": {
    "_id": "657ff0c1a6851fa1163e7e65",
    "application_id": "65795f6cb5d36bccbb40fb70",
    "merchant_id": "657fe76b11d72b1c22fb4aaf"
  },
  "topic": "application_subscription/delete",
  "trace_id": "3908399b-88cc-41de-981b-3471f730571a",
  "ts": "1741146106262000000"
}

application_subscription/update

Topic Name:

application_subscription/update

Description:

MyApps toggle subscribe/unsubscribe

Required Scopes in DC App Scope page:

no scope is required

Trigger Point:

When a user unsubscribes/churns an ongoing app subscription
When a user resubscribes/reactivates an unsubscribed app subscription

Payload Example:

{
  "event": "ApplicationSubscription",
  "merchant_id": "657fe76b11d72b1c22fb4aaf",
  "resource": {
    "_id": "657ff0c1a6851fa1163e7e65",
    "application_id": "65795f6cb5d36bccbb40fb70",
    "merchant_id": "657fe76b11d72b1c22fb4aaf"
  },
  "topic": "application_subscription/update",
  "trace_id": "833c5893-b902-4481-bf8c-9c3bd22d3460",
  "ts": "1741146106262000000"
}

Application Related Event

application/install

Topic Name:

application/install

Description:

App installation

Required Scopes in DC App Scope page:

no scope is required

Trigger Point:

When a user installs an application
When a user starts a free trial of an application

Payload Example:

{
  "event": "Application",
  "merchant_id": "657fe76b11d72b1c22fb4aaf",
  "resource": {
    "__v": "1",
    "_id": "657ff0c1a6851fa1163e7e5f",
    "app_settings": {
      "_id": "657ff0c1a6851fa1163e7e60",
      "app_scripts_activated": false
    },
    "application_id": "65795f6cb5d36bccbb40fb70",
    "application_version": "6579621ab5d36bccbb41ae7c",
    "authorized_at": "2023-12-18T07:12:01.899Z",
    "authorized_grants_digest": "96f4dc0375883b598eeacf9dad91e40d",
    "created_at": "2023-12-18T07:12:01.899Z",
    "deleted_at": null,
    "installed_by": "MERCHANT",
    "merchant_id": "657fe76b11d72b1c22fb4aaf",
    "requested_grants_digest": "96f4dc0375883b598eeacf9dad91e40d",
    "updated_at": "2024-07-19T08:47:19.126Z",
    "version_type": "LIVE"
  },
  "topic": "application/install",
  "trace_id": "0d263d53-142f-45ce-b1de-dd9271e792d8",
  "ts": "1741146106262000000"
}

application/uninstall

Topic Name:

application/uninstall

Description:

App uninstallation

Required Scopes in DC App Scope page:

no scope is required

Trigger Point:

When a user uninstalls an application
When a user's SHOPLINE main subscription ends, and the application is not included in the next subscription

Payload Example:

{
  "event": "Application",
  "merchant_id": "657fe76b11d72b1c22fb4aaf",
  "resource": {
    "__v": "1",
    "_id": "657ff0c1a6851fa1163e7e5f",
    "app_settings": {
      "_id": "657ff0c1a6851fa1163e7e60",
      "app_scripts_activated": false
    },
    "application_id": "65795f6cb5d36bccbb40fb70",
    "application_version": "6579621ab5d36bccbb41ae7c",
    "authorized_at": "2023-12-18T07:12:01.899Z",
    "authorized_grants_digest": "96f4dc0375883b598eeacf9dad91e40d",
    "created_at": "2023-12-18T07:12:01.899Z",
    "deleted_at": null,
    "installed_by": "MERCHANT",
    "merchant_id": "657fe76b11d72b1c22fb4aaf",
    "requested_grants_digest": "96f4dc0375883b598eeacf9dad91e40d",
    "updated_at": "2024-07-19T08:47:19.126Z",
    "version_type": "LIVE"
  },
  "topic": "application/uninstall",
  "trace_id": "6c9cd137-05bc-47fc-a996-95e0dc9ea73c",
  "ts": "1741146106262000000"
}

Bulk operation Related Event

bulk_operation/status_update

Topic Name:

bulk_operation/status_update

Required Scopes in DC App Scope page:

Bulk Operations - index, or
Bulk Operations - show;
Bulk Operations - all;

Payload Example:

{
  "event": "JobTracker",
  "merchant_id": "657fe76b11d72b1c22fb4aaf",
  "resource": {
    "created_by": "system",
    "execution_count": 1,
    "expiry_time": "2023-12-18T19:59:04.078+00:00",
    "failed_count": 0,
    "finish_time": "2023-12-18T07:59:07.318+00:00",
    "id": "657ffbc8ec33fa005f8a3820",
    "merchant_id": "657fe76b11d72b1c22fb4aaf",
    "name": "products_bulk_creation_oa",
    "name_translations": null,
    "owner_id": null,
    "owner_type": null,
    "performer_id": "657fe76bec33fa005c8a36c9",
    "performer_name": "api測試",
    "performer_type": null,
    "performing_application_id": "65795f6c6b6d34000a4fbd09",
    "ref_data": {
      "deduplication": {
        "merchant_wise": "1c28e9a74c96f2d6c620b0ea58f60b7292da34bf76442b0ab306f7d98ea168f9"
      },
      "result_file": "https://open-api-node-bulk-operations-data-staging.s3.ap-southeast-1.amazonaws.com/sl-openapi-bulk-operations/657ffbc8ec33fa005f8a3820/results/summary.json?AWSAccessKeyId=ASIAU3BJT6VWNVLE4IP4&Expires=1741198062&Signature=bD4Lw%2FdA0BuabPKdvIrfSj7boAk%3D&x-amz-security-token=IQoJb3JpZ2luX2VjEMf%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDmFwLXNvdXRoZWFzdC0xIkcwRQIgehyC12J4x4AexzA11E8bXgGZlSGNBeVkYHbVpjE1IKgCIQDvPMd8zZ6yr6lh9jgug63uTZsa%2BoxD9R2gDzV8scG0Giq3BQgQEAAaDDMzMjk0NzI1NjY4NCIMMqS5ah0A3lcb1afiKpQFJbgOWJhco1AWHjSmV%2BAXeSP6bZMUI0v%2FUSMKS6aWdzVUCCU5WQDxrhTtfLMHu3u1KdvcVTufnJjxRVczS1V9X4sC3aS%2F10Fz6ebTplWVWCqAVtCIfHVOeBR6qK%2Fg3aZo7HH1CLIKWN5QZxvCWVW4F8vnQ0PCSitVtARCBPKAsYnymvBPGV0m961LtL4wt%2BLBnWxPlvyyIhnjQuLnnWj%2F9EaGtIUEpg5u%2F%2B0V1XdFDCaH3KZmVvLwVRgb98AhiwJyrvV2smuAIOkoU%2FVmFLDSxFP5kS0qjeSAfMhx4QSkbShi%2FZPUdacvb786cmN3kY0GybDxuZRig8C51WKChAaKi%2B24ZqXlxMAa9Svnn6nLFB56a5wQXxqVswWddf18yvI14hQWt5K3FqElVUAatTuCHr0opHCo%2FjRZkDN42XYivRIiWZmkIwRp1LC2dpj%2Bv22m%2B8YDresc2vMRoH2WX1C%2BhBRacpb6osm0IXyYJ3qRPH8WW8ZH1YLimtTazuIt1CaJz6Ps5QOXS2VVQGcSuyQo13ZISDCqv85XXka%2FkreGcUiaryFgfr083ax4J9ihR8GqEjXw5rzVG4s7iht8JX1xp040YYdRb5Fd5qQ1GE9RvYtVlGlosWNvf62Dv7oER6zX9AdCN%2BUttdM0Zgo2Me0eRZXHsFJTVooJ91XrPAxseDQfRb2xdGugNev42mzcjK65puzrQaKWe3be7cq9PY456TvXxwrHKPTgNnwV6daBS0jgiuB65y6kOTHsXji9fI%2BTnD8ru%2Fgr8l9GG%2BdrjiYA2d%2Fp6eOQu%2FuDrP%2BV9TkdPf7JEB%2BpphbtPz8jACry1RaSsFRJPY4PaUQEoxugn8G9SuYbCHuRMTs6Em2mHLLyfw65mwklML7wn74GOpsBRmSF7lU6Wuu6KcmUbOd9%2F%2FrcZFucyu1zKHBsqU8VP1udX8mglu8cqZuvEzc1yZf9tYjJQbLsp9X4Q3mvOY2YRgd47wpBb3GebAoeZZIuSqWwAbAv%2B%2FXpmMdkUmdxMkrfrmo%2FmdDsMfWKOdGw6VtoqSTsCBWLxpi28Mmdh3NUpcieXUHvjfEtpc889pY%2FNnNy%2BYAf1TtLxhNdPnQ%3D"
    },
    "start_time": "2023-12-18T07:59:04.078+00:00",
    "status": "done",
    "successful_count": 1,
    "total_count": 1,
    "type": "product"
  },
  "topic": "bulk_operation/status_update",
  "trace_id": "fd745d31-1f9c-4d3b-aa33-88fb2af38d7e",
  "ts": "1741155824798000000"
}

Category Related Event

category/create

Topic Name:

category/create

Description:

商品分類建立時

Trigger Point:

创建分類

Payload Example:

{
  "event": "Category",
  "merchant_id": "60f66462262ba6002b9c0462",
  "resource": {
    "banner_medias": [
      {
        "_id": "655f10bd75c667003d66fd00",
        "alt_translations": {},
        "blurhash": "U59aES_4t8sltnx^%Mng~pNMM}xWo#t7t6V@",
        "images": {
          "original": {
            "height": 107,
            "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/655f10bd75c667003d66fd00/original.png?1700729021",
            "width": 1046
          }
        },
        "link": null,
        "new_tab": null
      }
    ],
    "created_by": "admin",
    "id": "655f10d275c667003466fcff",
    "key": null,
    "name_translations": {
      "en": "OA-2338-en",
      "ja": "OA-2338-jp",
      "th": "OA-2338-ti",
      "vi": "OA-2338-vi",
      "zh-cn": "OA-2338-cn",
      "zh-hant": "OA-2338-zh"
    },
    "parent_id": null,
    "priority": 14,
    "seo_description_translations": {
      "en": "",
      "ja": "",
      "th": "",
      "vi": "",
      "zh-cn": "",
      "zh-hant": ""
    },
    "seo_keywords": null,
    "seo_title_translations": {
      "en": "OA-2338-en",
      "ja": "OA-2338-jp",
      "th": "OA-2338-ti",
      "vi": "OA-2338-vi",
      "zh-cn": "OA-2338-cn",
      "zh-hant": "OA-2338-zh"
    },
    "status": "active"
  },
  "topic": "category/create",
  "trace_id": "3c5d12db-01a2-4291-9ee6-80747cb78eeb",
  "ts": "1700729042301360000"
}

category/remove

Topic Name:

category/remove

Description:

商品分類刪除時

Trigger Point:

删除分類

Payload Example:

{
  "event": "Category",
  "merchant_id": "60f66462262ba6002b9c0462",
  "resource": {
    "banner_medias": [
      {
        "_id": "655f10bd75c667003d66fd00",
        "alt_translations": {},
        "blurhash": "U59aES_4t8sltnx^%Mng~pNMM}xWo#t7t6V@",
        "images": {
          "original": {
            "height": 107,
            "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/655f10bd75c667003d66fd00/original.png?1700729021",
            "width": 1046
          }
        },
        "link": null,
        "new_tab": null
      }
    ],
    "created_by": "admin",
    "id": "655f10d275c667003466fcff",
    "key": null,
    "name_translations": {
      "en": "OA-2338-en",
      "ja": "OA-2338-jp",
      "th": "OA-2338-ti",
      "vi": "OA-2338-vi",
      "zh-cn": "OA-2338-cn",
      "zh-hant": "OA-2338-zh"
    },
    "parent_id": null,
    "priority": 14,
    "seo_description_translations": {
      "en": "",
      "ja": "",
      "th": "",
      "vi": "",
      "zh-cn": "",
      "zh-hant": ""
    },
    "seo_keywords": null,
    "seo_title_translations": {
      "en": "OA-2338-en",
      "ja": "OA-2338-jp",
      "th": "OA-2338-ti",
      "vi": "OA-2338-vi",
      "zh-cn": "OA-2338-cn",
      "zh-hant": "OA-2338-zh"
    },
    "status": "active"
  },
  "topic": "category/remove",
  "trace_id": "3c5d12db-01a2-4291-9ee6-80747cb78eeb",
  "ts": "1700729042301360000"
}

category/update

Topic Name:

category/update

Description:

商品分類更新時

Trigger Point:

新增商品到分類中
編輯分類

Payload Example:

{
  "event": "Category",
  "merchant_id": "60f66462262ba6002b9c0462",
  "resource": {
    "banner_medias": [
      {
        "_id": "655f10bd75c667003d66fd00",
        "alt_translations": {},
        "blurhash": "U59aES_4t8sltnx^%Mng~pNMM}xWo#t7t6V@",
        "images": {
          "original": {
            "height": 107,
            "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/655f10bd75c667003d66fd00/original.png?1700729021",
            "width": 1046
          }
        },
        "link": null,
        "new_tab": null
      }
    ],
    "created_by": "admin",
    "id": "655f10d275c667003466fcff",
    "key": null,
    "name_translations": {
      "en": "OA-2338-en",
      "ja": "OA-2338-jp",
      "th": "OA-2338-ti",
      "vi": "OA-2338-vi",
      "zh-cn": "OA-2338-cn",
      "zh-hant": "OA-2338-zh"
    },
    "parent_id": null,
    "priority": 14,
    "seo_description_translations": {
      "en": "",
      "ja": "",
      "th": "",
      "vi": "",
      "zh-cn": "",
      "zh-hant": ""
    },
    "seo_keywords": null,
    "seo_title_translations": {
      "en": "OA-2338-en",
      "ja": "OA-2338-jp",
      "th": "OA-2338-ti",
      "vi": "OA-2338-vi",
      "zh-cn": "OA-2338-cn",
      "zh-hant": "OA-2338-zh"
    },
    "status": "active"
  },
  "topic": "category/update",
  "trace_id": "3c5d12db-01a2-4291-9ee6-80747cb78eeb",
  "ts": "1700729042301360000"
}

Customer Related Event

customer/create

Topic Name:

customer/create

Description:

當有新的顧客建立時觸發

Required Scopes in DC App Scope page:

Customers - index, or;
Customers - show, or;
Customers - all;

Trigger Point:

storefront email signup
storefront mobile signup
storefront facebook signup
storefront line signup
SSO 註冊新增會員 (2022/07/27 tested by Iris)
商家若有啟用訪客結單功能，訪客結單會觸發 (2022/11/23 tested by Martin)
在 Admin 大量匯入新會員

Payload Example:

{
  "event": "Customer",
  "merchant_id": "657fe76b11d72b1c22fb4aaf",
  "resource": {
    "_id": "657feb68a7cb17eff1a7ce36",
    "birth_day": null,
    "birth_month": null,
    "birth_year": null,
    "birthday": null,
    "confirmed_at": null,
    "created_at": "2023-12-18T06:49:27.385Z",
    "created_by": "shop",
    "credit_balance": 5,
    "current_sign_in_at": "2024-02-01T08:41:45.959Z",
    "custom_data": [],
    "customer_authentication_linkings": [],
    "delivery_addresses": [
      {
        "address_1": "test address",
        "address_2": "Wong Tai Sin",
        "city": "Kowloon",
        "country": "HK",
        "district": "San Po Kong",
        "key": null,
        "layer1": null,
        "layer2": null,
        "layer3": null,
        "logistic_codes": [
          "2200002",
          "2200016",
          "2200074"
        ],
        "postcode": null,
        "recipient_name": "TestingUser",
        "recipient_phone": "93533001",
        "recipient_phone_country_code": "852",
        "state": null
      }
    ],
    "email": "[email protected]",
    "email_verified": true,
    "facebook_id": null,
    "gender": null,
    "id": "657feb68a7cb17eff1a7ce36",
    "info_reward_claimed": false,
    "is_blacklisted": false,
    "is_member": true,
    "is_subscribed_marketing_email": false,
    "last_sign_in_at": "2024-02-01T08:41:13.102Z",
    "line_id": null,
    "locale_code": "en",
    "member_point_balance": 10,
    "membership_tier": {
      "id": "657ff01e0abede003ade8873",
      "level": 1,
      "name_translations": {
        "zh-hant": "test member tier"
      },
      "status": "active"
    },
    "memo": null,
    "mobile_phone": null,
    "mobile_phone_country_calling_code": null,
    "mobile_phone_verified": false,
    "name": "TestingUser",
    "offline_referral_agent_id": null,
    "offline_referral_channel_id": null,
    "offline_referral_registered_at": null,
    "order_count": 2,
    "orders_total_sum": {
      "cents": 7000,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 70,
      "label": "HK$70.00"
    },
    "phone": null,
    "phone_country_code": null,
    "phones": [],
    "ref_user_id": null,
    "referral_code": "u38HY",
    "registered_at": "2023-12-18T06:49:27.340+00:00",
    "subscribed_email_types": [],
    "subscriptions": [
      {
        "is_active": false,
        "platform": "sms"
      },
      {
        "is_active": false,
        "platform": "email"
      }
    ],
    "tags": [
      "test_c_tag"
    ],
    "tier_expires_at": null,
    "unconfirmed_email": null,
    "updated_at": "2024-09-04T08:07:06.903Z",
    "utm_data": {}
  },
  "topic": "customer/create",
  "trace_id": "3a8ad82b-b9e2-42f3-9246-63b1dc062d53",
  "ts": "1741155824798000000"
}

customer/membership_tier_update

Topic Name:

customer/membership_tier_update

Description:

當顧客會員升級時

Required Scopes in DC App Scope page:

Customers - index, or;
Customers - show, or;
Customers - all;

Payload Example:

{
  "event": "Customer",
  "merchant_id": "657fe76b11d72b1c22fb4aaf",
  "resource": {
    "_id": "657feb68a7cb17eff1a7ce36",
    "birth_day": null,
    "birth_month": null,
    "birth_year": null,
    "birthday": null,
    "confirmed_at": null,
    "created_at": "2023-12-18T06:49:27.385Z",
    "created_by": "shop",
    "credit_balance": 5,
    "current_sign_in_at": "2024-02-01T08:41:45.959Z",
    "custom_data": [],
    "customer_authentication_linkings": [],
    "delivery_addresses": [
      {
        "address_1": "test address",
        "address_2": "Wong Tai Sin",
        "city": "Kowloon",
        "country": "HK",
        "district": "San Po Kong",
        "key": null,
        "layer1": null,
        "layer2": null,
        "layer3": null,
        "logistic_codes": [
          "2200002",
          "2200016",
          "2200074"
        ],
        "postcode": null,
        "recipient_name": "TestingUser",
        "recipient_phone": "93533001",
        "recipient_phone_country_code": "852",
        "state": null
      }
    ],
    "email": "[email protected]",
    "email_verified": true,
    "facebook_id": null,
    "gender": null,
    "id": "657feb68a7cb17eff1a7ce36",
    "info_reward_claimed": false,
    "is_blacklisted": false,
    "is_member": true,
    "is_subscribed_marketing_email": false,
    "last_sign_in_at": "2024-02-01T08:41:13.102Z",
    "line_id": null,
    "locale_code": "en",
    "member_point_balance": 10,
    "membership_tier": {
      "id": "657ff01e0abede003ade8873",
      "level": 1,
      "name_translations": {
        "zh-hant": "test member tier"
      },
      "status": "active"
    },
    "memo": null,
    "mobile_phone": null,
    "mobile_phone_country_calling_code": null,
    "mobile_phone_verified": false,
    "name": "TestingUser",
    "offline_referral_agent_id": null,
    "offline_referral_channel_id": null,
    "offline_referral_registered_at": null,
    "order_count": 2,
    "orders_total_sum": {
      "cents": 7000,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 70,
      "label": "HK$70.00"
    },
    "phone": null,
    "phone_country_code": null,
    "phones": [],
    "ref_user_id": null,
    "referral_code": "u38HY",
    "registered_at": "2023-12-18T06:49:27.340+00:00",
    "subscribed_email_types": [],
    "subscriptions": [
      {
        "is_active": false,
        "platform": "sms"
      },
      {
        "is_active": false,
        "platform": "email"
      }
    ],
    "tags": [
      "test_c_tag"
    ],
    "tier_expires_at": null,
    "unconfirmed_email": null,
    "updated_at": "2024-09-04T08:07:06.903Z",
    "utm_data": {}
  },
  "topic": "customer/membership_tier_update",
  "trace_id": "8ba6e0fc-c4ae-4590-8fe3-238f2e4b170a",
  "ts": "1741155824798000000"
}

customer/mobile_sign_in

Topic Name:

customer/mobile_sign_in

Description:

當有顧客使用手機號碼登入時

Required Scopes in DC App Scope page:

Customers - index, or;
Customers - show, or;
Customers - all;

Payload Example:

{
  "event": "Customer",
  "merchant_id": "657fe76b11d72b1c22fb4aaf",
  "resource": {
    "_id": "657feb68a7cb17eff1a7ce36",
    "birth_day": null,
    "birth_month": null,
    "birth_year": null,
    "birthday": null,
    "confirmed_at": null,
    "created_at": "2023-12-18T06:49:27.385Z",
    "created_by": "shop",
    "credit_balance": 5,
    "current_sign_in_at": "2024-02-01T08:41:45.959Z",
    "custom_data": [],
    "customer_authentication_linkings": [],
    "delivery_addresses": [
      {
        "address_1": "test address",
        "address_2": "Wong Tai Sin",
        "city": "Kowloon",
        "country": "HK",
        "district": "San Po Kong",
        "key": null,
        "layer1": null,
        "layer2": null,
        "layer3": null,
        "logistic_codes": [
          "2200002",
          "2200016",
          "2200074"
        ],
        "postcode": null,
        "recipient_name": "TestingUser",
        "recipient_phone": "93533001",
        "recipient_phone_country_code": "852",
        "state": null
      }
    ],
    "email": "[email protected]",
    "email_verified": true,
    "facebook_id": null,
    "gender": null,
    "id": "657feb68a7cb17eff1a7ce36",
    "info_reward_claimed": false,
    "is_blacklisted": false,
    "is_member": true,
    "is_subscribed_marketing_email": false,
    "last_sign_in_at": "2024-02-01T08:41:13.102Z",
    "line_id": null,
    "locale_code": "en",
    "member_point_balance": 10,
    "membership_tier": {
      "id": "657ff01e0abede003ade8873",
      "level": 1,
      "name_translations": {
        "zh-hant": "test member tier"
      },
      "status": "active"
    },
    "memo": null,
    "mobile_phone": null,
    "mobile_phone_country_calling_code": null,
    "mobile_phone_verified": false,
    "name": "TestingUser",
    "offline_referral_agent_id": null,
    "offline_referral_channel_id": null,
    "offline_referral_registered_at": null,
    "order_count": 2,
    "orders_total_sum": {
      "cents": 7000,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 70,
      "label": "HK$70.00"
    },
    "phone": null,
    "phone_country_code": null,
    "phones": [],
    "ref_user_id": null,
    "referral_code": "u38HY",
    "registered_at": "2023-12-18T06:49:27.340+00:00",
    "subscribed_email_types": [],
    "subscriptions": [
      {
        "is_active": false,
        "platform": "sms"
      },
      {
        "is_active": false,
        "platform": "email"
      }
    ],
    "tags": [
      "test_c_tag"
    ],
    "tier_expires_at": null,
    "unconfirmed_email": null,
    "updated_at": "2024-09-04T08:07:06.903Z",
    "utm_data": {}
  },
  "topic": "customer/mobile_sign_in",
  "trace_id": "f2e87e0f-ad70-4c77-a064-0051f61c97b1",
  "ts": "1741155824798000000"
}

customer/remove

Topic Name:

customer/remove

Description:

當顧客被刪除時

Required Scopes in DC App Scope page:

Customers - index, or;
Customers - show, or;
Customers - all;

Payload Example:

{
  "event": "Customer",
  "merchant_id": "657fe76b11d72b1c22fb4aaf",
  "resource": {
    "_id": "657feb68a7cb17eff1a7ce36",
    "birth_day": null,
    "birth_month": null,
    "birth_year": null,
    "birthday": null,
    "confirmed_at": null,
    "created_at": "2023-12-18T06:49:27.385Z",
    "created_by": "shop",
    "credit_balance": 5,
    "current_sign_in_at": "2024-02-01T08:41:45.959Z",
    "custom_data": [],
    "customer_authentication_linkings": [],
    "delivery_addresses": [
      {
        "address_1": "test address",
        "address_2": "Wong Tai Sin",
        "city": "Kowloon",
        "country": "HK",
        "district": "San Po Kong",
        "key": null,
        "layer1": null,
        "layer2": null,
        "layer3": null,
        "logistic_codes": [
          "2200002",
          "2200016",
          "2200074"
        ],
        "postcode": null,
        "recipient_name": "TestingUser",
        "recipient_phone": "93533001",
        "recipient_phone_country_code": "852",
        "state": null
      }
    ],
    "email": "[email protected]",
    "email_verified": true,
    "facebook_id": null,
    "gender": null,
    "id": "657feb68a7cb17eff1a7ce36",
    "info_reward_claimed": false,
    "is_blacklisted": false,
    "is_member": true,
    "is_subscribed_marketing_email": false,
    "last_sign_in_at": "2024-02-01T08:41:13.102Z",
    "line_id": null,
    "locale_code": "en",
    "member_point_balance": 10,
    "membership_tier": {
      "id": "657ff01e0abede003ade8873",
      "level": 1,
      "name_translations": {
        "zh-hant": "test member tier"
      },
      "status": "active"
    },
    "memo": null,
    "mobile_phone": null,
    "mobile_phone_country_calling_code": null,
    "mobile_phone_verified": false,
    "name": "TestingUser",
    "offline_referral_agent_id": null,
    "offline_referral_channel_id": null,
    "offline_referral_registered_at": null,
    "order_count": 2,
    "orders_total_sum": {
      "cents": 7000,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 70,
      "label": "HK$70.00"
    },
    "phone": null,
    "phone_country_code": null,
    "phones": [],
    "ref_user_id": null,
    "referral_code": "u38HY",
    "registered_at": "2023-12-18T06:49:27.340+00:00",
    "subscribed_email_types": [],
    "subscriptions": [
      {
        "is_active": false,
        "platform": "sms"
      },
      {
        "is_active": false,
        "platform": "email"
      }
    ],
    "tags": [
      "test_c_tag"
    ],
    "tier_expires_at": null,
    "unconfirmed_email": null,
    "updated_at": "2024-09-04T08:07:06.903Z",
    "utm_data": {}
  },
  "topic": "customer/remove",
  "trace_id": "a8eb5eb9-7652-4f34-9e31-64a2653febe5",
  "ts": "1741155824798000000"
}

customer/sign_in

Topic Name:

customer/sign_in

Description:

當有顧客登入時

Required Scopes in DC App Scope page:

Customers - index, or;
Customers - show, or;
Customers - all;

Payload Example:

{
  "event": "Customer",
  "merchant_id": "657fe76b11d72b1c22fb4aaf",
  "resource": {
    "_id": "657feb68a7cb17eff1a7ce36",
    "birth_day": null,
    "birth_month": null,
    "birth_year": null,
    "birthday": null,
    "confirmed_at": null,
    "created_at": "2023-12-18T06:49:27.385Z",
    "created_by": "shop",
    "credit_balance": 5,
    "current_sign_in_at": "2024-02-01T08:41:45.959Z",
    "custom_data": [],
    "customer_authentication_linkings": [],
    "delivery_addresses": [
      {
        "address_1": "test address",
        "address_2": "Wong Tai Sin",
        "city": "Kowloon",
        "country": "HK",
        "district": "San Po Kong",
        "key": null,
        "layer1": null,
        "layer2": null,
        "layer3": null,
        "logistic_codes": [
          "2200002",
          "2200016",
          "2200074"
        ],
        "postcode": null,
        "recipient_name": "TestingUser",
        "recipient_phone": "93533001",
        "recipient_phone_country_code": "852",
        "state": null
      }
    ],
    "email": "[email protected]",
    "email_verified": true,
    "facebook_id": null,
    "gender": null,
    "id": "657feb68a7cb17eff1a7ce36",
    "info_reward_claimed": false,
    "is_blacklisted": false,
    "is_member": true,
    "is_subscribed_marketing_email": false,
    "last_sign_in_at": "2024-02-01T08:41:13.102Z",
    "line_id": null,
    "locale_code": "en",
    "member_point_balance": 10,
    "membership_tier": {
      "id": "657ff01e0abede003ade8873",
      "level": 1,
      "name_translations": {
        "zh-hant": "test member tier"
      },
      "status": "active"
    },
    "memo": null,
    "mobile_phone": null,
    "mobile_phone_country_calling_code": null,
    "mobile_phone_verified": false,
    "name": "TestingUser",
    "offline_referral_agent_id": null,
    "offline_referral_channel_id": null,
    "offline_referral_registered_at": null,
    "order_count": 2,
    "orders_total_sum": {
      "cents": 7000,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 70,
      "label": "HK$70.00"
    },
    "phone": null,
    "phone_country_code": null,
    "phones": [],
    "ref_user_id": null,
    "referral_code": "u38HY",
    "registered_at": "2023-12-18T06:49:27.340+00:00",
    "subscribed_email_types": [],
    "subscriptions": [
      {
        "is_active": false,
        "platform": "sms"
      },
      {
        "is_active": false,
        "platform": "email"
      }
    ],
    "tags": [
      "test_c_tag"
    ],
    "tier_expires_at": null,
    "unconfirmed_email": null,
    "updated_at": "2024-09-04T08:07:06.903Z",
    "utm_data": {}
  },
  "topic": "customer/sign_in",
  "trace_id": "ef51447c-f773-41f1-8148-ca3f6ce5b184",
  "ts": "1741155824798000000"
}

customer/update

Topic Name:

customer/update

Description:

當顧客資料更新時觸發

Required Scopes in DC App Scope page:

Customers - index, or;
Customers - show, or;
Customers - all;

Payload Example:

{
  "event": "Customer",
  "merchant_id": "657fe76b11d72b1c22fb4aaf",
  "resource": {
    "_id": "657feb68a7cb17eff1a7ce36",
    "birth_day": null,
    "birth_month": null,
    "birth_year": null,
    "birthday": null,
    "confirmed_at": null,
    "created_at": "2023-12-18T06:49:27.385Z",
    "created_by": "shop",
    "credit_balance": 5,
    "current_sign_in_at": "2024-02-01T08:41:45.959Z",
    "custom_data": [],
    "customer_authentication_linkings": [],
    "delivery_addresses": [
      {
        "address_1": "test address",
        "address_2": "Wong Tai Sin",
        "city": "Kowloon",
        "country": "HK",
        "district": "San Po Kong",
        "key": null,
        "layer1": null,
        "layer2": null,
        "layer3": null,
        "logistic_codes": [
          "2200002",
          "2200016",
          "2200074"
        ],
        "postcode": null,
        "recipient_name": "TestingUser",
        "recipient_phone": "93533001",
        "recipient_phone_country_code": "852",
        "state": null
      }
    ],
    "email": "[email protected]",
    "email_verified": true,
    "facebook_id": null,
    "gender": null,
    "id": "657feb68a7cb17eff1a7ce36",
    "info_reward_claimed": false,
    "is_blacklisted": false,
    "is_member": true,
    "is_subscribed_marketing_email": false,
    "last_sign_in_at": "2024-02-01T08:41:13.102Z",
    "line_id": null,
    "locale_code": "en",
    "member_point_balance": 10,
    "membership_tier": {
      "id": "657ff01e0abede003ade8873",
      "level": 1,
      "name_translations": {
        "zh-hant": "test member tier"
      },
      "status": "active"
    },
    "memo": null,
    "mobile_phone": null,
    "mobile_phone_country_calling_code": null,
    "mobile_phone_verified": false,
    "name": "TestingUser",
    "offline_referral_agent_id": null,
    "offline_referral_channel_id": null,
    "offline_referral_registered_at": null,
    "order_count": 2,
    "orders_total_sum": {
      "cents": 7000,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 70,
      "label": "HK$70.00"
    },
    "phone": null,
    "phone_country_code": null,
    "phones": [],
    "ref_user_id": null,
    "referral_code": "u38HY",
    "registered_at": "2023-12-18T06:49:27.340+00:00",
    "subscribed_email_types": [],
    "subscriptions": [
      {
        "is_active": false,
        "platform": "sms"
      },
      {
        "is_active": false,
        "platform": "email"
      }
    ],
    "tags": [
      "test_c_tag"
    ],
    "tier_expires_at": null,
    "unconfirmed_email": null,
    "updated_at": "2024-09-04T08:07:06.903Z",
    "utm_data": {}
  },
  "topic": "customer/update",
  "trace_id": "5efe7925-11c2-486e-a893-f085771d0f94",
  "ts": "1741155824798000000"
}

Flash price campaign Related Event

flash_price_campaign/activate

Topic Name:

flash_price_campaign/activate

Required Scopes in DC App Scope page:

Flash Price Campaigns - index, or
Flash Price Campaigns - show;
Flash Price Campaigns - all;

Trigger Point:

商品限時促銷價创建，开启

flash_price_campaign/expire

Topic Name:

flash_price_campaign/expire

Required Scopes in DC App Scope page:

Flash Price Campaigns - index, or
Flash Price Campaigns - show;
Flash Price Campaigns - all;

Trigger Point:

到活动结束时间后，出发UpdateFlashPriceJob自动过期

flash_price_campaign/terminate

Topic Name:

flash_price_campaign/terminate

Required Scopes in DC App Scope page:

Flash Price Campaigns - index, or
Flash Price Campaigns - show;
Flash Price Campaigns - all;

Trigger Point:

商品限時促銷價更新活動结束时间，立即结束，删除

Invoice Related Event

invoice/create

Topic Name:

invoice/create

Description:

網店訂單發票或 POS 訂單發票（使用關貿或鯨躍開立發票），都會觸發此 webhook

Required Scopes in DC App Scope page:

Invoice - index, or
Invoice - show;
Invoice - all;

Member Point Related Event

member_point/create

Topic Name:

member_point/create

Description:

當會員點數建立時

Required Scopes in DC App Scope page:

Member Points - index, or
Member Points - show;
Member Points - all;

Trigger Point:

type 會員點數種類:
manual_credit: 手動增減點數
auto_reward: 點數回饋
expired: 點數過期
order_redeemed: 使用點數兌換贈品於訂單
redeemed_to_cash: 使用點數折現於訂單
order_split_revert: 回補點數（來自拆單）
product_review_reward: 商品評價獎賞
member_info_reward: 會員資料獎賞

Payload Example:

{
  "event": "MemberPoint",
  "merchant_id": "657fe76b11d72b1c22fb4aaf",
  "resource": {
    "_id": "657ffab54abe6c003b3ddd31",
    "customer_id": "657feb68a7cb17eff1a7ce36",
    "end_at": null,
    "id": "657ffab54abe6c003b3ddd31",
    "is_redeem": false,
    "order_id": null,
    "point_balance": 10,
    "remarks": "test member points",
    "type": "manual",
    "value": 10
  },
  "topic": "member_point/create",
  "trace_id": "ed585019-ac47-4f88-b71b-b4f48317e2d2",
  "ts": "1741155824798000000"
}

Merchant Related Event

merchant/update

Topic Name:

merchant/update

Description:

更新店家資訊

Required Scopes in DC App Scope page:

Merchants - index, or
Merchants - show;
Merchants - all;

Trigger Point:

更新商店基本資料

Payload Example:

{
  "event": "Merchant",
  "merchant_id": "657fe76b11d72b1c22fb4aaf",
  "resource": {
    "_id": "657fe76b11d72b1c22fb4aaf",
    "base_country_code": "HK",
    "base_currency_code": "HKD",
    "brand_home_url": "https://user20150306.sss.shoplinestg.com",
    "current_plan_key": "basket",
    "custom_domain": null,
    "default_language_code": "zh-hant",
    "email": "[email protected]",
    "emails": {
      "comment": "",
      "low_inventory": "",
      "message": "",
      "order": ""
    },
    "handle": "user20150306",
    "id": "657fe76b11d72b1c22fb4aaf",
    "kyc_status": "not_yet_applied",
    "logo_media": null,
    "name": "api測試",
    "phones": {
      "main": "13417950184"
    },
    "product_lines": {
      "paid": [
        {
          "end_at": "2026-12-18T07:06:02.000Z",
          "name": "ec",
          "payment_gateway": "unspecified",
          "start_at": "2023-12-18T07:06:02.000Z",
          "status": "active"
        },
        {
          "end_at": "2026-12-18T07:06:02.000Z",
          "name": "sc",
          "payment_gateway": "unspecified",
          "start_at": "2023-12-18T07:06:02.000Z",
          "status": "active"
        },
        {
          "end_at": "2026-12-18T07:06:02.000Z",
          "name": "pos",
          "payment_gateway": "unspecified",
          "start_at": "2023-12-18T07:06:02.000Z",
          "status": "active"
        }
      ],
      "preorder": [],
      "trial": []
    },
    "rollout_keys": [
      "0",
      "00-----",
      "000",
      "0000",
      "001",
      "0test4",
      "111",
      "1111",
      "123123123",
      "2324",
      "232423434343",
      "23243435345",
      "232435aaaaaaaaaa",
      "2343",
      "23434",
      "24234354ffgfg",
      "34234545",
      "342345454354",
      "34243534fdf",
      "343534453442323",
      "343543534",
      "34354354534",
      "34545",
      "3454546234232222222",
      "3545",
      "3_layer_category",
      "3_layer_navigation",
      "3_layer_variation",
      "544665674756756756765",
      "711_CB_13countries",
      "711_CB_pickup_TH",
      "711_c2b_report_v2",
      "711_cross_delivery",
      "AlexTest03",
      "MC_WA_Template_Management",
      "MC_manual_order",
      "StaffCanBeDeleted_V1",
      "UTM_export",
      "UTM_register",
      "aaaaaa",
      "abandoned_cart_notification",
      "add_test999",
      "add_to_cart_revamp",
      "addon_products_limit_10",
      "addon_products_limit_unlimited",
      "addon_quantity",
      "address_format_batch2",
      "address_format_jp",
      "address_format_my",
      "address_format_us",
      "address_format_vn",
      "admin_app_extension",
      "admin_custom_domain",
      "admin_image_service",
      "admin_manual_order",
      "admin_realtime",
      "admin_vietnam_dong",
      "admin_whitelist_ip",
      "adminapp_order_form",
      "adminapp_wa_contacts_list",
      "ads_system_new_tab",
      "adyen_my_sc",
      "affiliate_by_product",
      "affiliate_dashboard",
      "affiliate_kol_report_appstore",
      "alextest03",
      "amazon_product_review",
      "android_pos_round_adj",
      "app_categories_filtering",
      "app_subscription_prorated_billing",
      "apply_multi_order_discount",
      "apps_store",
      "apps_store_blog",
      "apps_store_fb_comment",
      "apps_store_wishlist",
      "appstore_free_trial",
      "assign_products_to_category",
      "auth_flow_revamp",
      "auto_credit",
      "auto_credit_notify",
      "auto_credit_percentage",
      "auto_credit_recurring",
      "auto_fill_info",
      "auto_reply_comment",
      "auto_reply_fb",
      "auto_save_sf_plus_address",
      "availability_buy_online_pickup_instore",
      "availability_preview_buy_online_pickup_instore",
      "back_in_stock_appstore",
      "back_in_stock_notify",
      "basket_comparising_link_CNY",
      "basket_comparising_link_HKD",
      "basket_comparising_link_MYR",
      "basket_comparising_link_THB",
      "basket_comparising_link_TWD",
      "basket_comparising_link_USD",
      "basket_comparising_link_VND",
      "basket_invoice_field",
      "basket_pricing_page_cny",
      "basket_pricing_page_hkd",
      "basket_pricing_page_myr",
      "basket_pricing_page_sgd",
      "basket_pricing_page_thb",
      "basket_pricing_page_twd",
      "basket_pricing_page_usd",
      "basket_pricing_page_vnd",
      "basket_subscription_coupon",
      "basket_subscription_email",
      "bianco_setting",
      "bidding_select_product",
      "bing_ads",
      "birthday_format_v2",
      "block_gtm_for_lighthouse",
      "blog",
      "blog_app",
      "blog_revamp_admin",
      "blog_revamp_doublewrite",
      "blog_revamp_singleread",
      "breadcrumb",
      "broadcast_addfilter",
      "broadcast_advanced_filters",
      "broadcast_analytics",
      "broadcast_center",
      "broadcast_clone",
      "broadcast_email_html",
      "broadcast_facebook_template",
      "broadcast_line_template",
      "broadcast_preset_sending",
      "broadcast_preset_time",
      "broadcast_to_unsubscribers_sms",
      "broadcast_unsubscribe_email",
      "bulk_action_customer",
      "bulk_action_product",
      "bulk_assign_point",
      "bulk_import_multi_lang",
      "bulk_payment_delivery_setting",
      "bulk_printing_labels_711C2C",
      "bulk_update_dynamic_fields",
      "bulk_update_new_fields",
      "bulk_update_tag",
      "bulk_update_tag_enhancement",
      "bundle_add_type",
      "bundle_group",
      "bundle_page",
      "bundle_pricing",
      "bundle_promotion_apply_enhancement",
      "bundle_stackable",
      "buy_at_amazon",
      "buy_button",
      "buy_now_button",
      "buyandget_promotion",
      "callback_service",
      "cancel_order_by_customer",
      "cancel_order_by_customer_v2",
      "cart_addon",
      "cart_addon_condition",
      "cart_addon_limit",
      "cart_uuid",
      "category_banner_multiple",
      "category_limit_unlimited",
      "category_sorting",
      "channel_amazon",
      "channel_customer_authentication",
      "channel_fb",
      "channel_integration",
      "channel_line",
      "charge_shipping_fee_by_product_qty",
      "charlie_test_0915_1",
      "charlie_test_0915_it",
      "chat_widget",
      "chat_widget_facebook",
      "chat_widget_ig",
      "chat_widget_line",
      "chat_widget_livechat",
      "chat_widget_whatsapp",
      "chatbot_card_carousel",
      "chatbot_card_template",
      "chatbot_image_widget",
      "chatbot_keywords_matching",
      "chatbot_product_carousel",
      "chatbot_quick_reply",
      "chatbot_save_draft",
      "chatbot_welcome_template",
      "checkout_membercheckbox_toggle",
      "checkout_setting",
      "clone_promotion",
      "cmgtest",
      "cn_pricing_page_2019",
      "combine_orders_app",
      "comment_list_export",
      "component_h1_tag",
      "connor_all_key",
      "connor_internal_testing",
      "connortest202312040430",
      "consolidated_billing",
      "contact_us_mobile",
      "cookie_consent",
      "country_code",
      "coupon_notification",
      "coupon_v2",
      "create_staff_revamp",
      "credit_campaign",
      "credit_condition_5_tier_ec",
      "credit_point_report",
      "credit_point_triggerpoint",
      "crm_email_custom",
      "crm_notify_preview",
      "crm_sms_custom",
      "crm_sms_notify",
      "cross_shop_tracker",
      "custom_css",
      "custom_notify",
      "custom_order_export",
      "customer_advanced_filter",
      "customer_coupon",
      "customer_custom_field_limit_5",
      "customer_data_secure",
      "customer_edit",
      "customer_export_v2",
      "customer_group",
      "customer_group_analysis",
      "customer_group_broadcast",
      "customer_group_filter_p2",
      "customer_group_filter_p3",
      "customer_group_regenerate",
      "customer_group_sendcoupon",
      "customer_group_smartrfm_filter",
      "customer_import_50000_failure_report",
      "customer_import_v2",
      "customer_import_v3",
      "customer_list",
      "customer_new_report",
      "customer_referral",
      "customer_referral_notify",
      "customer_search_match",
      "customer_tag",
      "dashboard_v2",
      "dashboard_v2_revamp",
      "date_picker_v2",
      "deep_search",
      "default_theme_ultrachic",
      "delivery_time",
      "delivery_time_with_quantity",
      "design_submenu",
      "dev_center_app_store",
      "dfff",
      "disable_footer_brand",
      "disable_old_upgrade_reminder",
      "display_sc_sharecounts",
      "domain_applicable",
      "doris_bien_setting",
      "dusk_setting",
      "dynamic_shipping_rate_refactor",
      "ec_order_unlimit",
      "ecpay_expirydate",
      "ecpay_payment_gateway",
      "einvoice_bulk_update",
      "einvoice_edit",
      "einvoice_newlogic",
      "einvoice_nointegration",
      "email_credit_expire_notify",
      "email_custom",
      "email_member_forget_password_notify",
      "email_member_register_notify",
      "email_order_notify",
      "email_verification",
      "enable_calculate_api_promotion_apply",
      "enable_calculate_api_promotion_filter",
      "enable_cart_api",
      "enable_cart_service",
      "enable_lazysizes_image_tag",
      "enable_new_css_bundle",
      "enable_promotion_usage_record",
      "enhanced_catalog_feed",
      "exclude_product",
      "exclude_product_v2",
      "execute_shipment_permission",
      "export_inventory_report_v2",
      "express_cart",
      "express_checkout_pages",
      "extend_reminder",
      "facebook_ads",
      "facebook_chat_plugin",
      "facebook_dia",
      "facebook_line_promotion_notify",
      "facebook_login",
      "facebook_messenger_subscription",
      "facebook_notify",
      "facebook_pixel_manager",
      "fastcheckout_add_on",
      "fb_1on1_chat",
      "fb_broadcast",
      "fb_broadcast_sc",
      "fb_broadcast_sc_p2",
      "fb_comment_app",
      "fb_domain_verification",
      "fb_entrance_optimization",
      "fb_feed_unlimit",
      "fb_menu",
      "fb_messenger_onetime_notification",
      "fb_multi_category_feed",
      "fb_notification_messages",
      "fb_offline_conversions_api",
      "fb_pixel_matching",
      "fb_pixel_v2",
      "fb_post_management",
      "fb_product_set",
      "fb_quick_signup_link",
      "fb_shop_now_button",
      "fb_ssapi",
      "fb_sub_button",
      "fb_welcome_msg",
      "fbe_oe",
      "fbe_shop",
      "fbe_v2",
      "fbe_v2_edit",
      "fbig_shop_disabled",
      "feature_alttag_phase1",
      "feature_alttag_phase2",
      "fill_phone_popup",
      "flash_price_campaign",
      "fm_order_receipt",
      "fmt_c2c_newlabel",
      "fmt_revision",
      "footer_brand",
      "footer_builder",
      "footer_builder_new",
      "form_builder",
      "form_builder_access",
      "form_builder_user_management",
      "form_builder_v2_elements",
      "form_builder_v2_receiver",
      "form_builder_v2_report",
      "fps_rolling_key",
      "get_coupon",
      "gift_promotion_condition",
      "gifts_limit_10",
      "gifts_limit_unlimited",
      "gmv_revamp",
      "godaddy",
      "google_ads_api",
      "google_ads_manager",
      "google_analytics_4",
      "google_analytics_manager",
      "google_content_api",
      "google_dynamic_remarketing_tag",
      "google_enhanced_conversions",
      "google_preorder_feed",
      "google_product_category_3rdlayer",
      "google_recaptcha",
      "google_remarketing_manager",
      "google_signup_login",
      "google_tag_manager",
      "gp_tw_sc",
      "h2_tag_phase1",
      "hct_logistics_bills_report",
      "hidden_product",
      "hidden_product_p2",
      "hide_theme_bianco_whitelist",
      "hide_theme_dusk_whitelist",
      "hide_theme_sangria_whitelist",
      "hk_pricing_page_2019",
      "hkd_pricing_page_disabled_2020",
      "ig_browser_notify",
      "ig_live",
      "ig_login_entrance",
      "ig_new_api",
      "image_gallery",
      "image_gallery_p2",
      "image_host_by_region",
      "image_limit_100000",
      "image_limit_30000",
      "image_widget_mobile",
      "inbox_manual_order",
      "inbox_send_cartlink",
      "increase_variation_limit",
      "instagram_create_post",
      "instagram_post_sales",
      "integrated_label_711",
      "integrated_sfexpress",
      "integration_one",
      "internal_test",
      "invalidate_cache6",
      "invalidate_cache_2",
      "inventory_change_reason",
      "inventory_search_v2",
      "jackson_onboarding_all",
      "jackson_onboarding_with_internal",
      "jasontest",
      "jeffrey_cheung_test_0821",
      "jeffrey_cheung_test_0821_02",
      "jeffrey_cheung_test_0821_04",
      "jeffrey_cheung_test_0822",
      "jeffrey_cheung_test_0822_02",
      "jeffrey_cheung_test_0822_03",
      "jeffrey_cheung_test_0831",
      "jeffrey_cheung_test_0912_01",
      "jeffrey_test_0915_4",
      "jeffrey_test_0918_01",
      "jeffrey_test_0922",
      "jeffrey_test_1011_01",
      "jeffrey_test_1011_02",
      "jeffrey_test_1012_01",
      "job_api_products_export",
      "job_api_user_export",
      "job_product_import",
      "jquery_v3",
      "kingroup10",
      "kingsman_v2_setting",
      "kinkey00",
      "kinkey13",
      "kinkey14",
      "kinkey15",
      "kinkey22",
      "kinkeymbsall",
      "kinkeynew04",
      "kinmbskey01",
      "kintestkey",
      "line_1on1_chat",
      "line_abandon_notification",
      "line_ads_tag",
      "line_broadcast",
      "line_in_chat_shopping",
      "line_login",
      "line_login_mobile",
      "line_shopping_new_fields",
      "line_signup",
      "live_ai_tag_comments",
      "live_announce_buyer",
      "live_bidding",
      "live_broadcast_v2",
      "live_bulk_checkoutlink",
      "live_bulk_edit",
      "live_comment_discount",
      "live_crosspost",
      "live_dashboard_product",
      "live_event_discount",
      "live_exclusive_price",
      "live_general_settings",
      "live_host_panel",
      "live_ig_product_recommend",
      "live_im_switch",
      "live_line_multidisplay",
      "live_luckydraw_enhancement",
      "live_messenger_broadcast",
      "live_multi_channel_livestream",
      "live_order_block",
      "live_product_recommend",
      "live_shopline_announcement",
      "live_shopline_mute_customer",
      "live_shoplive_beauty_filter",
      "live_shoplive_product_card",
      "live_shoplive_view",
      "live_shoplive_view_marquee",
      "live_show_storefront",
      "live_show_storefront_facebook",
      "live_show_storefront_shopline",
      "live_stream_settings",
      "lock_cart_sc_product",
      "logo_favicon",
      "luckydraw_products",
      "luckydraw_qualification",
      "manual_activation",
      "manual_order",
      "manual_order_7-11",
      "manual_order_ec_to_sc",
      "marketing_affiliate",
      "marketing_affiliate_p2",
      "mbs20542",
      "mbs_1782_feature_key",
      "mbs_automation",
      "mc-history-instant",
      "mc_assign_message",
      "mc_auto_bind_member",
      "mc_autoreply_cotent",
      "mc_autoreply_trigger",
      "mc_broadcast_v2",
      "mc_chatbot_template",
      "mc_edit_cart",
      "mc_history_instant",
      "mc_history_post",
      "mc_im",
      "mc_input_status",
      "mc_instant_notifications",
      "mc_invoicetitle_optional",
      "mc_keyword_autotagging",
      "mc_line_broadcast",
      "mc_line_broadcast_all_friends",
      "mc_line_cart",
      "mc_manage_blacklist",
      "mc_new_menu",
      "mc_reminder_unpaid",
      "mc_setting_message",
      "mc_setting_orderform",
      "mc_shop_message_refactor",
      "mc_smart_advice",
      "mc_sort_waitingtime_new",
      "mc_tw_invoice",
      "media_gcp_upload",
      "member_center_profile_revamp",
      "member_import_notify",
      "member_info_reward",
      "member_info_reward_subscription",
      "member_password_setup_notify",
      "member_points",
      "member_points_notify",
      "member_price",
      "membership_tier_notify",
      "membership_tiers",
      "memebr_center_point_credit_revamp",
      "menu_limit_100",
      "menu_limit_unlimited",
      "merchant_webhook_via_event_center",
      "message_center_v2",
      "message_center_v3",
      "message_revamp",
      "mo_remove_discount",
      "mobile_and_email_signup",
      "mobile_signup_p2",
      "modularize_address_format",
      "molpay_credit_card",
      "multi_lang",
      "multi_lang_fr",
      "multi_lang_id",
      "multi_lang_ja",
      "multi_lang_vi",
      "multicurrency",
      "my_pricing_page_2019",
      "myapp_reauth_alert",
      "myr_pricing_page_disabled_2020",
      "neal_testing_1",
      "neal_testing_2",
      "neal_testing_3",
      "neal_testing_4",
      "new_app_subscription",
      "new_layout_for_mobile_and_pc",
      "new_live_selling",
      "new_myplan",
      "new_onboarding_flow",
      "new_return_management",
      "new_settings_apply_all_promotion",
      "new_signup_flow",
      "new_sinopac_3d",
      "notification_custom_sending_time",
      "npb_theme_philia",
      "npb_widget_font_size_color",
      "ob_revamp",
      "ob_sgstripe",
      "ob_twecpay",
      "oceanpay",
      "old_fbe_removal",
      "onboarding_basketplan",
      "onboarding_handle",
      "one_new_filter",
      "one_page_store",
      "one_page_store_1000",
      "one_page_store_checkout",
      "oneship_installable",
      "online_credit_redemption_toggle",
      "online_store_design",
      "online_store_design_setup_guide_basketplan",
      "open_api_management",
      "order_add_to_cart",
      "order_archive_calculation_revamp_crm_member",
      "order_archive_testing",
      "order_archive_testing_crm",
      "order_archive_testing_order_details",
      "order_archive_testing_return_order",
      "order_confirmation_slip_upload",
      "order_custom_field_limit_5",
      "order_custom_notify",
      "order_discount_stackable",
      "order_export_v2",
      "order_filter_shipped_date",
      "order_new_source",
      "order_promotion_split",
      "order_search_custom_field",
      "order_search_sku",
      "order_sms_notify",
      "order_split",
      "order_status_non_automation",
      "order_status_tag_color",
      "order_tag",
      "orderemail_new_logic",
      "other_custom_notify",
      "out_of_stock_order",
      "page_builder_revamp",
      "page_builder_revamp_theme_setting",
      "page_builder_section_cache_enabled",
      "page_builder_widget_accordion",
      "page_builder_widget_blog",
      "page_builder_widget_category",
      "page_builder_widget_count_down",
      "page_builder_widget_countdown",
      "page_builder_widget_custom_liquid",
      "page_builder_widget_instagram",
      "page_builder_widget_product_text",
      "page_builder_widget_subscription",
      "page_builder_widget_video",
      "page_limit_unlimited",
      "page_view_cache",
      "pakpobox",
      "partial_free_shipping",
      "payme",
      "payment_condition",
      "payment_image",
      "payment_octopus",
      "payment_slip_notify",
      "paypal_cn",
      "paypal_upgrade",
      "pending_subscription",
      "philia_setting",
      "plp_label_wording",
      "plp_product_seourl",
      "plp_variation_selector",
      "plp_wishlist",
      "point_redeem_to_cash",
      "pos_force_upgrade_days_300",
      "pos_only_product_settings",
      "pos_retail_store_price",
      "pos_setup_guide_basketplan",
      "post_cancel_connect",
      "post_commerce_stack_comment",
      "post_fanpage_luckydraw",
      "post_fb_group",
      "post_general_setting",
      "post_lock_pd",
      "post_sales_dashboard",
      "postsale_auto_reply",
      "postsale_create_post",
      "postsale_ig_auto_reply",
      "postsales_connect_multiple_posts",
      "preset_publish",
      "product_available_time",
      "product_cost_permission",
      "product_feed_info",
      "product_index_v2",
      "product_info",
      "product_limit_1000",
      "product_limit_unlimited",
      "product_log_v2",
      "product_page_limit_10",
      "product_quantity_update",
      "product_revamp_doublewrite",
      "product_revamp_singleread",
      "product_review_import",
      "product_review_import_installable",
      "product_review_reward",
      "product_sale_report",
      "product_search",
      "product_set_revamp",
      "product_set_v2_enhancement",
      "product_summary",
      "promotion_blacklist",
      "promotion_filter_by_date",
      "promotion_first_purchase",
      "promotion_hour",
      "promotion_limit_10",
      "promotion_limit_100",
      "promotion_limit_unlimited",
      "promotion_minitem",
      "promotion_page",
      "promotion_page_reminder",
      "promotion_page_seo_button",
      "promotion_record_archive_test",
      "promotion_redemption_record",
      "promotion_reminder",
      "purchase_limit_campaign",
      "qa_testing",
      "quick_answer",
      "qweqwe",
      "ray_test_key",
      "recaptcha_reset_pw",
      "redirect_301_settings",
      "rejected_bill_reminder",
      "remove_fblike_sc",
      "repay_cookie",
      "replace_janus_interface",
      "replace_lms_old_oa_interface",
      "reports",
      "revert_credit",
      "revert_credit_p2",
      "revert_credit_status",
      "ronald_eat_junk_food",
      "sales_dashboard",
      "sangria_setting",
      "sc_advanced_keyword",
      "sc_ai_chat_analysis",
      "sc_ai_suggested_reply",
      "sc_autodetect_address",
      "sc_autodetect_paymentslip",
      "sc_autoreply_icebreaker",
      "sc_broadcast_permissions",
      "sc_comment_list",
      "sc_conversations_statistics_sunset",
      "sc_facebook_broadcast",
      "sc_facebook_live",
      "sc_fb_ig_subscription",
      "sc_gpt_chatsummary",
      "sc_gpt_content_generator",
      "sc_gpt_knowledge_base",
      "sc_hk_atome",
      "sc_intercom",
      "sc_keywords",
      "sc_lock_inventory",
      "sc_manual_order",
      "sc_mc_settings",
      "sc_order_unlimit",
      "sc_outstock_msg",
      "sc_overall_statistics",
      "sc_overall_statistics_api_v3",
      "sc_overall_statistics_v2",
      "sc_post_feature",
      "sc_product_set",
      "sc_sidebar",
      "sc_similar_question_replies",
      "sc_standard",
      "sc_store_pickup",
      "sc_wa_permissions",
      "scheduled_home_page",
      "search_function_image_gallery",
      "select_all_customer",
      "select_all_inventory",
      "send_coupon_notification",
      "setup_guide_basketplan",
      "sfexpress_centre",
      "sfexpress_eflocker",
      "sfexpress_service",
      "sfexpress_store",
      "sg_onboarding_currency",
      "share_cart_link",
      "shop_builder_plp",
      "shop_category_filter",
      "shop_category_filter_bulk_action",
      "shop_product_search_rate_limit",
      "shop_related_recaptcha",
      "shop_template_advanced_setting",
      "shopline_product_reviews",
      "shoplytics_behavior",
      "shoplytics_broadcast_api_v3",
      "shoplytics_channel_store_permission",
      "shoplytics_customer_refactor_api_v3",
      "shoplytics_date_picker_v2",
      "shoplytics_event_realtime_refactor_api_v3",
      "shoplytics_events_api_v3",
      "shoplytics_group_by",
      "shoplytics_invoices_api_v3",
      "shoplytics_lite",
      "shoplytics_membership_tier_growth",
      "shoplytics_o2o",
      "shoplytics_order_status",
      "shoplytics_orders_api_v3",
      "shoplytics_ordersales_v3",
      "shoplytics_overview",
      "shoplytics_overview_revision",
      "shoplytics_payment_method",
      "shoplytics_payments_api_v3",
      "shoplytics_preorder_metrics",
      "shoplytics_pro",
      "shoplytics_product_repurchase",
      "shoplytics_product_revamp_api_v3",
      "shoplytics_promotion_omni",
      "shoplytics_promotions_api_v3",
      "shoplytics_psa_supplier_list",
      "shoplytics_report_export",
      "shoplytics_sales_page",
      "shoplytics_sales_summary",
      "shoplytics_segment_analysis",
      "shoplytics_segment_analysis_uiux",
      "shoplytics_session_metrics",
      "shoplytics_staff_api_v3",
      "shoplytics_to_hd",
      "shopper_app_entrance",
      "shopping_session_enabled",
      "signin_register_revamp",
      "simon_group_key",
      "simon_ho_sick_play",
      "simon_simon",
      "simon_test_0918_all",
      "simon_test_0918_si",
      "singup_method",
      "skya_setting",
      "sl_admin_inventory_count",
      "sl_admin_inventory_transfer",
      "sl_admin_purchase_order",
      "sl_admin_supplier",
      "sl_logistics_bulk_action",
      "sl_logistics_fmt_freeze",
      "sl_logistics_modularize",
      "sl_payment_alipay",
      "sl_payment_cc",
      "sl_payment_standard_v2",
      "sl_payment_type_check",
      "sl_payments_apple_pay",
      "sl_payments_cb_cc",
      "sl_payments_cc_promo",
      "sl_payments_my_cc",
      "sl_payments_my_fpx",
      "sl_payments_sg_cc",
      "sl_payments_tw_cc",
      "sl_pos",
      "sl_pos_SHOPLINE_Payments",
      "sl_pos_admin",
      "sl_pos_admin_cancel_order",
      "sl_pos_admin_delete_order",
      "sl_pos_admin_inventory_count",
      "sl_pos_admin_inventory_transfer",
      "sl_pos_admin_order_archive_testing",
      "sl_pos_admin_purchase_order",
      "sl_pos_admin_register_shift",
      "sl_pos_admin_staff",
      "sl_pos_agent_performance",
      "sl_pos_android_receipt_info_enhancement",
      "sl_pos_app_order_archive_testing",
      "sl_pos_apps_store",
      "sl_pos_bulk_import_purchase_order",
      "sl_pos_bulk_import_update_enhancement",
      "sl_pos_claim_coupon",
      "sl_pos_credit_redeem",
      "sl_pos_customized_price",
      "sl_pos_disable_touchid_unlock",
      "sl_pos_discount",
      "sl_pos_einvoice_refactor",
      "sl_pos_force_upgrade_1-22-1",
      "sl_pos_frame_rate_tracking",
      "sl_pos_free_gifts_promotion",
      "sl_pos_from_Swift_to_OC",
      "sl_pos_iOS_A4_printer",
      "sl_pos_iOS_cashier_revamp_product_list",
      "sl_pos_initiate_couchbase",
      "sl_pos_inventory_count",
      "sl_pos_inventory_count_for_selected_products",
      "sl_pos_invoice_product_name_filter",
      "sl_pos_ios_receipt_info_enhancement",
      "sl_pos_itc",
      "sl_pos_logo_terms_and_condition",
      "sl_pos_member_points",
      "sl_pos_member_price",
      "sl_pos_multiple_payments",
      "sl_pos_new_report_customer_analysis",
      "sl_pos_new_report_overview",
      "sl_pos_new_report_product_preorder",
      "sl_pos_new_report_transaction_detail",
      "sl_pos_no_minimum_age",
      "sl_pos_order_reduction",
      "sl_pos_order_refactor_admin",
      "sl_pos_partial_return",
      "sl_pos_password_setting_refactor",
      "sl_pos_payment",
      "sl_pos_payoff_preorder",
      "sl_pos_pin_products",
      "sl_pos_product_add_to_cart_refactor",
      "sl_pos_product_set",
      "sl_pos_promotion",
      "sl_pos_purchase_order_onlinestore",
      "sl_pos_receipt_enhancement",
      "sl_pos_receipt_preorder_return_enhancement",
      "sl_pos_receipt_swiftUI_revamp",
      "sl_pos_report_shoplytics_psi",
      "sl_pos_revert_credit",
      "sl_pos_round_adj",
      "sl_pos_save_send_receipt",
      "sl_pos_show_coupon",
      "sl_pos_stock_refactor",
      "sl_pos_supplier_refactor",
      "sl_pos_terminal",
      "sl_pos_terminal_settlement",
      "sl_pos_transaction_conflict",
      "sl_pos_transaction_view_admin",
      "sl_pos_transfer_onlinestore",
      "sl_pos_user_permission",
      "sl_pos_variation_setting_refactor",
      "sl_product_review",
      "slp_remember_credit_card",
      "slp_swap",
      "smart_omo_appstore",
      "smart_omo_credits",
      "smart_omo_customer_tag_note",
      "smart_omo_express_cart",
      "smart_omo_points",
      "smart_omo_redeem_coupon",
      "smart_omo_send_coupon",
      "smart_omo_show_coupon",
      "smart_recommended_related_products",
      "sms_broadcast",
      "sms_custom",
      "social_channel_revamp",
      "social_channel_user",
      "social_name_in_order",
      "split_order_applied_creditpoint",
      "sso_lang_th",
      "sso_lang_vi",
      "staff_elasticsearch",
      "staff_limit_5",
      "staff_limit_unlimited",
      "staff_service_migration",
      "static_resource_host_by_region",
      "stop_slp_approvedemail",
      "store_pick_up",
      "store_referral_export_import",
      "store_referral_setting",
      "storefront_app_extension",
      "storefront_return",
      "stripe_3d_secure",
      "stripe_3ds_cny",
      "stripe_3ds_hkd",
      "stripe_3ds_myr",
      "stripe_3ds_sgd",
      "stripe_3ds_thb",
      "stripe_3ds_usd",
      "stripe_3ds_vnd",
      "stripe_google_pay",
      "stripe_old_ec_3ds_hkd",
      "stripe_old_ec_3ds_myr",
      "stripe_payment_intents",
      "stripe_radar",
      "stripe_subscription_my_account",
      "structured_data",
      "studio_livestream",
      "sub_sgstripe",
      "subscription_config_edit",
      "subscription_config_edit_delivery_payment",
      "subscription_currency",
      "subscription_product",
      "subscription_promotion",
      "tappay_3D_secure",
      "tappay_sdk_v2_3_2",
      "tappay_sdk_v3",
      "tax_inclusive_setting",
      "taxes_settings",
      "tcat_711pickup_emap",
      "tcat_logistics_bills_report",
      "tcat_newlabel",
      "test",
      "test_223",
      "test_change_email",
      "test_chung_onboarding_all",
      "test_chung_onboarding_internal",
      "test_dc1512_1",
      "test_dc1512_2",
      "test_dc2011",
      "test_dc2011_1",
      "test_dc2011_2",
      "test_dc2011_4",
      "test_dc2011_5",
      "test_dc2282",
      "test_dc2282_1",
      "test_duxing",
      "test_duxing2",
      "test_duxing3",
      "test_duxing4",
      "test_feature_limits_changes_2",
      "test_lwc",
      "test_mg_10",
      "test_mg_13",
      "test_mg_14",
      "test_mg_15",
      "test_mg_16",
      "test_mg_17",
      "test_mg_19",
      "test_mg_2",
      "test_mg_20",
      "test_mg_24",
      "test_mg_26",
      "test_mg_27",
      "test_mg_29",
      "test_mg_3",
      "test_mg_30",
      "test_mg_31",
      "test_mg_4",
      "test_mg_7",
      "test_mg_8",
      "test_mg_9",
      "test_multi_group",
      "test_pr_group",
      "test_shopper",
      "test_william_onboarding_all",
      "test_william_onboarding_specific_user",
      "test_yanyuanzhan",
      "testing_all",
      "testing_all-1",
      "testing_internal_cool",
      "testing_spce_user",
      "testlog",
      "testlog2",
      "testlog3",
      "testlog4",
      "testlog5",
      "testlog7",
      "testrotae",
      "th_pricing_page_2020",
      "thb_pricing_page_disabled_2020",
      "theme_bianco",
      "theme_doris_bien",
      "theme_dusk",
      "theme_kingsman_v2",
      "theme_level_3",
      "theme_philia",
      "theme_sangria",
      "theme_skya",
      "theme_ultrachic",
      "theme_varm",
      "thomas_do_nothing",
      "tier_birthday_credit",
      "tier_member_points",
      "tier_member_price",
      "tier_reward_app_availability",
      "tier_reward_app_p2",
      "tier_reward_credit",
      "tiktok_catalog_api",
      "tiktok_for_business",
      "tiktok_pixel_api",
      "tnc-checkbox",
      "to_all_test",
      "toggle_mobile_category",
      "trial_limit_whitelist",
      "tset1111",
      "tset111122",
      "tw_app_shopback_cashback",
      "tw_fm_sms",
      "tw_pricing_page_2019",
      "tw_sc_banner",
      "tw_stripe_subscription",
      "twd_pricing_page_disabled_2020",
      "uc_integration",
      "uc_v2_endpoints",
      "ultra_setting",
      "unified_admin",
      "use_ngram_for_order_search",
      "user_credits",
      "variant_image_selector",
      "variant_saleprice_cost_weight",
      "variation_label_swatches",
      "varm_setting",
      "vn_pricing_page_2020",
      "vnd_pricing_page_disabled_2020",
      "vvvvvvv",
      "wa_broadcast_customer_group",
      "wa_system_template",
      "wa_template_custom_content",
      "wale_to_all",
      "whatsapp_accept_marketing",
      "whatsapp_catalog",
      "whatsapp_extension",
      "why_no_event_ar",
      "william_feature_key_test",
      "william_feature_key_test23",
      "william_feature_key_test231",
      "william_feature_key_test_001",
      "william_feature_key_test_002",
      "william_feature_key_test_004",
      "william_testing_Feature_key",
      "wishlist_app",
      "xero_viewable",
      "yahoo_dot",
      "youtube_live_shopping",
      "yuklam_newnew",
      "yyyyyyyyyyywew",
      "z_cooper_pilot_test_3",
      "zapbook_installable",
      "zotabox_installable"
    ],
    "sl_payment_billing_descriptor_name": null,
    "sl_payment_mcc": null,
    "sl_payment_merchant_id": null,
    "staff_id": "657fe76b89905b002615b9d0",
    "supported_languages": [
      "en",
      "zh-hant"
    ],
    "tags": [
      "life"
    ],
    "whitelisted_ip_addresses": []
  },
  "topic": "merchant/update",
  "trace_id": "fd45c83a-a4eb-45b3-b221-619b5af5e946",
  "ts": "1741155824798000000"
}

Metafield Definitions Related Event

metafield_definitions/create

Topic Name:

metafield_definitions/create

Required Scopes in DC App Scope page:

Metafield Definitions - index, or;
Metafield Definitions - show, or;
Metafield Definitions - all;

Trigger Point:

Setting > Metafield Definitions

Payload Example:

{
  "event": "MetafieldDefinitions",
  "merchant_id": "6780d87211a9230008048d60",
  "resource": {
    "created_at": "2025-03-05T06:16:39.680+00:00",
    "description": "This's Size Guild",
    "field_type": "single_line_text_field",
    "id": "67c7ec477bf8c65836b0c190",
    "key": "sizeguildId01",
    "merchant_id": "6780d87211a9230008048d60",
    "metafield_type": "merchant",
    "name": "Size Guild",
    "namespace": "SizeGuild",
    "resource_type": "product",
    "updated_at": "2025-03-05T06:16:39.680+00:00"
  },
  "topic": "metafield_definitions/create",
  "trace_id": "1b560ed3-3b1a-4405-a961-e6242fbab1a8",
  "ts": "1741155399769412601"
}

metafield_definitions/remove

Topic Name:

metafield_definitions/remove

Required Scopes in DC App Scope page:

Metafield Definitions - index, or;
Metafield Definitions - show, or;
Metafield Definitions - all;

Trigger Point:

目前UI上沒有remove，需要call OPENAPI Trigger
i.e. <service_name>: 1. cart_items 2. order_items, 3. merchants 4. customers, orders, products
curl -X 'DELETE' \
'https://open.shopline.io/v1/metafield_definitions/<service_name>/61adbe72eb94028210b63aab1' \
-H 'accept: application/json'

Payload Example:

{
  "event": "MetafieldDefinitions",
  "merchant_id": "6780d87211a9230008048d60",
  "resource": {
    "id": "67c7db4a7bf8c65836af8368"
  },
  "topic": "metafield_definitions/remove",
  "trace_id": "c90b2760-6b4b-48cd-a7bc-55b6acb75022",
  "ts": "1741258423089646838"
}

Metafields Related Event

metafields/create

Topic Name:

metafields/create

Required Scopes in DC App Scope page:

Metafields - index, or;
Metafields - show, or;
Metafields - all;

Trigger Point:

Products & Categories > Products > Edit

Payload Example:

{
  "application_id": "678f4a22faaebc8f69be46f8",
  "event": "AppMetafields",
  "merchant_id": "6780d87211a9230008048d60",
  "resource": {
    "application_id": "678f4a22faaebc8f69be46f8",
    "created_at": "2025-03-05T04:53:57.570+00:00",
    "field_type": "single_line_text_field",
    "field_value": "text-size-guild",
    "id": "67c7d8e57bf8c65836af561d",
    "key": "sizeguild",
    "merchant_id": "6780d87211a9230008048d60",
    "metafield_type": "app",
    "namespace": "678f4a22faaebc8f69be46f8",
    "resource_id": "67a3715d68ad6f003bba73d7",
    "resource_type": "product",
    "updated_at": "2025-03-05T04:53:57.570+00:00"
  },
  "topic": "app_metafields/create",
  "trace_id": "3a44dde2-0270-4d6d-bade-b37f1bae4695",
  "ts": "1741150437668948939"
}

metafields/remove

Topic Name:

metafields/remove

Required Scopes in DC App Scope page:

Metafields - index, or;
Metafields - show, or;
Metafields - all;

Trigger Point:

目前UI上沒有remove，需要call OPENAPI Trigger
例子在swagger xxx/app_metafields/{metafield_id} 和和xxx/app_metafields/bulk

Payload Example:

{
  "application_id": "678f4a22faaebc8f69be46f8",
  "event": "AppMetafields",
  "merchant_id": "6780d87211a9230008048d60",
  "resource": {
    "id": "67c7da4d7bf8c65836af70a1"
  },
  "topic": "app_metafields/remove",
  "trace_id": "5cd21e0e-d2ad-4ce8-9958-e566446b5f2e",
  "ts": "1741258529442410539"
}

metafields/update

Topic Name:

metafields/update

Required Scopes in DC App Scope page:

Metafields - index, or;
Metafields - show, or;
Metafields - all;

Trigger Point:

Products & Categories > Products > Edit

Payload Example:

{
  "application_id": "678f4a22faaebc8f69be46f8",
  "event": "AppMetafields",
  "merchant_id": "6780d87211a9230008048d60",
  "resource": {
    "application_id": "678f4a22faaebc8f69be46f8",
    "created_at": "2025-03-05T04:53:57.570+00:00",
    "field_type": "single_line_text_field",
    "field_value": "text-size-guild-updated",
    "id": "67c7d8e57bf8c65836af561d",
    "key": "sizeguild",
    "merchant_id": "6780d87211a9230008048d60",
    "metafield_type": "app",
    "namespace": "678f4a22faaebc8f69be46f8",
    "resource_id": "67a3715d68ad6f003bba73d7",
    "resource_type": "product",
    "updated_at": "2025-03-05T04:54:36.665+00:00"
  },
  "topic": "app_metafields/update",
  "trace_id": "31931a79-7525-47a4-868a-c354e908c6fe",
  "ts": "1741150476712731105"
}

Order Related Event

order/cancel

Topic Name:

order/cancel

Description:

當訂單被取消時

Required Scopes in DC App Scope page:

Orders - index, or;
Orders - show, or;
Orders - all;

Payload Example:

{
  "event": "Order",
  "merchant_id": "657fe76b11d72b1c22fb4aaf",
  "resource": {
    "_id": "657fec07ec33fa00628a3714",
    "affiliate_campaign": {},
    "affiliate_data": {},
    "applied_tax_info": {
      "delivery": {},
      "sales": {}
    },
    "cart_attributes": {
      "affiliate_data": {},
      "cart_id": "1055157",
      "shop_session_id": ""
    },
    "cart_page_id": null,
    "channel": {},
    "checkout_object_data": {
      "_id": "657fec07ec33fa00628a3712",
      "current_total": {
        "cents": 4000,
        "currency_iso": "HKD",
        "currency_symbol": "HK$",
        "dollars": 40,
        "label": "HK$40.00"
      },
      "number": "C20231218065151058",
      "order_ids": [
        "657fec07ec33fa00628a3714"
      ]
    },
    "child_order_ids": [],
    "confirmed_at": null,
    "created_at": "2023-12-18T06:51:51.641Z",
    "created_by": "shop",
    "created_from": "shop",
    "currency_iso": "HKD",
    "custom_data": [],
    "custom_discount_items": [],
    "customer_email": "[email protected]",
    "customer_id": "657feb68a7cb17eff1a7ce36",
    "customer_info": {},
    "customer_name": "TestingUser",
    "customer_phone": "93533001",
    "customer_phone_country_code": "852",
    "default_warehouse_id": null,
    "delivery_address": {
      "address_1": "test address",
      "address_2": "Wong Tai Sin",
      "city": "Kowloon",
      "country": "Hong Kong",
      "country_code": "HK",
      "district": "San Po Kong",
      "key": null,
      "layer1": null,
      "layer2": null,
      "layer3": null,
      "logistic_codes": [
        "2200002",
        "2200016",
        "2200074"
      ],
      "postcode": null,
      "recipient_name": "TestingUser",
      "recipient_phone": "93533001",
      "recipient_phone_country_code": "852",
      "remarks": null,
      "state": null
    },
    "delivery_data": {
      "hk_sfplus_home_region": null,
      "instore_pickup": false,
      "location_code": null,
      "location_name": null,
      "location_short_name": null,
      "name_translations": null,
      "scheduled_delivery_date": null,
      "store_address": null,
      "store_address_detail": {},
      "target_channel_id": null,
      "time_slot_key": "",
      "time_slot_translations": null,
      "tracking_number": "",
      "url": null
    },
    "edited_at": null,
    "ga_tracked": false,
    "id": "657fec07ec33fa00628a3714",
    "inclusive_tax_info": {},
    "invoice": {
      "buyer_name": "",
      "carrier_number": "",
      "carrier_type": "",
      "invoice_cancelled_at": null,
      "invoice_date": null,
      "invoice_number": "",
      "invoice_status": "",
      "invoice_tax_type": "",
      "invoice_type": "",
      "mailing_address": "",
      "n_p_o_b_a_n": "",
      "tax_id": ""
    },
    "invoices": [],
    "is_guest_checkout": false,
    "language_code": "en",
    "membership_tier_data": null,
    "merchant_order_number": null,
    "order_comments": [],
    "order_delivery": {
      "arrived_at": "2023-12-18T06:53:58.073+00:00",
      "collected_at": null,
      "delivery_option_id": "657fead80abede0037de88e0",
      "delivery_status": "pending",
      "delivery_type": "custom",
      "exp_type": null,
      "id": "657fec07ec33fa00628a371a",
      "name_translations": {
        "en": "",
        "zh-hant": "Custom"
      },
      "platform": "custom",
      "remark": null,
      "request_accepted_at": null,
      "request_authorized_at": null,
      "request_submitted_at": null,
      "requested_fmt_at": null,
      "require_expired_upload": false,
      "require_storeclosed_upload": false,
      "requires_customer_address": true,
      "return_order_id": null,
      "returned_at": null,
      "shipped_at": "2023-12-18T06:53:58.073+00:00",
      "status": "arrived",
      "store_closed_at": null,
      "storeclosed_upload_at": null,
      "total": {
        "cents": 2000,
        "currency_iso": "HKD",
        "currency_symbol": "HK$",
        "dollars": 20,
        "label": "HK$20.00"
      },
      "updated_at": "2023-12-18T06:53:58.074Z"
    },
    "order_discount": {
      "cents": 0,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 0,
      "label": ""
    },
    "order_notes": [],
    "order_number": "20231218065151059",
    "order_payment": {
      "created_at": "2023-12-18T06:51:51.793Z",
      "id": "657fec07ec33fa00628a3719",
      "last_four_digits": "",
      "name_translations": {
        "en": "Cash on Delivery",
        "zh-hant": "貨到付款"
      },
      "paid_at": null,
      "payment_data": {},
      "payment_fee": {
        "cents": 1000,
        "currency_iso": "HKD",
        "currency_symbol": "HK$",
        "dollars": 10,
        "label": "HK$10.00"
      },
      "payment_method_id": "657feab20abede003dde8822",
      "payment_type": "cash_on_delivery",
      "ref_payment_id": null,
      "status": "pending",
      "total": {
        "cents": 4000,
        "currency_iso": "HKD",
        "currency_symbol": "HK$",
        "dollars": 40,
        "label": "HK$40.00"
      },
      "updated_at": "2023-12-18T06:51:53.389Z"
    },
    "order_points": 0,
    "order_points_to_cash": {
      "cents": 0,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 0,
      "label": ""
    },
    "order_remarks": "",
    "order_source": {
      "id": "657fec08ec33fa00628a371b",
      "name": null,
      "source_id": null,
      "type": "storefront"
    },
    "parent_order_id": "",
    "payment_slips": [],
    "product_subscription_period": null,
    "promotion_items": [],
    "ref_customer_id": "",
    "ref_order_id": "",
    "return_from_order_id": null,
    "skip_fulfillment": false,
    "split_at": null,
    "status": "pending",
    "subtotal": {
      "cents": 1000,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 10,
      "label": "HK$10.00"
    },
    "subtotal_items": [
      {
        "cost": {
          "cents": 0,
          "currency_iso": "HKD",
          "currency_symbol": "HK$",
          "dollars": 0,
          "label": "HK$0.00"
        },
        "created_by": "admin",
        "discounted_price": null,
        "fields_translations": {},
        "id": "657fec07ec33fa00628a3716",
        "is_preorder": false,
        "item_data": {
          "cart_item_id": "1710065",
          "custom_discounted_amount": {
            "cents": 0,
            "currency_iso": "HKD",
            "currency_symbol": "HK$",
            "dollars": 0,
            "label": ""
          },
          "custom_discounted_amount_items": [],
          "order_promotion_items": {},
          "parent_item_ids": [],
          "promotion_id": null,
          "triggering_item_id": ""
        },
        "item_id": "657fea540abede0037de88da",
        "item_price": {
          "cents": 1000,
          "currency_iso": "HKD",
          "currency_symbol": "HK$",
          "dollars": 10,
          "label": "HK$10.00"
        },
        "item_type": "Product",
        "item_variation_id": "",
        "item_variation_key": "",
        "media": {
          "_id": "657fea3f0abede003dde8821",
          "alt_translations": {},
          "blurhash": "UVRysgRj%Mxut7ayofj[~qt7IURj%Mj[WBay",
          "images": {
            "favicon": {
              "height": 250,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
              "width": 800
            },
            "favicon_large": {
              "height": 250,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
              "width": 800
            },
            "favicon_small": {
              "height": 250,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
              "width": 800
            },
            "original": {
              "height": 250,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
              "width": 800
            },
            "source": {
              "height": 250,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
              "width": 800
            },
            "thumb": {
              "height": 250,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
              "width": 800
            },
            "transparent_large": {
              "height": 250,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
              "width": 800
            },
            "transparent_thumb": {
              "height": 250,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
              "width": 800
            },
            "transparent_xlarge": {
              "height": 250,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
              "width": 800
            }
          }
        },
        "object_data": {
          "adult": "no",
          "age_group": "all_ages",
          "barcode_type": "Code 128",
          "condition": "new",
          "gender": "unisex",
          "gtin": "10122190",
          "max_order_quantity": -1,
          "status": "active",
          "weight": 0
        },
        "order_discounted_price": null,
        "preorder_note_translations": {},
        "price": {
          "cents": 1000,
          "currency_iso": "HKD",
          "currency_symbol": "HK$",
          "dollars": 10,
          "label": "HK$10.00"
        },
        "price_sale": {
          "cents": 0,
          "currency_iso": "HKD",
          "currency_symbol": "HK$",
          "dollars": 0,
          "label": "HK$0.00"
        },
        "product_subscription_id": null,
        "quantity": 1,
        "ref_data": null,
        "sku": "",
        "title_translations": {
          "en": "Product"
        },
        "total": {
          "cents": 1000,
          "currency_iso": "HKD",
          "currency_symbol": "HK$",
          "dollars": 10,
          "label": "HK$10.00"
        }
      }
    ],
    "system_order_number": "20231218065151059",
    "tags": [],
    "total": {
      "cents": 4000,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 40,
      "label": "HK$40.00"
    },
    "total_tax_fee": {
      "cents": 0,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 0,
      "label": ""
    },
    "updated_at": "2023-12-18T06:53:58.174Z",
    "user_credit": {
      "cents": 0,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 0,
      "label": ""
    },
    "utm_data": {}
  },
  "topic": "order/cancel",
  "trace_id": "6a37aafe-8d93-4f80-b8ac-aa457dcb0384",
  "ts": "1741146106262000000"
}

order/complete

Topic Name:

order/complete

Description:

當訂單狀態變成「已完成」時

Required Scopes in DC App Scope page:

Orders - index, or;
Orders - show, or;
Orders - all;

Payload Example:

{
  "event": "Order",
  "merchant_id": "657fe76b11d72b1c22fb4aaf",
  "resource": {
    "_id": "657fec07ec33fa00628a3714",
    "affiliate_campaign": {},
    "affiliate_data": {},
    "applied_tax_info": {
      "delivery": {},
      "sales": {}
    },
    "cart_attributes": {
      "affiliate_data": {},
      "cart_id": "1055157",
      "shop_session_id": ""
    },
    "cart_page_id": null,
    "channel": {},
    "checkout_object_data": {
      "_id": "657fec07ec33fa00628a3712",
      "current_total": {
        "cents": 4000,
        "currency_iso": "HKD",
        "currency_symbol": "HK$",
        "dollars": 40,
        "label": "HK$40.00"
      },
      "number": "C20231218065151058",
      "order_ids": [
        "657fec07ec33fa00628a3714"
      ]
    },
    "child_order_ids": [],
    "confirmed_at": null,
    "created_at": "2023-12-18T06:51:51.641Z",
    "created_by": "shop",
    "created_from": "shop",
    "currency_iso": "HKD",
    "custom_data": [],
    "custom_discount_items": [],
    "customer_email": "[email protected]",
    "customer_id": "657feb68a7cb17eff1a7ce36",
    "customer_info": {},
    "customer_name": "TestingUser",
    "customer_phone": "93533001",
    "customer_phone_country_code": "852",
    "default_warehouse_id": null,
    "delivery_address": {
      "address_1": "test address",
      "address_2": "Wong Tai Sin",
      "city": "Kowloon",
      "country": "Hong Kong",
      "country_code": "HK",
      "district": "San Po Kong",
      "key": null,
      "layer1": null,
      "layer2": null,
      "layer3": null,
      "logistic_codes": [
        "2200002",
        "2200016",
        "2200074"
      ],
      "postcode": null,
      "recipient_name": "TestingUser",
      "recipient_phone": "93533001",
      "recipient_phone_country_code": "852",
      "remarks": null,
      "state": null
    },
    "delivery_data": {
      "hk_sfplus_home_region": null,
      "instore_pickup": false,
      "location_code": null,
      "location_name": null,
      "location_short_name": null,
      "name_translations": null,
      "scheduled_delivery_date": null,
      "store_address": null,
      "store_address_detail": {},
      "target_channel_id": null,
      "time_slot_key": "",
      "time_slot_translations": null,
      "tracking_number": "",
      "url": null
    },
    "edited_at": null,
    "ga_tracked": false,
    "id": "657fec07ec33fa00628a3714",
    "inclusive_tax_info": {},
    "invoice": {
      "buyer_name": "",
      "carrier_number": "",
      "carrier_type": "",
      "invoice_cancelled_at": null,
      "invoice_date": null,
      "invoice_number": "",
      "invoice_status": "",
      "invoice_tax_type": "",
      "invoice_type": "",
      "mailing_address": "",
      "n_p_o_b_a_n": "",
      "tax_id": ""
    },
    "invoices": [],
    "is_guest_checkout": false,
    "language_code": "en",
    "membership_tier_data": null,
    "merchant_order_number": null,
    "order_comments": [],
    "order_delivery": {
      "arrived_at": "2023-12-18T06:53:58.073+00:00",
      "collected_at": null,
      "delivery_option_id": "657fead80abede0037de88e0",
      "delivery_status": "pending",
      "delivery_type": "custom",
      "exp_type": null,
      "id": "657fec07ec33fa00628a371a",
      "name_translations": {
        "en": "",
        "zh-hant": "Custom"
      },
      "platform": "custom",
      "remark": null,
      "request_accepted_at": null,
      "request_authorized_at": null,
      "request_submitted_at": null,
      "requested_fmt_at": null,
      "require_expired_upload": false,
      "require_storeclosed_upload": false,
      "requires_customer_address": true,
      "return_order_id": null,
      "returned_at": null,
      "shipped_at": "2023-12-18T06:53:58.073+00:00",
      "status": "arrived",
      "store_closed_at": null,
      "storeclosed_upload_at": null,
      "total": {
        "cents": 2000,
        "currency_iso": "HKD",
        "currency_symbol": "HK$",
        "dollars": 20,
        "label": "HK$20.00"
      },
      "updated_at": "2023-12-18T06:53:58.074Z"
    },
    "order_discount": {
      "cents": 0,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 0,
      "label": ""
    },
    "order_notes": [],
    "order_number": "20231218065151059",
    "order_payment": {
      "created_at": "2023-12-18T06:51:51.793Z",
      "id": "657fec07ec33fa00628a3719",
      "last_four_digits": "",
      "name_translations": {
        "en": "Cash on Delivery",
        "zh-hant": "貨到付款"
      },
      "paid_at": null,
      "payment_data": {},
      "payment_fee": {
        "cents": 1000,
        "currency_iso": "HKD",
        "currency_symbol": "HK$",
        "dollars": 10,
        "label": "HK$10.00"
      },
      "payment_method_id": "657feab20abede003dde8822",
      "payment_type": "cash_on_delivery",
      "ref_payment_id": null,
      "status": "pending",
      "total": {
        "cents": 4000,
        "currency_iso": "HKD",
        "currency_symbol": "HK$",
        "dollars": 40,
        "label": "HK$40.00"
      },
      "updated_at": "2023-12-18T06:51:53.389Z"
    },
    "order_points": 0,
    "order_points_to_cash": {
      "cents": 0,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 0,
      "label": ""
    },
    "order_remarks": "",
    "order_source": {
      "id": "657fec08ec33fa00628a371b",
      "name": null,
      "source_id": null,
      "type": "storefront"
    },
    "parent_order_id": "",
    "payment_slips": [],
    "product_subscription_period": null,
    "promotion_items": [],
    "ref_customer_id": "",
    "ref_order_id": "",
    "return_from_order_id": null,
    "skip_fulfillment": false,
    "split_at": null,
    "status": "pending",
    "subtotal": {
      "cents": 1000,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 10,
      "label": "HK$10.00"
    },
    "subtotal_items": [
      {
        "cost": {
          "cents": 0,
          "currency_iso": "HKD",
          "currency_symbol": "HK$",
          "dollars": 0,
          "label": "HK$0.00"
        },
        "created_by": "admin",
        "discounted_price": null,
        "fields_translations": {},
        "id": "657fec07ec33fa00628a3716",
        "is_preorder": false,
        "item_data": {
          "cart_item_id": "1710065",
          "custom_discounted_amount": {
            "cents": 0,
            "currency_iso": "HKD",
            "currency_symbol": "HK$",
            "dollars": 0,
            "label": ""
          },
          "custom_discounted_amount_items": [],
          "order_promotion_items": {},
          "parent_item_ids": [],
          "promotion_id": null,
          "triggering_item_id": ""
        },
        "item_id": "657fea540abede0037de88da",
        "item_price": {
          "cents": 1000,
          "currency_iso": "HKD",
          "currency_symbol": "HK$",
          "dollars": 10,
          "label": "HK$10.00"
        },
        "item_type": "Product",
        "item_variation_id": "",
        "item_variation_key": "",
        "media": {
          "_id": "657fea3f0abede003dde8821",
          "alt_translations": {},
          "blurhash": "UVRysgRj%Mxut7ayofj[~qt7IURj%Mj[WBay",
          "images": {
            "favicon": {
              "height": 250,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
              "width": 800
            },
            "favicon_large": {
              "height": 250,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
              "width": 800
            },
            "favicon_small": {
              "height": 250,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
              "width": 800
            },
            "original": {
              "height": 250,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
              "width": 800
            },
            "source": {
              "height": 250,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
              "width": 800
            },
            "thumb": {
              "height": 250,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
              "width": 800
            },
            "transparent_large": {
              "height": 250,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
              "width": 800
            },
            "transparent_thumb": {
              "height": 250,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
              "width": 800
            },
            "transparent_xlarge": {
              "height": 250,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
              "width": 800
            }
          }
        },
        "object_data": {
          "adult": "no",
          "age_group": "all_ages",
          "barcode_type": "Code 128",
          "condition": "new",
          "gender": "unisex",
          "gtin": "10122190",
          "max_order_quantity": -1,
          "status": "active",
          "weight": 0
        },
        "order_discounted_price": null,
        "preorder_note_translations": {},
        "price": {
          "cents": 1000,
          "currency_iso": "HKD",
          "currency_symbol": "HK$",
          "dollars": 10,
          "label": "HK$10.00"
        },
        "price_sale": {
          "cents": 0,
          "currency_iso": "HKD",
          "currency_symbol": "HK$",
          "dollars": 0,
          "label": "HK$0.00"
        },
        "product_subscription_id": null,
        "quantity": 1,
        "ref_data": null,
        "sku": "",
        "title_translations": {
          "en": "Product"
        },
        "total": {
          "cents": 1000,
          "currency_iso": "HKD",
          "currency_symbol": "HK$",
          "dollars": 10,
          "label": "HK$10.00"
        }
      }
    ],
    "system_order_number": "20231218065151059",
    "tags": [],
    "total": {
      "cents": 4000,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 40,
      "label": "HK$40.00"
    },
    "total_tax_fee": {
      "cents": 0,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 0,
      "label": ""
    },
    "updated_at": "2023-12-18T06:53:58.174Z",
    "user_credit": {
      "cents": 0,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 0,
      "label": ""
    },
    "utm_data": {}
  },
  "topic": "order/complete",
  "trace_id": "d145d3ff-d230-4801-85ed-7b6a87e1c88f",
  "ts": "1741155824798000000"
}

order/confirm

Topic Name:

order/confirm

Description:

當訂單狀態變成「已確認」時

Required Scopes in DC App Scope page:

Orders - index, or;
Orders - show, or;
Orders - all;

Payload Example:

{
  "event": "Order",
  "merchant_id": "657fe76b11d72b1c22fb4aaf",
  "resource": {
    "_id": "657fec07ec33fa00628a3714",
    "affiliate_campaign": {},
    "affiliate_data": {},
    "applied_tax_info": {
      "delivery": {},
      "sales": {}
    },
    "cart_attributes": {
      "affiliate_data": {},
      "cart_id": "1055157",
      "shop_session_id": ""
    },
    "cart_page_id": null,
    "channel": {},
    "checkout_object_data": {
      "_id": "657fec07ec33fa00628a3712",
      "current_total": {
        "cents": 4000,
        "currency_iso": "HKD",
        "currency_symbol": "HK$",
        "dollars": 40,
        "label": "HK$40.00"
      },
      "number": "C20231218065151058",
      "order_ids": [
        "657fec07ec33fa00628a3714"
      ]
    },
    "child_order_ids": [],
    "confirmed_at": null,
    "created_at": "2023-12-18T06:51:51.641Z",
    "created_by": "shop",
    "created_from": "shop",
    "currency_iso": "HKD",
    "custom_data": [],
    "custom_discount_items": [],
    "customer_email": "[email protected]",
    "customer_id": "657feb68a7cb17eff1a7ce36",
    "customer_info": {},
    "customer_name": "TestingUser",
    "customer_phone": "93533001",
    "customer_phone_country_code": "852",
    "default_warehouse_id": null,
    "delivery_address": {
      "address_1": "test address",
      "address_2": "Wong Tai Sin",
      "city": "Kowloon",
      "country": "Hong Kong",
      "country_code": "HK",
      "district": "San Po Kong",
      "key": null,
      "layer1": null,
      "layer2": null,
      "layer3": null,
      "logistic_codes": [
        "2200002",
        "2200016",
        "2200074"
      ],
      "postcode": null,
      "recipient_name": "TestingUser",
      "recipient_phone": "93533001",
      "recipient_phone_country_code": "852",
      "remarks": null,
      "state": null
    },
    "delivery_data": {
      "hk_sfplus_home_region": null,
      "instore_pickup": false,
      "location_code": null,
      "location_name": null,
      "location_short_name": null,
      "name_translations": null,
      "scheduled_delivery_date": null,
      "store_address": null,
      "store_address_detail": {},
      "target_channel_id": null,
      "time_slot_key": "",
      "time_slot_translations": null,
      "tracking_number": "",
      "url": null
    },
    "edited_at": null,
    "ga_tracked": false,
    "id": "657fec07ec33fa00628a3714",
    "inclusive_tax_info": {},
    "invoice": {
      "buyer_name": "",
      "carrier_number": "",
      "carrier_type": "",
      "invoice_cancelled_at": null,
      "invoice_date": null,
      "invoice_number": "",
      "invoice_status": "",
      "invoice_tax_type": "",
      "invoice_type": "",
      "mailing_address": "",
      "n_p_o_b_a_n": "",
      "tax_id": ""
    },
    "invoices": [],
    "is_guest_checkout": false,
    "language_code": "en",
    "membership_tier_data": null,
    "merchant_order_number": null,
    "order_comments": [],
    "order_delivery": {
      "arrived_at": "2023-12-18T06:53:58.073+00:00",
      "collected_at": null,
      "delivery_option_id": "657fead80abede0037de88e0",
      "delivery_status": "pending",
      "delivery_type": "custom",
      "exp_type": null,
      "id": "657fec07ec33fa00628a371a",
      "name_translations": {
        "en": "",
        "zh-hant": "Custom"
      },
      "platform": "custom",
      "remark": null,
      "request_accepted_at": null,
      "request_authorized_at": null,
      "request_submitted_at": null,
      "requested_fmt_at": null,
      "require_expired_upload": false,
      "require_storeclosed_upload": false,
      "requires_customer_address": true,
      "return_order_id": null,
      "returned_at": null,
      "shipped_at": "2023-12-18T06:53:58.073+00:00",
      "status": "arrived",
      "store_closed_at": null,
      "storeclosed_upload_at": null,
      "total": {
        "cents": 2000,
        "currency_iso": "HKD",
        "currency_symbol": "HK$",
        "dollars": 20,
        "label": "HK$20.00"
      },
      "updated_at": "2023-12-18T06:53:58.074Z"
    },
    "order_discount": {
      "cents": 0,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 0,
      "label": ""
    },
    "order_notes": [],
    "order_number": "20231218065151059",
    "order_payment": {
      "created_at": "2023-12-18T06:51:51.793Z",
      "id": "657fec07ec33fa00628a3719",
      "last_four_digits": "",
      "name_translations": {
        "en": "Cash on Delivery",
        "zh-hant": "貨到付款"
      },
      "paid_at": null,
      "payment_data": {},
      "payment_fee": {
        "cents": 1000,
        "currency_iso": "HKD",
        "currency_symbol": "HK$",
        "dollars": 10,
        "label": "HK$10.00"
      },
      "payment_method_id": "657feab20abede003dde8822",
      "payment_type": "cash_on_delivery",
      "ref_payment_id": null,
      "status": "pending",
      "total": {
        "cents": 4000,
        "currency_iso": "HKD",
        "currency_symbol": "HK$",
        "dollars": 40,
        "label": "HK$40.00"
      },
      "updated_at": "2023-12-18T06:51:53.389Z"
    },
    "order_points": 0,
    "order_points_to_cash": {
      "cents": 0,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 0,
      "label": ""
    },
    "order_remarks": "",
    "order_source": {
      "id": "657fec08ec33fa00628a371b",
      "name": null,
      "source_id": null,
      "type": "storefront"
    },
    "parent_order_id": "",
    "payment_slips": [],
    "product_subscription_period": null,
    "promotion_items": [],
    "ref_customer_id": "",
    "ref_order_id": "",
    "return_from_order_id": null,
    "skip_fulfillment": false,
    "split_at": null,
    "status": "pending",
    "subtotal": {
      "cents": 1000,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 10,
      "label": "HK$10.00"
    },
    "subtotal_items": [
      {
        "cost": {
          "cents": 0,
          "currency_iso": "HKD",
          "currency_symbol": "HK$",
          "dollars": 0,
          "label": "HK$0.00"
        },
        "created_by": "admin",
        "discounted_price": null,
        "fields_translations": {},
        "id": "657fec07ec33fa00628a3716",
        "is_preorder": false,
        "item_data": {
          "cart_item_id": "1710065",
          "custom_discounted_amount": {
            "cents": 0,
            "currency_iso": "HKD",
            "currency_symbol": "HK$",
            "dollars": 0,
            "label": ""
          },
          "custom_discounted_amount_items": [],
          "order_promotion_items": {},
          "parent_item_ids": [],
          "promotion_id": null,
          "triggering_item_id": ""
        },
        "item_id": "657fea540abede0037de88da",
        "item_price": {
          "cents": 1000,
          "currency_iso": "HKD",
          "currency_symbol": "HK$",
          "dollars": 10,
          "label": "HK$10.00"
        },
        "item_type": "Product",
        "item_variation_id": "",
        "item_variation_key": "",
        "media": {
          "_id": "657fea3f0abede003dde8821",
          "alt_translations": {},
          "blurhash": "UVRysgRj%Mxut7ayofj[~qt7IURj%Mj[WBay",
          "images": {
            "favicon": {
              "height": 250,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
              "width": 800
            },
            "favicon_large": {
              "height": 250,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
              "width": 800
            },
            "favicon_small": {
              "height": 250,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
              "width": 800
            },
            "original": {
              "height": 250,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
              "width": 800
            },
            "source": {
              "height": 250,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
              "width": 800
            },
            "thumb": {
              "height": 250,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
              "width": 800
            },
            "transparent_large": {
              "height": 250,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
              "width": 800
            },
            "transparent_thumb": {
              "height": 250,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
              "width": 800
            },
            "transparent_xlarge": {
              "height": 250,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
              "width": 800
            }
          }
        },
        "object_data": {
          "adult": "no",
          "age_group": "all_ages",
          "barcode_type": "Code 128",
          "condition": "new",
          "gender": "unisex",
          "gtin": "10122190",
          "max_order_quantity": -1,
          "status": "active",
          "weight": 0
        },
        "order_discounted_price": null,
        "preorder_note_translations": {},
        "price": {
          "cents": 1000,
          "currency_iso": "HKD",
          "currency_symbol": "HK$",
          "dollars": 10,
          "label": "HK$10.00"
        },
        "price_sale": {
          "cents": 0,
          "currency_iso": "HKD",
          "currency_symbol": "HK$",
          "dollars": 0,
          "label": "HK$0.00"
        },
        "product_subscription_id": null,
        "quantity": 1,
        "ref_data": null,
        "sku": "",
        "title_translations": {
          "en": "Product"
        },
        "total": {
          "cents": 1000,
          "currency_iso": "HKD",
          "currency_symbol": "HK$",
          "dollars": 10,
          "label": "HK$10.00"
        }
      }
    ],
    "system_order_number": "20231218065151059",
    "tags": [],
    "total": {
      "cents": 4000,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 40,
      "label": "HK$40.00"
    },
    "total_tax_fee": {
      "cents": 0,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 0,
      "label": ""
    },
    "updated_at": "2023-12-18T06:53:58.174Z",
    "user_credit": {
      "cents": 0,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 0,
      "label": ""
    },
    "utm_data": {}
  },
  "topic": "order/confirm",
  "trace_id": "bba9ca8a-74cb-4eee-838f-b179613cf79a",
  "ts": "1741146106262000000"
}

order/create

Topic Name:

order/create

Description:

當有新訂單產生時 (包含 SHOPLINE POS 產生的訂單)

Required Scopes in DC App Scope page:

Orders - index, or;
Orders - show, or;
Orders - all;

Payload Example:

{
  "event": "Order",
  "merchant_id": "657fe76b11d72b1c22fb4aaf",
  "resource": {
    "_id": "657fec07ec33fa00628a3714",
    "affiliate_campaign": {},
    "affiliate_data": {},
    "applied_tax_info": {
      "delivery": {},
      "sales": {}
    },
    "cart_attributes": {
      "affiliate_data": {},
      "cart_id": "1055157",
      "shop_session_id": ""
    },
    "cart_page_id": null,
    "channel": {},
    "checkout_object_data": {
      "_id": "657fec07ec33fa00628a3712",
      "current_total": {
        "cents": 4000,
        "currency_iso": "HKD",
        "currency_symbol": "HK$",
        "dollars": 40,
        "label": "HK$40.00"
      },
      "number": "C20231218065151058",
      "order_ids": [
        "657fec07ec33fa00628a3714"
      ]
    },
    "child_order_ids": [],
    "confirmed_at": null,
    "created_at": "2023-12-18T06:51:51.641Z",
    "created_by": "shop",
    "created_from": "shop",
    "currency_iso": "HKD",
    "custom_data": [],
    "custom_discount_items": [],
    "customer_email": "[email protected]",
    "customer_id": "657feb68a7cb17eff1a7ce36",
    "customer_info": {},
    "customer_name": "TestingUser",
    "customer_phone": "93533001",
    "customer_phone_country_code": "852",
    "default_warehouse_id": null,
    "delivery_address": {
      "address_1": "test address",
      "address_2": "Wong Tai Sin",
      "city": "Kowloon",
      "country": "Hong Kong",
      "country_code": "HK",
      "district": "San Po Kong",
      "key": null,
      "layer1": null,
      "layer2": null,
      "layer3": null,
      "logistic_codes": [
        "2200002",
        "2200016",
        "2200074"
      ],
      "postcode": null,
      "recipient_name": "TestingUser",
      "recipient_phone": "93533001",
      "recipient_phone_country_code": "852",
      "remarks": null,
      "state": null
    },
    "delivery_data": {
      "hk_sfplus_home_region": null,
      "instore_pickup": false,
      "location_code": null,
      "location_name": null,
      "location_short_name": null,
      "name_translations": null,
      "scheduled_delivery_date": null,
      "store_address": null,
      "store_address_detail": {},
      "target_channel_id": null,
      "time_slot_key": "",
      "time_slot_translations": null,
      "tracking_number": "",
      "url": null
    },
    "edited_at": null,
    "ga_tracked": false,
    "id": "657fec07ec33fa00628a3714",
    "inclusive_tax_info": {},
    "invoice": {
      "buyer_name": "",
      "carrier_number": "",
      "carrier_type": "",
      "invoice_cancelled_at": null,
      "invoice_date": null,
      "invoice_number": "",
      "invoice_status": "",
      "invoice_tax_type": "",
      "invoice_type": "",
      "mailing_address": "",
      "n_p_o_b_a_n": "",
      "tax_id": ""
    },
    "invoices": [],
    "is_guest_checkout": false,
    "language_code": "en",
    "membership_tier_data": null,
    "merchant_order_number": null,
    "order_comments": [],
    "order_delivery": {
      "arrived_at": "2023-12-18T06:53:58.073+00:00",
      "collected_at": null,
      "delivery_option_id": "657fead80abede0037de88e0",
      "delivery_status": "pending",
      "delivery_type": "custom",
      "exp_type": null,
      "id": "657fec07ec33fa00628a371a",
      "name_translations": {
        "en": "",
        "zh-hant": "Custom"
      },
      "platform": "custom",
      "remark": null,
      "request_accepted_at": null,
      "request_authorized_at": null,
      "request_submitted_at": null,
      "requested_fmt_at": null,
      "require_expired_upload": false,
      "require_storeclosed_upload": false,
      "requires_customer_address": true,
      "return_order_id": null,
      "returned_at": null,
      "shipped_at": "2023-12-18T06:53:58.073+00:00",
      "status": "arrived",
      "store_closed_at": null,
      "storeclosed_upload_at": null,
      "total": {
        "cents": 2000,
        "currency_iso": "HKD",
        "currency_symbol": "HK$",
        "dollars": 20,
        "label": "HK$20.00"
      },
      "updated_at": "2023-12-18T06:53:58.074Z"
    },
    "order_discount": {
      "cents": 0,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 0,
      "label": ""
    },
    "order_notes": [],
    "order_number": "20231218065151059",
    "order_payment": {
      "created_at": "2023-12-18T06:51:51.793Z",
      "id": "657fec07ec33fa00628a3719",
      "last_four_digits": "",
      "name_translations": {
        "en": "Cash on Delivery",
        "zh-hant": "貨到付款"
      },
      "paid_at": null,
      "payment_data": {},
      "payment_fee": {
        "cents": 1000,
        "currency_iso": "HKD",
        "currency_symbol": "HK$",
        "dollars": 10,
        "label": "HK$10.00"
      },
      "payment_method_id": "657feab20abede003dde8822",
      "payment_type": "cash_on_delivery",
      "ref_payment_id": null,
      "status": "pending",
      "total": {
        "cents": 4000,
        "currency_iso": "HKD",
        "currency_symbol": "HK$",
        "dollars": 40,
        "label": "HK$40.00"
      },
      "updated_at": "2023-12-18T06:51:53.389Z"
    },
    "order_points": 0,
    "order_points_to_cash": {
      "cents": 0,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 0,
      "label": ""
    },
    "order_remarks": "",
    "order_source": {
      "id": "657fec08ec33fa00628a371b",
      "name": null,
      "source_id": null,
      "type": "storefront"
    },
    "parent_order_id": "",
    "payment_slips": [],
    "product_subscription_period": null,
    "promotion_items": [],
    "ref_customer_id": "",
    "ref_order_id": "",
    "return_from_order_id": null,
    "skip_fulfillment": false,
    "split_at": null,
    "status": "pending",
    "subtotal": {
      "cents": 1000,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 10,
      "label": "HK$10.00"
    },
    "subtotal_items": [
      {
        "cost": {
          "cents": 0,
          "currency_iso": "HKD",
          "currency_symbol": "HK$",
          "dollars": 0,
          "label": "HK$0.00"
        },
        "created_by": "admin",
        "discounted_price": null,
        "fields_translations": {},
        "id": "657fec07ec33fa00628a3716",
        "is_preorder": false,
        "item_data": {
          "cart_item_id": "1710065",
          "custom_discounted_amount": {
            "cents": 0,
            "currency_iso": "HKD",
            "currency_symbol": "HK$",
            "dollars": 0,
            "label": ""
          },
          "custom_discounted_amount_items": [],
          "order_promotion_items": {},
          "parent_item_ids": [],
          "promotion_id": null,
          "triggering_item_id": ""
        },
        "item_id": "657fea540abede0037de88da",
        "item_price": {
          "cents": 1000,
          "currency_iso": "HKD",
          "currency_symbol": "HK$",
          "dollars": 10,
          "label": "HK$10.00"
        },
        "item_type": "Product",
        "item_variation_id": "",
        "item_variation_key": "",
        "media": {
          "_id": "657fea3f0abede003dde8821",
          "alt_translations": {},
          "blurhash": "UVRysgRj%Mxut7ayofj[~qt7IURj%Mj[WBay",
          "images": {
            "favicon": {
              "height": 250,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
              "width": 800
            },
            "favicon_large": {
              "height": 250,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
              "width": 800
            },
            "favicon_small": {
              "height": 250,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
              "width": 800
            },
            "original": {
              "height": 250,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
              "width": 800
            },
            "source": {
              "height": 250,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
              "width": 800
            },
            "thumb": {
              "height": 250,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
              "width": 800
            },
            "transparent_large": {
              "height": 250,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
              "width": 800
            },
            "transparent_thumb": {
              "height": 250,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
              "width": 800
            },
            "transparent_xlarge": {
              "height": 250,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
              "width": 800
            }
          }
        },
        "object_data": {
          "adult": "no",
          "age_group": "all_ages",
          "barcode_type": "Code 128",
          "condition": "new",
          "gender": "unisex",
          "gtin": "10122190",
          "max_order_quantity": -1,
          "status": "active",
          "weight": 0
        },
        "order_discounted_price": null,
        "preorder_note_translations": {},
        "price": {
          "cents": 1000,
          "currency_iso": "HKD",
          "currency_symbol": "HK$",
          "dollars": 10,
          "label": "HK$10.00"
        },
        "price_sale": {
          "cents": 0,
          "currency_iso": "HKD",
          "currency_symbol": "HK$",
          "dollars": 0,
          "label": "HK$0.00"
        },
        "product_subscription_id": null,
        "quantity": 1,
        "ref_data": null,
        "sku": "",
        "title_translations": {
          "en": "Product"
        },
        "total": {
          "cents": 1000,
          "currency_iso": "HKD",
          "currency_symbol": "HK$",
          "dollars": 10,
          "label": "HK$10.00"
        }
      }
    ],
    "system_order_number": "20231218065151059",
    "tags": [],
    "total": {
      "cents": 4000,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 40,
      "label": "HK$40.00"
    },
    "total_tax_fee": {
      "cents": 0,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 0,
      "label": ""
    },
    "updated_at": "2023-12-18T06:53:58.174Z",
    "user_credit": {
      "cents": 0,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 0,
      "label": ""
    },
    "utm_data": {}
  },
  "topic": "order/create",
  "trace_id": "9fedfa77-1dcf-480c-b6e6-d9b5c814968a",
  "ts": "1741146106262000000"
}

order/pending

Topic Name:

order/pending

Description:

當訂單狀態變成「處理中」時

Required Scopes in DC App Scope page:

Orders - index, or;
Orders - show, or;
Orders - all;

Payload Example:

{
  "event": "Order",
  "merchant_id": "657fe76b11d72b1c22fb4aaf",
  "resource": {
    "_id": "657fec07ec33fa00628a3714",
    "affiliate_campaign": {},
    "affiliate_data": {},
    "applied_tax_info": {
      "delivery": {},
      "sales": {}
    },
    "cart_attributes": {
      "affiliate_data": {},
      "cart_id": "1055157",
      "shop_session_id": ""
    },
    "cart_page_id": null,
    "channel": {},
    "checkout_object_data": {
      "_id": "657fec07ec33fa00628a3712",
      "current_total": {
        "cents": 4000,
        "currency_iso": "HKD",
        "currency_symbol": "HK$",
        "dollars": 40,
        "label": "HK$40.00"
      },
      "number": "C20231218065151058",
      "order_ids": [
        "657fec07ec33fa00628a3714"
      ]
    },
    "child_order_ids": [],
    "confirmed_at": null,
    "created_at": "2023-12-18T06:51:51.641Z",
    "created_by": "shop",
    "created_from": "shop",
    "currency_iso": "HKD",
    "custom_data": [],
    "custom_discount_items": [],
    "customer_email": "[email protected]",
    "customer_id": "657feb68a7cb17eff1a7ce36",
    "customer_info": {},
    "customer_name": "TestingUser",
    "customer_phone": "93533001",
    "customer_phone_country_code": "852",
    "default_warehouse_id": null,
    "delivery_address": {
      "address_1": "test address",
      "address_2": "Wong Tai Sin",
      "city": "Kowloon",
      "country": "Hong Kong",
      "country_code": "HK",
      "district": "San Po Kong",
      "key": null,
      "layer1": null,
      "layer2": null,
      "layer3": null,
      "logistic_codes": [
        "2200002",
        "2200016",
        "2200074"
      ],
      "postcode": null,
      "recipient_name": "TestingUser",
      "recipient_phone": "93533001",
      "recipient_phone_country_code": "852",
      "remarks": null,
      "state": null
    },
    "delivery_data": {
      "hk_sfplus_home_region": null,
      "instore_pickup": false,
      "location_code": null,
      "location_name": null,
      "location_short_name": null,
      "name_translations": null,
      "scheduled_delivery_date": null,
      "store_address": null,
      "store_address_detail": {},
      "target_channel_id": null,
      "time_slot_key": "",
      "time_slot_translations": null,
      "tracking_number": "",
      "url": null
    },
    "edited_at": null,
    "ga_tracked": false,
    "id": "657fec07ec33fa00628a3714",
    "inclusive_tax_info": {},
    "invoice": {
      "buyer_name": "",
      "carrier_number": "",
      "carrier_type": "",
      "invoice_cancelled_at": null,
      "invoice_date": null,
      "invoice_number": "",
      "invoice_status": "",
      "invoice_tax_type": "",
      "invoice_type": "",
      "mailing_address": "",
      "n_p_o_b_a_n": "",
      "tax_id": ""
    },
    "invoices": [],
    "is_guest_checkout": false,
    "language_code": "en",
    "membership_tier_data": null,
    "merchant_order_number": null,
    "order_comments": [],
    "order_delivery": {
      "arrived_at": "2023-12-18T06:53:58.073+00:00",
      "collected_at": null,
      "delivery_option_id": "657fead80abede0037de88e0",
      "delivery_status": "pending",
      "delivery_type": "custom",
      "exp_type": null,
      "id": "657fec07ec33fa00628a371a",
      "name_translations": {
        "en": "",
        "zh-hant": "Custom"
      },
      "platform": "custom",
      "remark": null,
      "request_accepted_at": null,
      "request_authorized_at": null,
      "request_submitted_at": null,
      "requested_fmt_at": null,
      "require_expired_upload": false,
      "require_storeclosed_upload": false,
      "requires_customer_address": true,
      "return_order_id": null,
      "returned_at": null,
      "shipped_at": "2023-12-18T06:53:58.073+00:00",
      "status": "arrived",
      "store_closed_at": null,
      "storeclosed_upload_at": null,
      "total": {
        "cents": 2000,
        "currency_iso": "HKD",
        "currency_symbol": "HK$",
        "dollars": 20,
        "label": "HK$20.00"
      },
      "updated_at": "2023-12-18T06:53:58.074Z"
    },
    "order_discount": {
      "cents": 0,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 0,
      "label": ""
    },
    "order_notes": [],
    "order_number": "20231218065151059",
    "order_payment": {
      "created_at": "2023-12-18T06:51:51.793Z",
      "id": "657fec07ec33fa00628a3719",
      "last_four_digits": "",
      "name_translations": {
        "en": "Cash on Delivery",
        "zh-hant": "貨到付款"
      },
      "paid_at": null,
      "payment_data": {},
      "payment_fee": {
        "cents": 1000,
        "currency_iso": "HKD",
        "currency_symbol": "HK$",
        "dollars": 10,
        "label": "HK$10.00"
      },
      "payment_method_id": "657feab20abede003dde8822",
      "payment_type": "cash_on_delivery",
      "ref_payment_id": null,
      "status": "pending",
      "total": {
        "cents": 4000,
        "currency_iso": "HKD",
        "currency_symbol": "HK$",
        "dollars": 40,
        "label": "HK$40.00"
      },
      "updated_at": "2023-12-18T06:51:53.389Z"
    },
    "order_points": 0,
    "order_points_to_cash": {
      "cents": 0,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 0,
      "label": ""
    },
    "order_remarks": "",
    "order_source": {
      "id": "657fec08ec33fa00628a371b",
      "name": null,
      "source_id": null,
      "type": "storefront"
    },
    "parent_order_id": "",
    "payment_slips": [],
    "product_subscription_period": null,
    "promotion_items": [],
    "ref_customer_id": "",
    "ref_order_id": "",
    "return_from_order_id": null,
    "skip_fulfillment": false,
    "split_at": null,
    "status": "pending",
    "subtotal": {
      "cents": 1000,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 10,
      "label": "HK$10.00"
    },
    "subtotal_items": [
      {
        "cost": {
          "cents": 0,
          "currency_iso": "HKD",
          "currency_symbol": "HK$",
          "dollars": 0,
          "label": "HK$0.00"
        },
        "created_by": "admin",
        "discounted_price": null,
        "fields_translations": {},
        "id": "657fec07ec33fa00628a3716",
        "is_preorder": false,
        "item_data": {
          "cart_item_id": "1710065",
          "custom_discounted_amount": {
            "cents": 0,
            "currency_iso": "HKD",
            "currency_symbol": "HK$",
            "dollars": 0,
            "label": ""
          },
          "custom_discounted_amount_items": [],
          "order_promotion_items": {},
          "parent_item_ids": [],
          "promotion_id": null,
          "triggering_item_id": ""
        },
        "item_id": "657fea540abede0037de88da",
        "item_price": {
          "cents": 1000,
          "currency_iso": "HKD",
          "currency_symbol": "HK$",
          "dollars": 10,
          "label": "HK$10.00"
        },
        "item_type": "Product",
        "item_variation_id": "",
        "item_variation_key": "",
        "media": {
          "_id": "657fea3f0abede003dde8821",
          "alt_translations": {},
          "blurhash": "UVRysgRj%Mxut7ayofj[~qt7IURj%Mj[WBay",
          "images": {
            "favicon": {
              "height": 250,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
              "width": 800
            },
            "favicon_large": {
              "height": 250,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
              "width": 800
            },
            "favicon_small": {
              "height": 250,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
              "width": 800
            },
            "original": {
              "height": 250,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
              "width": 800
            },
            "source": {
              "height": 250,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
              "width": 800
            },
            "thumb": {
              "height": 250,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
              "width": 800
            },
            "transparent_large": {
              "height": 250,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
              "width": 800
            },
            "transparent_thumb": {
              "height": 250,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
              "width": 800
            },
            "transparent_xlarge": {
              "height": 250,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
              "width": 800
            }
          }
        },
        "object_data": {
          "adult": "no",
          "age_group": "all_ages",
          "barcode_type": "Code 128",
          "condition": "new",
          "gender": "unisex",
          "gtin": "10122190",
          "max_order_quantity": -1,
          "status": "active",
          "weight": 0
        },
        "order_discounted_price": null,
        "preorder_note_translations": {},
        "price": {
          "cents": 1000,
          "currency_iso": "HKD",
          "currency_symbol": "HK$",
          "dollars": 10,
          "label": "HK$10.00"
        },
        "price_sale": {
          "cents": 0,
          "currency_iso": "HKD",
          "currency_symbol": "HK$",
          "dollars": 0,
          "label": "HK$0.00"
        },
        "product_subscription_id": null,
        "quantity": 1,
        "ref_data": null,
        "sku": "",
        "title_translations": {
          "en": "Product"
        },
        "total": {
          "cents": 1000,
          "currency_iso": "HKD",
          "currency_symbol": "HK$",
          "dollars": 10,
          "label": "HK$10.00"
        }
      }
    ],
    "system_order_number": "20231218065151059",
    "tags": [],
    "total": {
      "cents": 4000,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 40,
      "label": "HK$40.00"
    },
    "total_tax_fee": {
      "cents": 0,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 0,
      "label": ""
    },
    "updated_at": "2023-12-18T06:53:58.174Z",
    "user_credit": {
      "cents": 0,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 0,
      "label": ""
    },
    "utm_data": {}
  },
  "topic": "order/pending",
  "trace_id": "b6d3beeb-c569-4773-8b97-44080d8297e0",
  "ts": "1741146106262000000"
}

order/product_detail_notify_customer

Topic Name:

order/product_detail_notify_customer

Description:

訂單編輯後發送通知

Required Scopes in DC App Scope page:

Orders - index, or;
Orders - show, or;
Orders - all;

Payload Example:

{
  "event": "Order",
  "merchant_id": "657fe76b11d72b1c22fb4aaf",
  "resource": {
    "_id": "657fec07ec33fa00628a3714",
    "affiliate_campaign": {},
    "affiliate_data": {},
    "applied_tax_info": {
      "delivery": {},
      "sales": {}
    },
    "cart_attributes": {
      "affiliate_data": {},
      "cart_id": "1055157",
      "shop_session_id": ""
    },
    "cart_page_id": null,
    "channel": {},
    "checkout_object_data": {
      "_id": "657fec07ec33fa00628a3712",
      "current_total": {
        "cents": 4000,
        "currency_iso": "HKD",
        "currency_symbol": "HK$",
        "dollars": 40,
        "label": "HK$40.00"
      },
      "number": "C20231218065151058",
      "order_ids": [
        "657fec07ec33fa00628a3714"
      ]
    },
    "child_order_ids": [],
    "confirmed_at": null,
    "created_at": "2023-12-18T06:51:51.641Z",
    "created_by": "shop",
    "created_from": "shop",
    "currency_iso": "HKD",
    "custom_data": [],
    "custom_discount_items": [],
    "customer_email": "[email protected]",
    "customer_id": "657feb68a7cb17eff1a7ce36",
    "customer_info": {},
    "customer_name": "TestingUser",
    "customer_phone": "93533001",
    "customer_phone_country_code": "852",
    "default_warehouse_id": null,
    "delivery_address": {
      "address_1": "test address",
      "address_2": "Wong Tai Sin",
      "city": "Kowloon",
      "country": "Hong Kong",
      "country_code": "HK",
      "district": "San Po Kong",
      "key": null,
      "layer1": null,
      "layer2": null,
      "layer3": null,
      "logistic_codes": [
        "2200002",
        "2200016",
        "2200074"
      ],
      "postcode": null,
      "recipient_name": "TestingUser",
      "recipient_phone": "93533001",
      "recipient_phone_country_code": "852",
      "remarks": null,
      "state": null
    },
    "delivery_data": {
      "hk_sfplus_home_region": null,
      "instore_pickup": false,
      "location_code": null,
      "location_name": null,
      "location_short_name": null,
      "name_translations": null,
      "scheduled_delivery_date": null,
      "store_address": null,
      "store_address_detail": {},
      "target_channel_id": null,
      "time_slot_key": "",
      "time_slot_translations": null,
      "tracking_number": "",
      "url": null
    },
    "edited_at": null,
    "ga_tracked": false,
    "id": "657fec07ec33fa00628a3714",
    "inclusive_tax_info": {},
    "invoice": {
      "buyer_name": "",
      "carrier_number": "",
      "carrier_type": "",
      "invoice_cancelled_at": null,
      "invoice_date": null,
      "invoice_number": "",
      "invoice_status": "",
      "invoice_tax_type": "",
      "invoice_type": "",
      "mailing_address": "",
      "n_p_o_b_a_n": "",
      "tax_id": ""
    },
    "invoices": [],
    "is_guest_checkout": false,
    "language_code": "en",
    "membership_tier_data": null,
    "merchant_order_number": null,
    "order_comments": [],
    "order_delivery": {
      "arrived_at": "2023-12-18T06:53:58.073+00:00",
      "collected_at": null,
      "delivery_option_id": "657fead80abede0037de88e0",
      "delivery_status": "pending",
      "delivery_type": "custom",
      "exp_type": null,
      "id": "657fec07ec33fa00628a371a",
      "name_translations": {
        "en": "",
        "zh-hant": "Custom"
      },
      "platform": "custom",
      "remark": null,
      "request_accepted_at": null,
      "request_authorized_at": null,
      "request_submitted_at": null,
      "requested_fmt_at": null,
      "require_expired_upload": false,
      "require_storeclosed_upload": false,
      "requires_customer_address": true,
      "return_order_id": null,
      "returned_at": null,
      "shipped_at": "2023-12-18T06:53:58.073+00:00",
      "status": "arrived",
      "store_closed_at": null,
      "storeclosed_upload_at": null,
      "total": {
        "cents": 2000,
        "currency_iso": "HKD",
        "currency_symbol": "HK$",
        "dollars": 20,
        "label": "HK$20.00"
      },
      "updated_at": "2023-12-18T06:53:58.074Z"
    },
    "order_discount": {
      "cents": 0,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 0,
      "label": ""
    },
    "order_notes": [],
    "order_number": "20231218065151059",
    "order_payment": {
      "created_at": "2023-12-18T06:51:51.793Z",
      "id": "657fec07ec33fa00628a3719",
      "last_four_digits": "",
      "name_translations": {
        "en": "Cash on Delivery",
        "zh-hant": "貨到付款"
      },
      "paid_at": null,
      "payment_data": {},
      "payment_fee": {
        "cents": 1000,
        "currency_iso": "HKD",
        "currency_symbol": "HK$",
        "dollars": 10,
        "label": "HK$10.00"
      },
      "payment_method_id": "657feab20abede003dde8822",
      "payment_type": "cash_on_delivery",
      "ref_payment_id": null,
      "status": "pending",
      "total": {
        "cents": 4000,
        "currency_iso": "HKD",
        "currency_symbol": "HK$",
        "dollars": 40,
        "label": "HK$40.00"
      },
      "updated_at": "2023-12-18T06:51:53.389Z"
    },
    "order_points": 0,
    "order_points_to_cash": {
      "cents": 0,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 0,
      "label": ""
    },
    "order_remarks": "",
    "order_source": {
      "id": "657fec08ec33fa00628a371b",
      "name": null,
      "source_id": null,
      "type": "storefront"
    },
    "parent_order_id": "",
    "payment_slips": [],
    "product_subscription_period": null,
    "promotion_items": [],
    "ref_customer_id": "",
    "ref_order_id": "",
    "return_from_order_id": null,
    "skip_fulfillment": false,
    "split_at": null,
    "status": "pending",
    "subtotal": {
      "cents": 1000,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 10,
      "label": "HK$10.00"
    },
    "subtotal_items": [
      {
        "cost": {
          "cents": 0,
          "currency_iso": "HKD",
          "currency_symbol": "HK$",
          "dollars": 0,
          "label": "HK$0.00"
        },
        "created_by": "admin",
        "discounted_price": null,
        "fields_translations": {},
        "id": "657fec07ec33fa00628a3716",
        "is_preorder": false,
        "item_data": {
          "cart_item_id": "1710065",
          "custom_discounted_amount": {
            "cents": 0,
            "currency_iso": "HKD",
            "currency_symbol": "HK$",
            "dollars": 0,
            "label": ""
          },
          "custom_discounted_amount_items": [],
          "order_promotion_items": {},
          "parent_item_ids": [],
          "promotion_id": null,
          "triggering_item_id": ""
        },
        "item_id": "657fea540abede0037de88da",
        "item_price": {
          "cents": 1000,
          "currency_iso": "HKD",
          "currency_symbol": "HK$",
          "dollars": 10,
          "label": "HK$10.00"
        },
        "item_type": "Product",
        "item_variation_id": "",
        "item_variation_key": "",
        "media": {
          "_id": "657fea3f0abede003dde8821",
          "alt_translations": {},
          "blurhash": "UVRysgRj%Mxut7ayofj[~qt7IURj%Mj[WBay",
          "images": {
            "favicon": {
              "height": 250,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
              "width": 800
            },
            "favicon_large": {
              "height": 250,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
              "width": 800
            },
            "favicon_small": {
              "height": 250,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
              "width": 800
            },
            "original": {
              "height": 250,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
              "width": 800
            },
            "source": {
              "height": 250,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
              "width": 800
            },
            "thumb": {
              "height": 250,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
              "width": 800
            },
            "transparent_large": {
              "height": 250,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
              "width": 800
            },
            "transparent_thumb": {
              "height": 250,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
              "width": 800
            },
            "transparent_xlarge": {
              "height": 250,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
              "width": 800
            }
          }
        },
        "object_data": {
          "adult": "no",
          "age_group": "all_ages",
          "barcode_type": "Code 128",
          "condition": "new",
          "gender": "unisex",
          "gtin": "10122190",
          "max_order_quantity": -1,
          "status": "active",
          "weight": 0
        },
        "order_discounted_price": null,
        "preorder_note_translations": {},
        "price": {
          "cents": 1000,
          "currency_iso": "HKD",
          "currency_symbol": "HK$",
          "dollars": 10,
          "label": "HK$10.00"
        },
        "price_sale": {
          "cents": 0,
          "currency_iso": "HKD",
          "currency_symbol": "HK$",
          "dollars": 0,
          "label": "HK$0.00"
        },
        "product_subscription_id": null,
        "quantity": 1,
        "ref_data": null,
        "sku": "",
        "title_translations": {
          "en": "Product"
        },
        "total": {
          "cents": 1000,
          "currency_iso": "HKD",
          "currency_symbol": "HK$",
          "dollars": 10,
          "label": "HK$10.00"
        }
      }
    ],
    "system_order_number": "20231218065151059",
    "tags": [],
    "total": {
      "cents": 4000,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 40,
      "label": "HK$40.00"
    },
    "total_tax_fee": {
      "cents": 0,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 0,
      "label": ""
    },
    "updated_at": "2023-12-18T06:53:58.174Z",
    "user_credit": {
      "cents": 0,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 0,
      "label": ""
    },
    "utm_data": {}
  },
  "topic": "order/product_detail_notify_customer",
  "trace_id": "ffa746ff-d779-42d7-8c7a-aff007f006f5",
  "ts": "1741155824798000000"
}

order/remove

Topic Name:

order/remove

Description:

當訂單被刪除時

Required Scopes in DC App Scope page:

Orders - index, or;
Orders - show, or;
Orders - all;

Payload Example:

{
  "event": "Order",
  "merchant_id": "657fe76b11d72b1c22fb4aaf",
  "resource": {
    "_id": "657fec07ec33fa00628a3714",
    "affiliate_campaign": {},
    "affiliate_data": {},
    "applied_tax_info": {
      "delivery": {},
      "sales": {}
    },
    "cart_attributes": {
      "affiliate_data": {},
      "cart_id": "1055157",
      "shop_session_id": ""
    },
    "cart_page_id": null,
    "channel": {},
    "checkout_object_data": {
      "_id": "657fec07ec33fa00628a3712",
      "current_total": {
        "cents": 4000,
        "currency_iso": "HKD",
        "currency_symbol": "HK$",
        "dollars": 40,
        "label": "HK$40.00"
      },
      "number": "C20231218065151058",
      "order_ids": [
        "657fec07ec33fa00628a3714"
      ]
    },
    "child_order_ids": [],
    "confirmed_at": null,
    "created_at": "2023-12-18T06:51:51.641Z",
    "created_by": "shop",
    "created_from": "shop",
    "currency_iso": "HKD",
    "custom_data": [],
    "custom_discount_items": [],
    "customer_email": "[email protected]",
    "customer_id": "657feb68a7cb17eff1a7ce36",
    "customer_info": {},
    "customer_name": "TestingUser",
    "customer_phone": "93533001",
    "customer_phone_country_code": "852",
    "default_warehouse_id": null,
    "delivery_address": {
      "address_1": "test address",
      "address_2": "Wong Tai Sin",
      "city": "Kowloon",
      "country": "Hong Kong",
      "country_code": "HK",
      "district": "San Po Kong",
      "key": null,
      "layer1": null,
      "layer2": null,
      "layer3": null,
      "logistic_codes": [
        "2200002",
        "2200016",
        "2200074"
      ],
      "postcode": null,
      "recipient_name": "TestingUser",
      "recipient_phone": "93533001",
      "recipient_phone_country_code": "852",
      "remarks": null,
      "state": null
    },
    "delivery_data": {
      "hk_sfplus_home_region": null,
      "instore_pickup": false,
      "location_code": null,
      "location_name": null,
      "location_short_name": null,
      "name_translations": null,
      "scheduled_delivery_date": null,
      "store_address": null,
      "store_address_detail": {},
      "target_channel_id": null,
      "time_slot_key": "",
      "time_slot_translations": null,
      "tracking_number": "",
      "url": null
    },
    "edited_at": null,
    "ga_tracked": false,
    "id": "657fec07ec33fa00628a3714",
    "inclusive_tax_info": {},
    "invoice": {
      "buyer_name": "",
      "carrier_number": "",
      "carrier_type": "",
      "invoice_cancelled_at": null,
      "invoice_date": null,
      "invoice_number": "",
      "invoice_status": "",
      "invoice_tax_type": "",
      "invoice_type": "",
      "mailing_address": "",
      "n_p_o_b_a_n": "",
      "tax_id": ""
    },
    "invoices": [],
    "is_guest_checkout": false,
    "language_code": "en",
    "membership_tier_data": null,
    "merchant_order_number": null,
    "order_comments": [],
    "order_delivery": {
      "arrived_at": "2023-12-18T06:53:58.073+00:00",
      "collected_at": null,
      "delivery_option_id": "657fead80abede0037de88e0",
      "delivery_status": "pending",
      "delivery_type": "custom",
      "exp_type": null,
      "id": "657fec07ec33fa00628a371a",
      "name_translations": {
        "en": "",
        "zh-hant": "Custom"
      },
      "platform": "custom",
      "remark": null,
      "request_accepted_at": null,
      "request_authorized_at": null,
      "request_submitted_at": null,
      "requested_fmt_at": null,
      "require_expired_upload": false,
      "require_storeclosed_upload": false,
      "requires_customer_address": true,
      "return_order_id": null,
      "returned_at": null,
      "shipped_at": "2023-12-18T06:53:58.073+00:00",
      "status": "arrived",
      "store_closed_at": null,
      "storeclosed_upload_at": null,
      "total": {
        "cents": 2000,
        "currency_iso": "HKD",
        "currency_symbol": "HK$",
        "dollars": 20,
        "label": "HK$20.00"
      },
      "updated_at": "2023-12-18T06:53:58.074Z"
    },
    "order_discount": {
      "cents": 0,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 0,
      "label": ""
    },
    "order_notes": [],
    "order_number": "20231218065151059",
    "order_payment": {
      "created_at": "2023-12-18T06:51:51.793Z",
      "id": "657fec07ec33fa00628a3719",
      "last_four_digits": "",
      "name_translations": {
        "en": "Cash on Delivery",
        "zh-hant": "貨到付款"
      },
      "paid_at": null,
      "payment_data": {},
      "payment_fee": {
        "cents": 1000,
        "currency_iso": "HKD",
        "currency_symbol": "HK$",
        "dollars": 10,
        "label": "HK$10.00"
      },
      "payment_method_id": "657feab20abede003dde8822",
      "payment_type": "cash_on_delivery",
      "ref_payment_id": null,
      "status": "pending",
      "total": {
        "cents": 4000,
        "currency_iso": "HKD",
        "currency_symbol": "HK$",
        "dollars": 40,
        "label": "HK$40.00"
      },
      "updated_at": "2023-12-18T06:51:53.389Z"
    },
    "order_points": 0,
    "order_points_to_cash": {
      "cents": 0,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 0,
      "label": ""
    },
    "order_remarks": "",
    "order_source": {
      "id": "657fec08ec33fa00628a371b",
      "name": null,
      "source_id": null,
      "type": "storefront"
    },
    "parent_order_id": "",
    "payment_slips": [],
    "product_subscription_period": null,
    "promotion_items": [],
    "ref_customer_id": "",
    "ref_order_id": "",
    "return_from_order_id": null,
    "skip_fulfillment": false,
    "split_at": null,
    "status": "pending",
    "subtotal": {
      "cents": 1000,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 10,
      "label": "HK$10.00"
    },
    "subtotal_items": [
      {
        "cost": {
          "cents": 0,
          "currency_iso": "HKD",
          "currency_symbol": "HK$",
          "dollars": 0,
          "label": "HK$0.00"
        },
        "created_by": "admin",
        "discounted_price": null,
        "fields_translations": {},
        "id": "657fec07ec33fa00628a3716",
        "is_preorder": false,
        "item_data": {
          "cart_item_id": "1710065",
          "custom_discounted_amount": {
            "cents": 0,
            "currency_iso": "HKD",
            "currency_symbol": "HK$",
            "dollars": 0,
            "label": ""
          },
          "custom_discounted_amount_items": [],
          "order_promotion_items": {},
          "parent_item_ids": [],
          "promotion_id": null,
          "triggering_item_id": ""
        },
        "item_id": "657fea540abede0037de88da",
        "item_price": {
          "cents": 1000,
          "currency_iso": "HKD",
          "currency_symbol": "HK$",
          "dollars": 10,
          "label": "HK$10.00"
        },
        "item_type": "Product",
        "item_variation_id": "",
        "item_variation_key": "",
        "media": {
          "_id": "657fea3f0abede003dde8821",
          "alt_translations": {},
          "blurhash": "UVRysgRj%Mxut7ayofj[~qt7IURj%Mj[WBay",
          "images": {
            "favicon": {
              "height": 250,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
              "width": 800
            },
            "favicon_large": {
              "height": 250,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
              "width": 800
            },
            "favicon_small": {
              "height": 250,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
              "width": 800
            },
            "original": {
              "height": 250,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
              "width": 800
            },
            "source": {
              "height": 250,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
              "width": 800
            },
            "thumb": {
              "height": 250,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
              "width": 800
            },
            "transparent_large": {
              "height": 250,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
              "width": 800
            },
            "transparent_thumb": {
              "height": 250,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
              "width": 800
            },
            "transparent_xlarge": {
              "height": 250,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
              "width": 800
            }
          }
        },
        "object_data": {
          "adult": "no",
          "age_group": "all_ages",
          "barcode_type": "Code 128",
          "condition": "new",
          "gender": "unisex",
          "gtin": "10122190",
          "max_order_quantity": -1,
          "status": "active",
          "weight": 0
        },
        "order_discounted_price": null,
        "preorder_note_translations": {},
        "price": {
          "cents": 1000,
          "currency_iso": "HKD",
          "currency_symbol": "HK$",
          "dollars": 10,
          "label": "HK$10.00"
        },
        "price_sale": {
          "cents": 0,
          "currency_iso": "HKD",
          "currency_symbol": "HK$",
          "dollars": 0,
          "label": "HK$0.00"
        },
        "product_subscription_id": null,
        "quantity": 1,
        "ref_data": null,
        "sku": "",
        "title_translations": {
          "en": "Product"
        },
        "total": {
          "cents": 1000,
          "currency_iso": "HKD",
          "currency_symbol": "HK$",
          "dollars": 10,
          "label": "HK$10.00"
        }
      }
    ],
    "system_order_number": "20231218065151059",
    "tags": [],
    "total": {
      "cents": 4000,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 40,
      "label": "HK$40.00"
    },
    "total_tax_fee": {
      "cents": 0,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 0,
      "label": ""
    },
    "updated_at": "2023-12-18T06:53:58.174Z",
    "user_credit": {
      "cents": 0,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 0,
      "label": ""
    },
    "utm_data": {}
  },
  "topic": "order/remove",
  "trace_id": "ff76e4b4-654f-4828-868a-65b80838ad19",
  "ts": "1741146106262000000"
}

order/status_notify_customer

Topic Name:

order/status_notify_customer

Description:

在 Admin 後台更改訂單狀態後，勾選「發送訂單狀態更新通知給你的顧客」並按下「是」時發送此 webhook

Required Scopes in DC App Scope page:

Orders - index, or;
Orders - show, or;
Orders - all;

Payload Example:

{
  "event": "Order",
  "merchant_id": "657fe76b11d72b1c22fb4aaf",
  "resource": {
    "_id": "657fec07ec33fa00628a3714",
    "affiliate_campaign": {},
    "affiliate_data": {},
    "applied_tax_info": {
      "delivery": {},
      "sales": {}
    },
    "cart_attributes": {
      "affiliate_data": {},
      "cart_id": "1055157",
      "shop_session_id": ""
    },
    "cart_page_id": null,
    "channel": {},
    "checkout_object_data": {
      "_id": "657fec07ec33fa00628a3712",
      "current_total": {
        "cents": 4000,
        "currency_iso": "HKD",
        "currency_symbol": "HK$",
        "dollars": 40,
        "label": "HK$40.00"
      },
      "number": "C20231218065151058",
      "order_ids": [
        "657fec07ec33fa00628a3714"
      ]
    },
    "child_order_ids": [],
    "confirmed_at": null,
    "created_at": "2023-12-18T06:51:51.641Z",
    "created_by": "shop",
    "created_from": "shop",
    "currency_iso": "HKD",
    "custom_data": [],
    "custom_discount_items": [],
    "customer_email": "[email protected]",
    "customer_id": "657feb68a7cb17eff1a7ce36",
    "customer_info": {},
    "customer_name": "TestingUser",
    "customer_phone": "93533001",
    "customer_phone_country_code": "852",
    "default_warehouse_id": null,
    "delivery_address": {
      "address_1": "test address",
      "address_2": "Wong Tai Sin",
      "city": "Kowloon",
      "country": "Hong Kong",
      "country_code": "HK",
      "district": "San Po Kong",
      "key": null,
      "layer1": null,
      "layer2": null,
      "layer3": null,
      "logistic_codes": [
        "2200002",
        "2200016",
        "2200074"
      ],
      "postcode": null,
      "recipient_name": "TestingUser",
      "recipient_phone": "93533001",
      "recipient_phone_country_code": "852",
      "remarks": null,
      "state": null
    },
    "delivery_data": {
      "hk_sfplus_home_region": null,
      "instore_pickup": false,
      "location_code": null,
      "location_name": null,
      "location_short_name": null,
      "name_translations": null,
      "scheduled_delivery_date": null,
      "store_address": null,
      "store_address_detail": {},
      "target_channel_id": null,
      "time_slot_key": "",
      "time_slot_translations": null,
      "tracking_number": "",
      "url": null
    },
    "edited_at": null,
    "ga_tracked": false,
    "id": "657fec07ec33fa00628a3714",
    "inclusive_tax_info": {},
    "invoice": {
      "buyer_name": "",
      "carrier_number": "",
      "carrier_type": "",
      "invoice_cancelled_at": null,
      "invoice_date": null,
      "invoice_number": "",
      "invoice_status": "",
      "invoice_tax_type": "",
      "invoice_type": "",
      "mailing_address": "",
      "n_p_o_b_a_n": "",
      "tax_id": ""
    },
    "invoices": [],
    "is_guest_checkout": false,
    "language_code": "en",
    "membership_tier_data": null,
    "merchant_order_number": null,
    "order_comments": [],
    "order_delivery": {
      "arrived_at": "2023-12-18T06:53:58.073+00:00",
      "collected_at": null,
      "delivery_option_id": "657fead80abede0037de88e0",
      "delivery_status": "pending",
      "delivery_type": "custom",
      "exp_type": null,
      "id": "657fec07ec33fa00628a371a",
      "name_translations": {
        "en": "",
        "zh-hant": "Custom"
      },
      "platform": "custom",
      "remark": null,
      "request_accepted_at": null,
      "request_authorized_at": null,
      "request_submitted_at": null,
      "requested_fmt_at": null,
      "require_expired_upload": false,
      "require_storeclosed_upload": false,
      "requires_customer_address": true,
      "return_order_id": null,
      "returned_at": null,
      "shipped_at": "2023-12-18T06:53:58.073+00:00",
      "status": "arrived",
      "store_closed_at": null,
      "storeclosed_upload_at": null,
      "total": {
        "cents": 2000,
        "currency_iso": "HKD",
        "currency_symbol": "HK$",
        "dollars": 20,
        "label": "HK$20.00"
      },
      "updated_at": "2023-12-18T06:53:58.074Z"
    },
    "order_discount": {
      "cents": 0,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 0,
      "label": ""
    },
    "order_notes": [],
    "order_number": "20231218065151059",
    "order_payment": {
      "created_at": "2023-12-18T06:51:51.793Z",
      "id": "657fec07ec33fa00628a3719",
      "last_four_digits": "",
      "name_translations": {
        "en": "Cash on Delivery",
        "zh-hant": "貨到付款"
      },
      "paid_at": null,
      "payment_data": {},
      "payment_fee": {
        "cents": 1000,
        "currency_iso": "HKD",
        "currency_symbol": "HK$",
        "dollars": 10,
        "label": "HK$10.00"
      },
      "payment_method_id": "657feab20abede003dde8822",
      "payment_type": "cash_on_delivery",
      "ref_payment_id": null,
      "status": "pending",
      "total": {
        "cents": 4000,
        "currency_iso": "HKD",
        "currency_symbol": "HK$",
        "dollars": 40,
        "label": "HK$40.00"
      },
      "updated_at": "2023-12-18T06:51:53.389Z"
    },
    "order_points": 0,
    "order_points_to_cash": {
      "cents": 0,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 0,
      "label": ""
    },
    "order_remarks": "",
    "order_source": {
      "id": "657fec08ec33fa00628a371b",
      "name": null,
      "source_id": null,
      "type": "storefront"
    },
    "parent_order_id": "",
    "payment_slips": [],
    "product_subscription_period": null,
    "promotion_items": [],
    "ref_customer_id": "",
    "ref_order_id": "",
    "return_from_order_id": null,
    "skip_fulfillment": false,
    "split_at": null,
    "status": "pending",
    "subtotal": {
      "cents": 1000,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 10,
      "label": "HK$10.00"
    },
    "subtotal_items": [
      {
        "cost": {
          "cents": 0,
          "currency_iso": "HKD",
          "currency_symbol": "HK$",
          "dollars": 0,
          "label": "HK$0.00"
        },
        "created_by": "admin",
        "discounted_price": null,
        "fields_translations": {},
        "id": "657fec07ec33fa00628a3716",
        "is_preorder": false,
        "item_data": {
          "cart_item_id": "1710065",
          "custom_discounted_amount": {
            "cents": 0,
            "currency_iso": "HKD",
            "currency_symbol": "HK$",
            "dollars": 0,
            "label": ""
          },
          "custom_discounted_amount_items": [],
          "order_promotion_items": {},
          "parent_item_ids": [],
          "promotion_id": null,
          "triggering_item_id": ""
        },
        "item_id": "657fea540abede0037de88da",
        "item_price": {
          "cents": 1000,
          "currency_iso": "HKD",
          "currency_symbol": "HK$",
          "dollars": 10,
          "label": "HK$10.00"
        },
        "item_type": "Product",
        "item_variation_id": "",
        "item_variation_key": "",
        "media": {
          "_id": "657fea3f0abede003dde8821",
          "alt_translations": {},
          "blurhash": "UVRysgRj%Mxut7ayofj[~qt7IURj%Mj[WBay",
          "images": {
            "favicon": {
              "height": 250,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
              "width": 800
            },
            "favicon_large": {
              "height": 250,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
              "width": 800
            },
            "favicon_small": {
              "height": 250,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
              "width": 800
            },
            "original": {
              "height": 250,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
              "width": 800
            },
            "source": {
              "height": 250,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
              "width": 800
            },
            "thumb": {
              "height": 250,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
              "width": 800
            },
            "transparent_large": {
              "height": 250,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
              "width": 800
            },
            "transparent_thumb": {
              "height": 250,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
              "width": 800
            },
            "transparent_xlarge": {
              "height": 250,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
              "width": 800
            }
          }
        },
        "object_data": {
          "adult": "no",
          "age_group": "all_ages",
          "barcode_type": "Code 128",
          "condition": "new",
          "gender": "unisex",
          "gtin": "10122190",
          "max_order_quantity": -1,
          "status": "active",
          "weight": 0
        },
        "order_discounted_price": null,
        "preorder_note_translations": {},
        "price": {
          "cents": 1000,
          "currency_iso": "HKD",
          "currency_symbol": "HK$",
          "dollars": 10,
          "label": "HK$10.00"
        },
        "price_sale": {
          "cents": 0,
          "currency_iso": "HKD",
          "currency_symbol": "HK$",
          "dollars": 0,
          "label": "HK$0.00"
        },
        "product_subscription_id": null,
        "quantity": 1,
        "ref_data": null,
        "sku": "",
        "title_translations": {
          "en": "Product"
        },
        "total": {
          "cents": 1000,
          "currency_iso": "HKD",
          "currency_symbol": "HK$",
          "dollars": 10,
          "label": "HK$10.00"
        }
      }
    ],
    "system_order_number": "20231218065151059",
    "tags": [],
    "total": {
      "cents": 4000,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 40,
      "label": "HK$40.00"
    },
    "total_tax_fee": {
      "cents": 0,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 0,
      "label": ""
    },
    "updated_at": "2023-12-18T06:53:58.174Z",
    "user_credit": {
      "cents": 0,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 0,
      "label": ""
    },
    "utm_data": {}
  },
  "topic": "order/status_notify_customer",
  "trace_id": "f3b1d37c-6d87-42f9-beb1-0e2974a263ca",
  "ts": "1741155824798000000"
}

order/update

Topic Name:

order/update

Description:

訂單更新

Required Scopes in DC App Scope page:

Orders - index, or;
Orders - show, or;
Orders - all;

Trigger Point:

非建立新訂單的其他更新訂單資訊

Payload Example:

{
  "event": "Order",
  "merchant_id": "657fe76b11d72b1c22fb4aaf",
  "resource": {
    "_id": "657fec07ec33fa00628a3714",
    "affiliate_campaign": {},
    "affiliate_data": {},
    "applied_tax_info": {
      "delivery": {},
      "sales": {}
    },
    "cart_attributes": {
      "affiliate_data": {},
      "cart_id": "1055157",
      "shop_session_id": ""
    },
    "cart_page_id": null,
    "channel": {},
    "checkout_object_data": {
      "_id": "657fec07ec33fa00628a3712",
      "current_total": {
        "cents": 4000,
        "currency_iso": "HKD",
        "currency_symbol": "HK$",
        "dollars": 40,
        "label": "HK$40.00"
      },
      "number": "C20231218065151058",
      "order_ids": [
        "657fec07ec33fa00628a3714"
      ]
    },
    "child_order_ids": [],
    "confirmed_at": null,
    "created_at": "2023-12-18T06:51:51.641Z",
    "created_by": "shop",
    "created_from": "shop",
    "currency_iso": "HKD",
    "custom_data": [],
    "custom_discount_items": [],
    "customer_email": "[email protected]",
    "customer_id": "657feb68a7cb17eff1a7ce36",
    "customer_info": {},
    "customer_name": "TestingUser",
    "customer_phone": "93533001",
    "customer_phone_country_code": "852",
    "default_warehouse_id": null,
    "delivery_address": {
      "address_1": "test address",
      "address_2": "Wong Tai Sin",
      "city": "Kowloon",
      "country": "Hong Kong",
      "country_code": "HK",
      "district": "San Po Kong",
      "key": null,
      "layer1": null,
      "layer2": null,
      "layer3": null,
      "logistic_codes": [
        "2200002",
        "2200016",
        "2200074"
      ],
      "postcode": null,
      "recipient_name": "TestingUser",
      "recipient_phone": "93533001",
      "recipient_phone_country_code": "852",
      "remarks": null,
      "state": null
    },
    "delivery_data": {
      "hk_sfplus_home_region": null,
      "instore_pickup": false,
      "location_code": null,
      "location_name": null,
      "location_short_name": null,
      "name_translations": null,
      "scheduled_delivery_date": null,
      "store_address": null,
      "store_address_detail": {},
      "target_channel_id": null,
      "time_slot_key": "",
      "time_slot_translations": null,
      "tracking_number": "",
      "url": null
    },
    "edited_at": null,
    "ga_tracked": false,
    "id": "657fec07ec33fa00628a3714",
    "inclusive_tax_info": {},
    "invoice": {
      "buyer_name": "",
      "carrier_number": "",
      "carrier_type": "",
      "invoice_cancelled_at": null,
      "invoice_date": null,
      "invoice_number": "",
      "invoice_status": "",
      "invoice_tax_type": "",
      "invoice_type": "",
      "mailing_address": "",
      "n_p_o_b_a_n": "",
      "tax_id": ""
    },
    "invoices": [],
    "is_guest_checkout": false,
    "language_code": "en",
    "membership_tier_data": null,
    "merchant_order_number": null,
    "order_comments": [],
    "order_delivery": {
      "arrived_at": "2023-12-18T06:53:58.073+00:00",
      "collected_at": null,
      "delivery_option_id": "657fead80abede0037de88e0",
      "delivery_status": "pending",
      "delivery_type": "custom",
      "exp_type": null,
      "id": "657fec07ec33fa00628a371a",
      "name_translations": {
        "en": "",
        "zh-hant": "Custom"
      },
      "platform": "custom",
      "remark": null,
      "request_accepted_at": null,
      "request_authorized_at": null,
      "request_submitted_at": null,
      "requested_fmt_at": null,
      "require_expired_upload": false,
      "require_storeclosed_upload": false,
      "requires_customer_address": true,
      "return_order_id": null,
      "returned_at": null,
      "shipped_at": "2023-12-18T06:53:58.073+00:00",
      "status": "arrived",
      "store_closed_at": null,
      "storeclosed_upload_at": null,
      "total": {
        "cents": 2000,
        "currency_iso": "HKD",
        "currency_symbol": "HK$",
        "dollars": 20,
        "label": "HK$20.00"
      },
      "updated_at": "2023-12-18T06:53:58.074Z"
    },
    "order_discount": {
      "cents": 0,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 0,
      "label": ""
    },
    "order_notes": [],
    "order_number": "20231218065151059",
    "order_payment": {
      "created_at": "2023-12-18T06:51:51.793Z",
      "id": "657fec07ec33fa00628a3719",
      "last_four_digits": "",
      "name_translations": {
        "en": "Cash on Delivery",
        "zh-hant": "貨到付款"
      },
      "paid_at": null,
      "payment_data": {},
      "payment_fee": {
        "cents": 1000,
        "currency_iso": "HKD",
        "currency_symbol": "HK$",
        "dollars": 10,
        "label": "HK$10.00"
      },
      "payment_method_id": "657feab20abede003dde8822",
      "payment_type": "cash_on_delivery",
      "ref_payment_id": null,
      "status": "pending",
      "total": {
        "cents": 4000,
        "currency_iso": "HKD",
        "currency_symbol": "HK$",
        "dollars": 40,
        "label": "HK$40.00"
      },
      "updated_at": "2023-12-18T06:51:53.389Z"
    },
    "order_points": 0,
    "order_points_to_cash": {
      "cents": 0,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 0,
      "label": ""
    },
    "order_remarks": "",
    "order_source": {
      "id": "657fec08ec33fa00628a371b",
      "name": null,
      "source_id": null,
      "type": "storefront"
    },
    "parent_order_id": "",
    "payment_slips": [],
    "product_subscription_period": null,
    "promotion_items": [],
    "ref_customer_id": "",
    "ref_order_id": "",
    "return_from_order_id": null,
    "skip_fulfillment": false,
    "split_at": null,
    "status": "pending",
    "subtotal": {
      "cents": 1000,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 10,
      "label": "HK$10.00"
    },
    "subtotal_items": [
      {
        "cost": {
          "cents": 0,
          "currency_iso": "HKD",
          "currency_symbol": "HK$",
          "dollars": 0,
          "label": "HK$0.00"
        },
        "created_by": "admin",
        "discounted_price": null,
        "fields_translations": {},
        "id": "657fec07ec33fa00628a3716",
        "is_preorder": false,
        "item_data": {
          "cart_item_id": "1710065",
          "custom_discounted_amount": {
            "cents": 0,
            "currency_iso": "HKD",
            "currency_symbol": "HK$",
            "dollars": 0,
            "label": ""
          },
          "custom_discounted_amount_items": [],
          "order_promotion_items": {},
          "parent_item_ids": [],
          "promotion_id": null,
          "triggering_item_id": ""
        },
        "item_id": "657fea540abede0037de88da",
        "item_price": {
          "cents": 1000,
          "currency_iso": "HKD",
          "currency_symbol": "HK$",
          "dollars": 10,
          "label": "HK$10.00"
        },
        "item_type": "Product",
        "item_variation_id": "",
        "item_variation_key": "",
        "media": {
          "_id": "657fea3f0abede003dde8821",
          "alt_translations": {},
          "blurhash": "UVRysgRj%Mxut7ayofj[~qt7IURj%Mj[WBay",
          "images": {
            "favicon": {
              "height": 250,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
              "width": 800
            },
            "favicon_large": {
              "height": 250,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
              "width": 800
            },
            "favicon_small": {
              "height": 250,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
              "width": 800
            },
            "original": {
              "height": 250,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
              "width": 800
            },
            "source": {
              "height": 250,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
              "width": 800
            },
            "thumb": {
              "height": 250,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
              "width": 800
            },
            "transparent_large": {
              "height": 250,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
              "width": 800
            },
            "transparent_thumb": {
              "height": 250,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
              "width": 800
            },
            "transparent_xlarge": {
              "height": 250,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
              "width": 800
            }
          }
        },
        "object_data": {
          "adult": "no",
          "age_group": "all_ages",
          "barcode_type": "Code 128",
          "condition": "new",
          "gender": "unisex",
          "gtin": "10122190",
          "max_order_quantity": -1,
          "status": "active",
          "weight": 0
        },
        "order_discounted_price": null,
        "preorder_note_translations": {},
        "price": {
          "cents": 1000,
          "currency_iso": "HKD",
          "currency_symbol": "HK$",
          "dollars": 10,
          "label": "HK$10.00"
        },
        "price_sale": {
          "cents": 0,
          "currency_iso": "HKD",
          "currency_symbol": "HK$",
          "dollars": 0,
          "label": "HK$0.00"
        },
        "product_subscription_id": null,
        "quantity": 1,
        "ref_data": null,
        "sku": "",
        "title_translations": {
          "en": "Product"
        },
        "total": {
          "cents": 1000,
          "currency_iso": "HKD",
          "currency_symbol": "HK$",
          "dollars": 10,
          "label": "HK$10.00"
        }
      }
    ],
    "system_order_number": "20231218065151059",
    "tags": [],
    "total": {
      "cents": 4000,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 40,
      "label": "HK$40.00"
    },
    "total_tax_fee": {
      "cents": 0,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 0,
      "label": ""
    },
    "updated_at": "2023-12-18T06:53:58.174Z",
    "user_credit": {
      "cents": 0,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 0,
      "label": ""
    },
    "utm_data": {}
  },
  "topic": "order/update",
  "trace_id": "48d47c5e-e6c7-4b21-8ff4-0637229b1af1",
  "ts": "1741146106262000000"
}

Order Delivery Related Event

order_delivery/status_notify_customer

Topic Name:

order_delivery/status_notify_customer

Description:

在 Admin 後台更改訂單送貨狀態後，勾選「發送訂單送貨狀態更新通知給你的顧客」並按下「是」時發送此 webhook

Required Scopes in DC App Scope page:

Order - index, or;
Order - show, or;
Order - all;

Payload Example:

{
  "event": "OrderDelivery",
  "merchant_id": "657fe76b11d72b1c22fb4aaf",
  "resource": {
    "_id": "657fec07ec33fa00628a371a",
    "arrived_at": "2023-12-18T06:53:58.073+00:00",
    "collected_at": null,
    "created_at": "2023-12-18T06:51:51.829Z",
    "delivery_option_id": "657fead80abede0037de88e0",
    "delivery_status": "pending",
    "delivery_type": "custom",
    "exp_type": null,
    "id": "657fec07ec33fa00628a371a",
    "name_translations": {
      "en": "",
      "zh-hant": "Custom"
    },
    "order_id": "657fec07ec33fa00628a3714",
    "platform": "custom",
    "remark": null,
    "request_accepted_at": null,
    "request_authorized_at": null,
    "request_submitted_at": null,
    "requested_fmt_at": null,
    "require_expired_upload": false,
    "require_storeclosed_upload": false,
    "requires_customer_address": true,
    "return_order_id": null,
    "returned_at": null,
    "shipped_at": "2023-12-18T06:53:58.073+00:00",
    "status": "arrived",
    "store_closed_at": null,
    "storeclosed_upload_at": null,
    "total": {
      "cents": 2000,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 20,
      "label": "HK$20.00"
    },
    "updated_at": "2023-12-18T06:53:58.074Z"
  },
  "topic": "order_delivery/status_notify_customer",
  "trace_id": "52ce11a0-7b4b-4422-a3a1-c8c9076465d0",
  "ts": "1741155824798000000"
}

order_delivery/update

Topic Name:

order_delivery/update

Description:

更新訂單送貨資訊

Required Scopes in DC App Scope page:

Order - index, or;
Order - show, or;
Order - all;

Payload Example:

{
  "event": "OrderDelivery",
  "merchant_id": "657fe76b11d72b1c22fb4aaf",
  "resource": {
    "_id": "657fec07ec33fa00628a371a",
    "arrived_at": "2023-12-18T06:53:58.073+00:00",
    "collected_at": null,
    "created_at": "2023-12-18T06:51:51.829Z",
    "delivery_option_id": "657fead80abede0037de88e0",
    "delivery_status": "pending",
    "delivery_type": "custom",
    "exp_type": null,
    "id": "657fec07ec33fa00628a371a",
    "name_translations": {
      "en": "",
      "zh-hant": "Custom"
    },
    "order_id": "657fec07ec33fa00628a3714",
    "platform": "custom",
    "remark": null,
    "request_accepted_at": null,
    "request_authorized_at": null,
    "request_submitted_at": null,
    "requested_fmt_at": null,
    "require_expired_upload": false,
    "require_storeclosed_upload": false,
    "requires_customer_address": true,
    "return_order_id": null,
    "returned_at": null,
    "shipped_at": "2023-12-18T06:53:58.073+00:00",
    "status": "arrived",
    "store_closed_at": null,
    "storeclosed_upload_at": null,
    "total": {
      "cents": 2000,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 20,
      "label": "HK$20.00"
    },
    "updated_at": "2023-12-18T06:53:58.074Z"
  },
  "topic": "order_delivery/update",
  "trace_id": "7b33bd75-a81e-4120-b1fd-6661382e2ecb",
  "ts": "1741155824798000000"
}

Order Payment Related Event

order_payment/complete

Topic Name:

order_payment/complete

Description:

當訂單付款狀態改成「已付款」時

Required Scopes in DC App Scope page:

Order - index, or;
Order - show, or;
Order - all;

Trigger Point:

同時觸發 order_payment/update

Payload Example:

{
  "event": "OrderPayment",
  "merchant_id": "657fe76b11d72b1c22fb4aaf",
  "resource": {
    "_id": "657fec07ec33fa00628a3719",
    "created_at": "2023-12-18T06:51:51.793Z",
    "id": "657fec07ec33fa00628a3719",
    "last_four_digits": "",
    "name_translations": {
      "en": "Cash on Delivery",
      "zh-hant": "貨到付款"
    },
    "order_id": "657fec07ec33fa00628a3714",
    "paid_at": null,
    "payment_data": {},
    "payment_fee": {
      "cents": 1000,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 10,
      "label": "HK$10.00"
    },
    "payment_gateway": "cash_on_delivery",
    "payment_method_id": "657feab20abede003dde8822",
    "payment_slips_setting": null,
    "payment_status": "pending",
    "payment_type": "cash_on_delivery",
    "processed_at": null,
    "ref_payment_id": null,
    "status": "pending",
    "total": {
      "cents": 4000,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 40,
      "label": "HK$40.00"
    },
    "updated_at": "2023-12-18T06:51:53.389Z"
  },
  "topic": "order_payment/complete",
  "trace_id": "3370a041-910c-46c5-a741-034b599bf866",
  "ts": "1741155824798000000"
}

order_payment/refund

Topic Name:

order_payment/refund

Description:

當訂單付款狀態變成「已退款」時

Required Scopes in DC App Scope page:

Order - index, or;
Order - show, or;
Order - all;

Trigger Point:

同時觸發 order_payment/update

Payload Example:

{
  "event": "OrderPayment",
  "merchant_id": "657fe76b11d72b1c22fb4aaf",
  "resource": {
    "_id": "657fec07ec33fa00628a3719",
    "created_at": "2023-12-18T06:51:51.793Z",
    "id": "657fec07ec33fa00628a3719",
    "last_four_digits": "",
    "name_translations": {
      "en": "Cash on Delivery",
      "zh-hant": "貨到付款"
    },
    "order_id": "657fec07ec33fa00628a3714",
    "paid_at": null,
    "payment_data": {},
    "payment_fee": {
      "cents": 1000,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 10,
      "label": "HK$10.00"
    },
    "payment_gateway": "cash_on_delivery",
    "payment_method_id": "657feab20abede003dde8822",
    "payment_slips_setting": null,
    "payment_status": "pending",
    "payment_type": "cash_on_delivery",
    "processed_at": null,
    "ref_payment_id": null,
    "status": "pending",
    "total": {
      "cents": 4000,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 40,
      "label": "HK$40.00"
    },
    "updated_at": "2023-12-18T06:51:53.389Z"
  },
  "topic": "order_payment/refund",
  "trace_id": "a5c0bdff-1516-4199-8188-4941d611db51",
  "ts": "1741155824798000000"
}

order_payment/status_notify_customer

Topic Name:

order_payment/status_notify_customer

Description:

在 Admin 後台更改訂單付款狀態後，勾選「發送訂單狀態更新通知給你的顧客」並按下「是」時發送此 webhook

Required Scopes in DC App Scope page:

Order - index, or;
Order - show, or;
Order - all;

Payload Example:

{
  "event": "OrderPayment",
  "merchant_id": "657fe76b11d72b1c22fb4aaf",
  "resource": {
    "_id": "657fec07ec33fa00628a3719",
    "created_at": "2023-12-18T06:51:51.793Z",
    "id": "657fec07ec33fa00628a3719",
    "last_four_digits": "",
    "name_translations": {
      "en": "Cash on Delivery",
      "zh-hant": "貨到付款"
    },
    "order_id": "657fec07ec33fa00628a3714",
    "paid_at": null,
    "payment_data": {},
    "payment_fee": {
      "cents": 1000,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 10,
      "label": "HK$10.00"
    },
    "payment_gateway": "cash_on_delivery",
    "payment_method_id": "657feab20abede003dde8822",
    "payment_slips_setting": null,
    "payment_status": "pending",
    "payment_type": "cash_on_delivery",
    "processed_at": null,
    "ref_payment_id": null,
    "status": "pending",
    "total": {
      "cents": 4000,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 40,
      "label": "HK$40.00"
    },
    "updated_at": "2023-12-18T06:51:53.389Z"
  },
  "topic": "order_payment/status_notify_customer",
  "trace_id": "ef413da4-6d93-4143-a287-b4a20356ae0c",
  "ts": "1741155824798000000"
}

order_payment/update

Topic Name:

order_payment/update

Description:

更新訂單付款資訊

Required Scopes in DC App Scope page:

Order - index, or;
Order - show, or;
Order - all;

Trigger Point:

admin 後台更新金流狀態
cronjob 第三方金流更新金流狀態

Payload Example:

{
  "event": "OrderPayment",
  "merchant_id": "657fe76b11d72b1c22fb4aaf",
  "resource": {
    "_id": "657fec07ec33fa00628a3719",
    "created_at": "2023-12-18T06:51:51.793Z",
    "id": "657fec07ec33fa00628a3719",
    "last_four_digits": "",
    "name_translations": {
      "en": "Cash on Delivery",
      "zh-hant": "貨到付款"
    },
    "order_id": "657fec07ec33fa00628a3714",
    "paid_at": null,
    "payment_data": {},
    "payment_fee": {
      "cents": 1000,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 10,
      "label": "HK$10.00"
    },
    "payment_gateway": "cash_on_delivery",
    "payment_method_id": "657feab20abede003dde8822",
    "payment_slips_setting": null,
    "payment_status": "pending",
    "payment_type": "cash_on_delivery",
    "processed_at": null,
    "ref_payment_id": null,
    "status": "pending",
    "total": {
      "cents": 4000,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 40,
      "label": "HK$40.00"
    },
    "updated_at": "2023-12-18T06:51:53.389Z"
  },
  "topic": "order_payment/update",
  "trace_id": "975d4ee1-77d1-4a5b-ac57-e539bd98925e",
  "ts": "1741155824798000000"
}

Persistent cart Related Event

persistent_cart/abandoned_cart

Topic Name:

persistent_cart/abandoned_cart

Required Scopes in DC App Scope page:

Persistent Carts - index, or
Persistent Carts - all;

Trigger Point:

cronjob 每15 分鐘執行一次
若店家有開啟 abandoned_cart_notification，會取得閒置 1~2 天且還沒轉換過的 shop session，轉換為 persistent cart 並觸發 webhook

Payload Example:

{
  "event": "PersistentCart",
  "merchant_id": "657fe76b11d72b1c22fb4aaf",
  "resource": {
    "customer_id": null,
    "email": null,
    "id": "6580034eec33fa001a7fde5c",
    "items": [],
    "mobile_phone": null,
    "shop_session_id": "123123"
  },
  "topic": "persistent_cart/abandoned_cart",
  "trace_id": "46cab349-4a72-4360-8e0a-7e67a60e6c10",
  "ts": "1741155824798000000"
}

Product Related Event

product/create

Topic Name:

product/create

Description:

商品建立時

Required Scopes in DC App Scope page:

Products - index, or;
Products - show, or;
Products - all;

Trigger Point:

商品建立

Payload Example:

{
  "event": "Product",
  "merchant_id": "657fe76b11d72b1c22fb4aaf",
  "resource": {
    "adult": "no",
    "age_group": "all_ages",
    "available_end_time": null,
    "available_start_time": null,
    "barcode": null,
    "barcode_type": "Code 128",
    "blacklisted_delivery_option_ids": [],
    "blacklisted_feed_channels": [],
    "blacklisted_payment_ids": [],
    "brand": null,
    "bundle_set": null,
    "categories": [
      {
        "banner_medias": [],
        "children": [],
        "created_by": "admin",
        "id": "657fe76f4abe6c003e3ddd1e",
        "key": "featured_products",
        "name_translations": {
          "de": "Empfohlene Produkte",
          "en": "Featured Products",
          "fr": "Produits à la une",
          "id": "Produk Unggulan",
          "ja": "おすすめ商品",
          "ms": "Produk Terpilih",
          "th": "สินค้าแนะนำ",
          "vi": "Sản phẩm nổi bật",
          "zh-cn": "精选商品",
          "zh-hant": "精選商品",
          "zh-hk": "精選商品",
          "zh-tw": "精選商品"
        },
        "parent_id": null,
        "priority": 1,
        "seo_description_translations": {},
        "seo_keywords": null,
        "seo_title_translations": {},
        "sort_setting": null,
        "status": "active"
      }
    ],
    "category_ids": [
      "657fe76f4abe6c003e3ddd1e"
    ],
    "condition": "new",
    "cost": {
      "cents": 0,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 0,
      "label": "HK$0.00"
    },
    "created_at": "2023-12-18T06:44:36.775Z",
    "created_by": "admin",
    "description_translations": {
      "en": "",
      "zh-hant": "Production Description"
    },
    "detail_medias": [],
    "feed_category": {},
    "feed_variations": {},
    "field_titles": [],
    "filter_tags": [],
    "flash_price_sets": [
      {
        "created_at": "2023-12-18T08:41:00.956Z",
        "end_at": "2023-12-31T08:00:00.000+00:00",
        "id": "67c7f0b4963a310848c2841e",
        "price_set": {
          "channel_id": null,
          "created_at": "2023-12-18T08:41:00.874Z",
          "flash_price_campaign_id": "6580059c0abede003dde8828",
          "id": "6580059c0abede003dde8829",
          "price": {
            "cents": 1000,
            "currency_iso": "HKD",
            "currency_symbol": "HK$",
            "dollars": 10,
            "label": "HK$10.00"
          },
          "price_details": [],
          "price_sale": {
            "cents": 900,
            "currency_iso": "HKD",
            "currency_symbol": "HK$",
            "dollars": 9,
            "label": "HK$9.00"
          },
          "status": "active",
          "type": "flash_price",
          "updated_at": "2023-12-18T08:41:00.874Z"
        },
        "start_at": "2023-12-18T08:00:00.331+00:00",
        "updated_at": "2023-12-18T08:41:00.956Z"
      }
    ],
    "gender": "unisex",
    "gtin": "10122190",
    "hide_price": false,
    "id": "657fea540abede0037de88da",
    "is_excluded_promotion": false,
    "is_preorder": false,
    "is_reminder_active": false,
    "labels": [],
    "link": "/product",
    "location_id": null,
    "locked_inventory_count": 0,
    "lowest_price": {
      "cents": 1000,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 10,
      "label": "HK$10.00"
    },
    "lowest_price_sale": {
      "cents": 0,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 0,
      "label": ""
    },
    "max_order_quantity": -1,
    "medias": [
      {
        "_id": "657fea3f0abede003dde8821",
        "alt_translations": {},
        "blurhash": "UVRysgRj%Mxut7ayofj[~qt7IURj%Mj[WBay",
        "images": {
          "favicon": {
            "height": 250,
            "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
            "width": 800
          },
          "favicon_large": {
            "height": 250,
            "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
            "width": 800
          },
          "favicon_small": {
            "height": 250,
            "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
            "width": 800
          },
          "original": {
            "height": 250,
            "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
            "width": 800
          },
          "source": {
            "height": 250,
            "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
            "width": 800
          },
          "thumb": {
            "height": 250,
            "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
            "width": 800
          },
          "transparent_large": {
            "height": 250,
            "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
            "width": 800
          },
          "transparent_thumb": {
            "height": 250,
            "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
            "width": 800
          },
          "transparent_xlarge": {
            "height": 250,
            "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
            "width": 800
          }
        }
      }
    ],
    "member_price": {
      "cents": 0,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 0,
      "label": "HK$0.00"
    },
    "mpn": null,
    "out_of_stock_orderable": false,
    "oversea_tax_type": null,
    "preorder_limit": -1,
    "preorder_note_translations": {},
    "price": {
      "cents": 1000,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 10,
      "label": "HK$10.00"
    },
    "price_sale": {
      "cents": 0,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 0,
      "label": "HK$0.00"
    },
    "product_price_tiers": [],
    "quantity": 0,
    "related_product_ids": [],
    "retail_status": "active",
    "same_price": false,
    "schedule_publish_at": null,
    "seo_description_translations": {
      "en": "",
      "zh-hant": "Production Description"
    },
    "seo_keywords": null,
    "seo_title_translations": {
      "en": "Product"
    },
    "show_custom_related_products": false,
    "sku": null,
    "status": "active",
    "subscription_enabled": false,
    "subscription_period_duration": 7,
    "subscription_recurring_count_limit": -1,
    "summary_translations": {
      "en": "",
      "zh-hant": "Product Summary"
    },
    "supplier": null,
    "tags": [],
    "tax_type": null,
    "taxable": false,
    "title_translations": {
      "en": "Product"
    },
    "total_orderable_quantity": -1,
    "type": "product",
    "unlimited_quantity": true,
    "updated_at": "2023-12-18T08:41:00.956Z",
    "variant_options": [],
    "variations": [],
    "weight": 0
  },
  "topic": "product/create",
  "trace_id": "98a1f8bd-936b-42ac-a42f-a3b809e208e0",
  "ts": "1741155824798000000"
}

product/remove

Topic Name:

product/remove

Description:

商品被刪除時(普通商品、組合商品刪除會觸發)

Required Scopes in DC App Scope page:

Products - index, or;
Products - show, or;
Products - all;

Trigger Point:

商品删除

Payload Example:

{
  "event": "Product",
  "merchant_id": "657fe76b11d72b1c22fb4aaf",
  "resource": {
    "adult": "no",
    "age_group": "all_ages",
    "available_end_time": null,
    "available_start_time": null,
    "barcode": null,
    "barcode_type": "Code 128",
    "blacklisted_delivery_option_ids": [],
    "blacklisted_feed_channels": [],
    "blacklisted_payment_ids": [],
    "brand": null,
    "categories": [
      {
        "banner_medias": [],
        "created_by": "admin",
        "id": "657fe76f4abe6c003e3ddd1e",
        "key": "featured_products",
        "name_translations": {
          "de": "Empfohlene Produkte",
          "en": "Featured Products",
          "fr": "Produits à la une",
          "id": "Produk Unggulan",
          "ja": "おすすめ商品",
          "ms": "Produk Terpilih",
          "th": "สินค้าแนะนำ",
          "vi": "Sản phẩm nổi bật",
          "zh-cn": "精选商品",
          "zh-hant": "精選商品",
          "zh-hk": "精選商品",
          "zh-tw": "精選商品"
        },
        "parent_id": null,
        "priority": 1,
        "seo_description_translations": {},
        "seo_keywords": null,
        "seo_title_translations": {},
        "status": "active"
      }
    ],
    "category_ids": [
      "657fe76f4abe6c003e3ddd1e"
    ],
    "condition": "new",
    "cost": {
      "cents": 0,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 0,
      "label": "HK$0.00"
    },
    "created_at": "2023-12-18T06:44:36.775Z",
    "created_by": "admin",
    "description_translations": {
      "en": "",
      "zh-hant": "Production Description"
    },
    "detail_medias": [],
    "feed_category": {},
    "feed_variations": {},
    "field_titles": [],
    "filter_tags": [],
    "flash_price_sets": [
      {
        "created_at": "2023-12-18T08:41:00.956Z",
        "end_at": "2023-12-31T08:00:00.000+00:00",
        "id": "67c7f0bc4fdc4500090c8211",
        "price_set": {
          "channel_id": null,
          "created_at": "2023-12-18T08:41:00.874Z",
          "flash_price_campaign_id": "6580059c0abede003dde8828",
          "id": "6580059c0abede003dde8829",
          "price": {
            "cents": 1000,
            "currency_iso": "HKD",
            "currency_symbol": "HK$",
            "dollars": 10,
            "label": "HK$10.00"
          },
          "price_details": [],
          "price_sale": {
            "cents": 900,
            "currency_iso": "HKD",
            "currency_symbol": "HK$",
            "dollars": 9,
            "label": "HK$9.00"
          },
          "status": "active",
          "type": "flash_price",
          "updated_at": "2023-12-18T08:41:00.874Z"
        },
        "start_at": "2023-12-18T08:00:00.331+00:00",
        "updated_at": "2023-12-18T08:41:00.956Z"
      }
    ],
    "gender": "unisex",
    "gtin": "10122190",
    "hide_price": false,
    "id": "657fea540abede0037de88da",
    "is_excluded_promotion": false,
    "is_preorder": false,
    "is_reminder_active": false,
    "link": "/product",
    "location_id": null,
    "lowest_price": {
      "cents": 1000,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 10,
      "label": "HK$10.00"
    },
    "lowest_price_sale": {
      "cents": 0,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 0,
      "label": ""
    },
    "max_order_quantity": -1,
    "medias": [
      {
        "_id": "657fea3f0abede003dde8821",
        "alt_translations": {},
        "blurhash": "UVRysgRj%Mxut7ayofj[~qt7IURj%Mj[WBay",
        "images": {
          "favicon": {
            "height": 250,
            "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
            "width": 800
          },
          "favicon_large": {
            "height": 250,
            "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
            "width": 800
          },
          "favicon_small": {
            "height": 250,
            "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
            "width": 800
          },
          "original": {
            "height": 250,
            "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
            "width": 800
          },
          "source": {
            "height": 250,
            "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
            "width": 800
          },
          "thumb": {
            "height": 250,
            "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
            "width": 800
          },
          "transparent_large": {
            "height": 250,
            "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
            "width": 800
          },
          "transparent_thumb": {
            "height": 250,
            "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
            "width": 800
          },
          "transparent_xlarge": {
            "height": 250,
            "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
            "width": 800
          }
        }
      }
    ],
    "member_price": {
      "cents": 0,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 0,
      "label": "HK$0.00"
    },
    "mpn": null,
    "out_of_stock_orderable": false,
    "oversea_tax_type": null,
    "preorder_limit": -1,
    "preorder_note_translations": {},
    "price": {
      "cents": 1000,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 10,
      "label": "HK$10.00"
    },
    "price_sale": {
      "cents": 0,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 0,
      "label": "HK$0.00"
    },
    "quantity": 0,
    "related_product_ids": [],
    "retail_status": "active",
    "same_price": false,
    "schedule_publish_at": null,
    "seo_description_translations": {
      "en": "",
      "zh-hant": "Production Description"
    },
    "seo_keywords": null,
    "seo_title_translations": {
      "en": "Product"
    },
    "show_custom_related_products": false,
    "sku": null,
    "status": "active",
    "subscription_enabled": false,
    "subscription_period_duration": 7,
    "subscription_recurring_count_limit": -1,
    "summary_translations": {
      "en": "",
      "zh-hant": "Product Summary"
    },
    "supplier": null,
    "tags": [],
    "tax_type": null,
    "taxable": false,
    "title_translations": {
      "en": "Product"
    },
    "total_orderable_quantity": -1,
    "unlimited_quantity": true,
    "updated_at": "2023-12-18T08:41:00.956Z",
    "variant_options": [],
    "variations": [],
    "weight": 0
  },
  "topic": "product/remove",
  "trace_id": "74013f5c-fcbf-4695-9a83-e3d24afc11f9",
  "ts": "1741155824798000000"
}

product/update

Topic Name:

product/update

Description:

商品更新 (庫存更新也會觸發)

Required Scopes in DC App Scope page:

Products - index, or;
Products - show, or;
Products - all;

Trigger Point:

商品更新

Payload Example:

{
  "event": "Product",
  "merchant_id": "657fe76b11d72b1c22fb4aaf",
  "resource": {
    "adult": "no",
    "age_group": "all_ages",
    "available_end_time": null,
    "available_start_time": null,
    "barcode": null,
    "barcode_type": "Code 128",
    "blacklisted_delivery_option_ids": [],
    "blacklisted_feed_channels": [],
    "blacklisted_payment_ids": [],
    "brand": null,
    "bundle_set": null,
    "categories": [
      {
        "banner_medias": [],
        "children": [],
        "created_by": "admin",
        "id": "657fe76f4abe6c003e3ddd1e",
        "key": "featured_products",
        "name_translations": {
          "de": "Empfohlene Produkte",
          "en": "Featured Products",
          "fr": "Produits à la une",
          "id": "Produk Unggulan",
          "ja": "おすすめ商品",
          "ms": "Produk Terpilih",
          "th": "สินค้าแนะนำ",
          "vi": "Sản phẩm nổi bật",
          "zh-cn": "精选商品",
          "zh-hant": "精選商品",
          "zh-hk": "精選商品",
          "zh-tw": "精選商品"
        },
        "parent_id": null,
        "priority": 1,
        "seo_description_translations": {},
        "seo_keywords": null,
        "seo_title_translations": {},
        "sort_setting": null,
        "status": "active"
      }
    ],
    "category_ids": [
      "657fe76f4abe6c003e3ddd1e"
    ],
    "condition": "new",
    "cost": {
      "cents": 0,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 0,
      "label": "HK$0.00"
    },
    "created_at": "2023-12-18T06:44:36.775Z",
    "created_by": "admin",
    "description_translations": {
      "en": "",
      "zh-hant": "Production Description"
    },
    "detail_medias": [],
    "feed_category": {},
    "feed_variations": {},
    "field_titles": [],
    "filter_tags": [],
    "flash_price_sets": [
      {
        "created_at": "2023-12-18T08:41:00.956Z",
        "end_at": "2023-12-31T08:00:00.000+00:00",
        "id": "67c7f0b4963a310848c2841e",
        "price_set": {
          "channel_id": null,
          "created_at": "2023-12-18T08:41:00.874Z",
          "flash_price_campaign_id": "6580059c0abede003dde8828",
          "id": "6580059c0abede003dde8829",
          "price": {
            "cents": 1000,
            "currency_iso": "HKD",
            "currency_symbol": "HK$",
            "dollars": 10,
            "label": "HK$10.00"
          },
          "price_details": [],
          "price_sale": {
            "cents": 900,
            "currency_iso": "HKD",
            "currency_symbol": "HK$",
            "dollars": 9,
            "label": "HK$9.00"
          },
          "status": "active",
          "type": "flash_price",
          "updated_at": "2023-12-18T08:41:00.874Z"
        },
        "start_at": "2023-12-18T08:00:00.331+00:00",
        "updated_at": "2023-12-18T08:41:00.956Z"
      }
    ],
    "gender": "unisex",
    "gtin": "10122190",
    "hide_price": false,
    "id": "657fea540abede0037de88da",
    "is_excluded_promotion": false,
    "is_preorder": false,
    "is_reminder_active": false,
    "labels": [],
    "link": "/product",
    "location_id": null,
    "locked_inventory_count": 0,
    "lowest_price": {
      "cents": 1000,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 10,
      "label": "HK$10.00"
    },
    "lowest_price_sale": {
      "cents": 0,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 0,
      "label": ""
    },
    "max_order_quantity": -1,
    "medias": [
      {
        "_id": "657fea3f0abede003dde8821",
        "alt_translations": {},
        "blurhash": "UVRysgRj%Mxut7ayofj[~qt7IURj%Mj[WBay",
        "images": {
          "favicon": {
            "height": 250,
            "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
            "width": 800
          },
          "favicon_large": {
            "height": 250,
            "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
            "width": 800
          },
          "favicon_small": {
            "height": 250,
            "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
            "width": 800
          },
          "original": {
            "height": 250,
            "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
            "width": 800
          },
          "source": {
            "height": 250,
            "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
            "width": 800
          },
          "thumb": {
            "height": 250,
            "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
            "width": 800
          },
          "transparent_large": {
            "height": 250,
            "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
            "width": 800
          },
          "transparent_thumb": {
            "height": 250,
            "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
            "width": 800
          },
          "transparent_xlarge": {
            "height": 250,
            "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/657fea3f0abede003dde8821/original.png?1702881855",
            "width": 800
          }
        }
      }
    ],
    "member_price": {
      "cents": 0,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 0,
      "label": "HK$0.00"
    },
    "mpn": null,
    "out_of_stock_orderable": false,
    "oversea_tax_type": null,
    "preorder_limit": -1,
    "preorder_note_translations": {},
    "price": {
      "cents": 1000,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 10,
      "label": "HK$10.00"
    },
    "price_sale": {
      "cents": 0,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 0,
      "label": "HK$0.00"
    },
    "product_price_tiers": [],
    "quantity": 0,
    "related_product_ids": [],
    "retail_status": "active",
    "same_price": false,
    "schedule_publish_at": null,
    "seo_description_translations": {
      "en": "",
      "zh-hant": "Production Description"
    },
    "seo_keywords": null,
    "seo_title_translations": {
      "en": "Product"
    },
    "show_custom_related_products": false,
    "sku": null,
    "status": "active",
    "subscription_enabled": false,
    "subscription_period_duration": 7,
    "subscription_recurring_count_limit": -1,
    "summary_translations": {
      "en": "",
      "zh-hant": "Product Summary"
    },
    "supplier": null,
    "tags": [],
    "tax_type": null,
    "taxable": false,
    "title_translations": {
      "en": "Product"
    },
    "total_orderable_quantity": -1,
    "type": "product",
    "unlimited_quantity": true,
    "updated_at": "2023-12-18T08:41:00.956Z",
    "variant_options": [],
    "variations": [],
    "weight": 0
  },
  "topic": "product/update",
  "trace_id": "73e9c694-b974-40b5-b1d9-533b285da140",
  "ts": "1741155824798000000"
}

product/inventory_update

Topic Name:

product/inventory_update

Description:

更新商品庫存時觸發

Trigger Point:

更新商品库存

stock/update

Topic Name:

stock/update

Description:

更新商品庫存时觸發

Trigger Point:

更新库存

Product Review Comments Related Event

product_review_comment/create

Topic Name:

product_review_comment/create

Description:

商品評價

Required Scopes in DC App Scope page:

Product Review Comments - index, or
Product Review Comments - show;
Product Review Comments - all;

Trigger Point:

顾客評價
新增自建評價

Payload Example:

{
  "event": "ProductReviewComment",
  "merchant_id": "64febd4bb0ff211d706e6a18",
  "resource": {
    "comment": "产品精美，朋友很喜欢",
    "commented_at": "2026-01-14T09:01:29.589+00:00",
    "created_at": "2026-01-14T09:01:29.601Z",
    "created_by": "shop",
    "id": "69675b69cff968003ec015eb",
    "media": [
      {
        "_id": "69675b676db6c5004c71f7d3",
        "alt_translations": {},
        "blurhash": "UzI=ZBj[~poeyFa}V?oLx^ayWAoeozayjsj[",
        "images": {
          "original": {
            "height": 120,
            "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/69675b676db6c5004c71f7d3/original.jpg?1768381286=&owner_id=64febd4bb0ff211d706e6a18",
            "width": 120
          }
        }
      }
    ],
    "merchant_id": "64febd4bb0ff211d706e6a18",
    "order_id": "69675b186db6c5004c71f7c4",
    "product_id": "6964c63ef0fc32003bf4724d",
    "score": 5,
    "status": "active",
    "updated_at": "2026-01-14T09:01:29.601Z",
    "user_id": "6960c161f7bacc000e4b02b3",
    "user_name": "hacken"
  },
  "topic": "product_review_comment/create",
  "trace_id": "c9983c4b-14dc-4717-9b9f-11a2983e60c6",
  "ts": "1768381289621578000"
}

Promotion Related Event

promotion/redeeem

Topic Name:

promotion/redeeem

Description:

當顧客成立訂單時，通知訂單上的 coupon code 已經使用

Required Scopes in DC App Scope page:

User Coupons redeem

Trigger Point:

EC 單車下單
EC 多車下單
POS 下單
POS 預購單
POS 退貨單取消
SOMO 核銷 coupon

Payload Example:

{
  "coupon_code": "ea26471b",
  "customer_id": "61017c71b52d753feb6a69e7",
  "merchant_id": "60eeb3fee7812d00400a4b0f",
  "redeemed_at": "2022-08-22T10:36:22.330+00:00",
  "topic": "promotion/redeem",
  "event": "Promotion",
  "merchant_handle": "pattytw2",
  "resource": {
    "id": "62cbedd35a58fc00402a4bcc",
    "discount_percentage": null,
    "discount_amount": null,
    "discountable_quantity": null,
    "discounted_point": null,
    "discounted_price": {
      "cents": 288,
      "currency_symbol": "NT$",
      "currency_iso": "TWD",
      "label": "NT$288",
      "dollars": 288
    },
    "discountable_product_ids": [
      "62c695159e36d1004326da4b",
      "62c694fd9e36d1004926dc66"
    ],
    "discountable_category_ids": [],
    "conditions": [
      {
        "_id": "62cbedd35a58fc00402a4bcb",
        "blacklisted_product_ids": [],
        "created_at": "2022-07-11T09:31:00.009Z",
        "min_item_count": 3,
        "min_price": null,
        "promotion_id": "62cbedd35a58fc00402a4bcc",
        "status": "active",
        "subscription_period": null,
        "type": null,
        "updated_at": "2022-08-09T02:39:03.436Z",
        "whitelisted_category_ids": [],
        "whitelisted_product_ids": [
          "62c695159e36d1004326da4b",
          "62c694fd9e36d1004926dc66"
        ]
      }
    ],
    "discount_on": "item",
    "discount_type": "bundle_pricing",
    "is_accumulated": true,
    "codes": [],
    "requires_membership": false,
    "whitelisted_membership_tier_ids": [],
    "membership_tier_id": null,
    "whitelisted_tag_contents": [],
    "user_max_use_count": 0,
    "max_use_count": null,
    "use_count": 1,
    "whitelisted_delivery_option_ids": [
      "60ffe368631bfb0045e826b2",
      "619b24191cd727004cfc683e",
      "61b1db9824083200422d6108",
      "619df0b806368670f1664ded",
      "619df08d063686707a664ded",
      "61713053819af0004345e1ff",
      "6177dab1819af0538b45e177",
      "6170de74819af0004645e19c",
      "6170e123819af0004c45e19c",
      "6178fc49819af0630445e18a",
      "6177dce3819af0624745e166",
      "62e118b8eb83632e00d2bb53",
      "62fdf0ae91dec200498684bf"
    ],
    "whitelisted_payment_ids": [
      "617faba6feede154e09ed0f3",
      "60ffe3a6631bfb0045e826b5",
      "6177db99819af0534045e16f",
      "61b85817af7a4e00437bb1ed",
      "61b857a5af7a4e00437bb1ec",
      "61b1db9824083200422d6109",
      "610a4cc1d867170042478637",
      "61eead7716640500381668a7",
      "62fdf0d591dec200438684c4"
    ],
    "start_at": "2022-07-11T09:00:00.000+00:00",
    "end_at": null,
    "created_at": "2022-07-11T09:30:59.965Z",
    "updated_at": "2022-08-18T07:57:09.920Z",
    "status": "active",
    "first_purchase_only": false,
    "show_coupon": false,
    "for_affiliate_campaign": false,
    "title_translations": {
      "zh-hant": "任選多階 領取型"
    },
    "available_platforms": [
      "ec"
    ],
    "extended_promotion_id": null,
    "coupon_type": "draw",
    "coupon_generated_by": "system",
    "drew_coupon_count": 2
  }
}

Subscription Record Related Event

subscription_record/end

Topic Name:

subscription_record/end

Description:

app 訂閱完結 (from sub9 -> eventCenter -> DC)

Required Scopes in DC App Scope page:

no scope is required

Trigger Point:

When a recurring app subscription ends
When main / app subscription grace period ends

Payload Example:

{
  "event": "SubscriptionRecord",
  "merchant_id": "657fe76b11d72b1c22fb4aaf",
  "resource": {
    "id": "65800a7e5e4bfd478c70d55c"
  },
  "topic": "subscription_record/end",
  "trace_id": "b6c74de5-aa87-4011-9a2e-733843337ab8",
  "ts": "1741146106262000000"
}

subscription_record/start

Topic Name:

subscription_record/start

Description:

每次 app 訂閱開始 (from sub9 -> eventCenter -> DC)

Required Scopes in DC App Scope page:

no scope is required

Trigger Point:

When a user begins a paid app subscription
When a user converts from the free trial to a paid app subscription
When a recurring app subscription starts a new iteration
When a user begins a custom subscription.

Payload Example:

{
  "event": "SubscriptionRecord",
  "merchant_id": "657fe76b11d72b1c22fb4aaf",
  "resource": {
    "id": "65800a7e5e4bfd478c70d55c"
  },
  "topic": "subscription_record/start",
  "trace_id": "284c7b6b-8dbe-4265-8b45-670b8f9d2db4",
  "ts": "1741146106262000000"
}

Tag Related Event

tag/create

Topic Name:

tag/create

Required Scopes in DC App Scope page:

Tags - index, or
Tags - all;

Trigger Point:

Admin adds tags to customer (single or bulk)
Admin bulk imports users with tags
Third-party app adds tags via Open API Node (PUT or PATCH /customers/:id/tags)

Payload Example:

{
  "event": "Tag",
  "merchant_id": "657fe76b11d72b1c22fb4aaf",
  "resource": {
    "content": "test_c_tag",
    "id": "657fef0e0abede0037de88e4",
    "merchant_id": "657fe76b11d72b1c22fb4aaf",
    "owner_id": "657feb68a7cb17eff1a7ce36",
    "owner_type": "User"
  },
  "topic": "tag/create",
  "trace_id": "a05ab47b-8df2-42aa-b432-7ed9ca992c6f",
  "ts": "1741155824798000000"
}

tag/remove

Topic Name:

tag/remove

Required Scopes in DC App Scope page:

Tags - index, or
Tags - all;

Trigger Point:

Admin removes tags from customer (single or bulk)
Third-party app removes tags via Open API Node (PATCH with update_mode: 'remove')
Third-party app replaces all tags (PUT - removes old tags not in new list)
Customer status changes to 'removed' (all tags auto-removed)

Payload Example:

{
  "event": "Tag",
  "merchant_id": "657fe76b11d72b1c22fb4aaf",
  "resource": {
    "content": "test_c_tag",
    "id": "657fef0e0abede0037de88e4",
    "merchant_id": "657fe76b11d72b1c22fb4aaf",
    "owner_id": "657feb68a7cb17eff1a7ce36",
    "owner_type": "User"
  },
  "topic": "tag/remove",
  "trace_id": "b6ec9934-293f-4255-98bc-521f6948d29c",
  "ts": "1741155824798000000"
}

User Credit Related Event

user_credit/create

Topic Name:

user_credit/create

Description:

購物金建立時

Required Scopes in DC App Scope page:

User Credits - index, or
User Credits - all;

Payload Example:

{
  "event": "UserCredit",
  "merchant_id": "657fe76b11d72b1c22fb4aaf",
  "resource": {
    "created_at": "2023-12-18T07:17:37.571Z",
    "credit_balance": 10,
    "end_at": null,
    "id": "657ff2114abe6c003b3ddd2a",
    "is_redeem": false,
    "order_id": null,
    "order_wapos_id": null,
    "performer_id": "62958ab88002080035f8bb5a",
    "performer_name": "bookstore",
    "remarks": "test",
    "status": "active",
    "type": "manual_credit",
    "user_credit_rule_id": null,
    "user_id": "657feb68a7cb17eff1a7ce36",
    "value": 10,
    "value_dollar": {
      "cents": 1000,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 10,
      "label": "HK$10.00"
    }
  },
  "topic": "user_credit/create",
  "trace_id": "16c4fe9a-8ab0-4feb-8d51-ae0545cdb91d",
  "ts": "1741155824798000000"
}

user_credit/update

Topic Name:

user_credit/update

Description:

購物金更新時

Required Scopes in DC App Scope page:

User Credits - index, or
User Credits - all;

Payload Example:

{
  "event": "UserCredit",
  "merchant_id": "657fe76b11d72b1c22fb4aaf",
  "resource": {
    "created_at": "2023-12-18T07:17:37.571Z",
    "credit_balance": 10,
    "end_at": null,
    "id": "657ff2114abe6c003b3ddd2a",
    "is_redeem": false,
    "order_id": null,
    "order_wapos_id": null,
    "performer_id": "62958ab88002080035f8bb5a",
    "performer_name": "bookstore",
    "remarks": "test",
    "status": "active",
    "type": "manual_credit",
    "user_credit_rule_id": null,
    "user_id": "657feb68a7cb17eff1a7ce36",
    "value": 10,
    "value_dollar": {
      "cents": 1000,
      "currency_iso": "HKD",
      "currency_symbol": "HK$",
      "dollars": 10,
      "label": "HK$10.00"
    }
  },
  "topic": "user_credit/update",
  "trace_id": "013bb91a-3bdc-489b-a9ef-dac21c102885",
  "ts": "1741155824798000000"
}

Warehouse Related Event

warehouse/create

Topic Name:

warehouse/create

Description:

倉庫建立

Trigger Point:

倉庫建立时

Payload Example:

{
  "event": "Warehouse",
  "merchant_id": "64febd4bb0ff211d706e6a18",
  "resource": {
    "created_at": "2026-01-14T07:06:08.585Z",
    "id": "6967406077d7360052976766",
    "key": null,
    "name_translations": {
      "en": "黄金袋"
    },
    "organization_id": "64febd8a674ffe001accf210",
    "status": "active",
    "updated_at": "2026-01-14T07:09:30.478Z"
  },
  "topic": "warehouse/create",
  "trace_id": "51d3bf92-4bfe-47b2-84cb-d77f69966878",
  "ts": "1768374570497943800"
}