API Reference

API ServerStatus In Service

https://openapi.customeow.io/v1/

Explore our API documentation and examples to integrate into your application or workflow.

Rate limit method: The maximum number of requests that can be sent per minute with the same key. For example, there are 60 API requests in 60 seconds. Every request is equally important no matter how much data is returned.

Get your API Key

API Key

Get store id

guide-get-store-id

Get custom feature V1

https://client.customeow.io/[lang]?storeId={storeId}&sku={sku}&addCartButtonText={addCartButtonText}
Embed an iframe element to access the custom feature page.
It is recommended to set the width and height of the iframe element to 100%.

Query Parameters

storeId*string

Store ID

Example:122993486726201345

sku*string

SKU

Example:api-demo-sku

addCartButtonTextstring

Customize add cart button text

Example:Add to Cart

Path Parameters

langstring

Page language

Example:en

LanguageLang code
English (United States)en
Germande
Frenchfr
Portuguese (Brazil)pt-br
Spanishes
Japaneseja
Italianit
Dutchnl
Traditional Chinesezh-tw
Simplified Chinesezh-cn
Hebrew (Israel)he
Russianru
Arabicar
Thaith
Indonesianid
Turkishtr
Vietnamesevi
Swedishsv
Polishpl
Portuguesept-pt
Koreanko
Greekel-gr
Czechcs-cz
Romanianro
Slovaksk
Hungarianhu
Bulgarianbg

iframe

Example:

Iframe embed code example

<iframe src="https://client.customeow.io/en?storeId=122993486726201345&sku=api-demo-sku"></iframe>
Preview

Events

Using window.addEventListener("message", receiveMessage) you can listen for events sent to the custom page.
Related events:
Event nameDescriptionData
customeow:mountMount eventNone
customeow:closeClose eventNone
customeow:confirmConfirm eventcustomInfoId: custom data id, preview: preview data, stores: custom data
customeow:errorError eventNone
customeow:reloadReload eventNone
Example:
1
2    window.addEventListener('message', (event) => {
3
4      if (event.data.type === 'customeow:mount') {
5        console.log('🚀 ~  : customeow:mount');
6      }
7
8      if (event.data.type === 'customeow:confirm') {
9        console.log('🚀 ~  : customeow:confirm', event.data);
10      }
11
12      if (event.data.type === 'customeow:close') {
13        console.log('🚀 ~  : customeow:close');
14      }
15
16      if (event.data.type === 'customeow:error') {
17        console.log('🚀 ~  : customeow:error');
18      }
19
20    });
21
22
23    const iframe = document.getElementById('iframe');
24
25    const message = {
26      type: 'customeow:reload',
27      data: undefined,
28    };
29
30    iframe.contentWindow.postMessage(message, '*');
31
32            

Create order V1

POST/order
Create an order in CustomMeow

Request

Security: API Key

An API key is a token that you provide when making API calls. Include the token in a header parameter calledX-Api-Key

Example:X-Api-Key:123456789

Data

FieldTypeRequiredDescription
storeIdstringYesStore id
platformOrderIdstringYesPlatform order id
platformOrderNostringYesPlatform order number
platformCreatedAtstringYesPlatform order creation time (ISO 8601 format)
currencyCodestringYesThe three-letter code (ISO 4217 format) for the shop currency
lineItemsobject[]YesA list of order items
skustringYesYes
customInfoIdstringYesCustom data id
platformItemIdstringYesPlatform order item id
platformProductIdstringYesPlatform product id
platformProductTitlestringYesPlatform product title
platformVariantTitlestringYesPlatform variant title
platformVariantIdstringYesPlatform variant id
platformProductImagestringNoPlatform product pictures
quantitynumberNoPurchase quantity
pricestringNoPlatform product selling price

Response

200400404401
OK
codenumber

Response status code

Example:

0

messagestring

Response description

Example:

OK

dataobject

Response data

idstring

Store order ID

Example:

173849875337719809

Request
POST/order
1curl -X POST -H "Content-Type: application/json" -H "X-Api-Key: 123456789" -d '{
2  "storeId": "212517125472956417",
3  "platformOrderId": "62758597430",
4  "platformOrderNo": "D1001",
5  "platformCreatedAt": "2025-02-20T03:07:42-05:00",
6  "currencyCode": "USD",
7  "lineItems": [
8    {
9      "sku": "test-sku",
10      "customInfoId": "53424155105734656",
11      "platformItemId": "62758597530",
12      "platformProductId": "453695684",
13      "platformProductTitle": "Big Brown Bear Boots111",
14      "platformVariantTitle": "Default",
15      "platformVariantId": "6958596542",
16      "platformProductImage": "https://oss-us-east.staticmeow.com/customeow/static/example/demo.jpg",
17      "quantity": 1,
18      "price": "20.23"
19    }
20  ]
21}' \
22  https://openapi.customeow.io/v1/order
Response
1{
2  "code": 0,
3  "message": "OK",
4  "data": {
5    "id": "173849875337719809",
6  }
7}

Get order list V1

GET/order
Query order list

Request

Security: API Key

An API key is a token that you provide when making API calls. Include the token in a header parameter calledX-Api-Key

Example:X-Api-Key:123456789

Query Parameters

startTimestring

Date filter start time

Example:2023-09-01T12:00:00+08:00

endTimestring

Date filter end time

Example:2023-09-01T12:00:00+08:00

pagestring

Page number

Example:1

pageSizestring

Total number of pages

Example:10

storeIdsstring

Retrieve only orders specified by a comma-separated list of store IDs

Example:179639630637846528,279639630637846526

Response

200400500404
OK
codenumber

Response status code

Example:

0

messagestring

Response description

Example:

OK

dataobject

Response data

countnumber

Total quantity

Example:

1

listobject[]

Order list

idstring

ID

Example:

173849875337719809

orderIdstring

Store order ID

Example:

173849875337719808

platformOrderNostring

Third party order number

Example:

3043654050207435

platformOrderIdstring

Third party order ID

Example:

3043654050207435

platformCreatedAtstring

Order creation time

Example:

2024-10-26T09:51:53Z

skustring

SKU

Example:

ALIBXT0P152X04

customIdstring

Customization feature ID

Example:

103237991190757376

customInfoIdstring

Customization info ID

Example:

0

customVersionstring

Customization version

Example:

0

platformItemIdstring

Third party platform item ID

Example:

3043654050217435

platformProductIdstring

Third party platform product ID

Example:

1005007937811704

platformProductTitlestring

Third party platform product title

Example:

Custom Bluetooth Music Fridge Magnets

platformVariantTitlestring

Third party platform variant title

Example:

CMDemo5-23

platformVariantIdstring

Third party platform variant ID

Example:

49967332983073

platformProductImagestring

Third party platform product image

Example:

https://img-va.myshopline.com/image/store/1715051276308/2d4b670e-7fc8-4d22-a1f8-c897cab3938d.png?w=1000&h=1000

quantitynumber

Purchase quantity

Example:

1

storeIdstring

Store ID

Example:

179639630637846528

Request
GET/order
1curl --location -H "X-Api-Key: 123456789" --request GET 'https://openapi.customeow.io/v1/order?page={page}&pageSize={pageSize}'
Response
1{
2  "code": 0,
3  "message": "OK",
4  "data": {
5    "count": 1,
6    "list": [
7      {
8        "id": "173849875337719809",
9        "orderId": "173849875337719808",
10        "platformOrderNo": "3043654050207435",
11        "platformOrderId": "3043654050207435",
12        "platformCreatedAt": "2024-10-26T09:51:53Z",
13        "sku": "ALIBXT0P152X04",
14        "customId": "103237991190757376",
15        "customInfoId": "0",
16        "customVersion": "0",
17        "platformItemId": "3043654050217435",
18        "platformProductId": "1005007937811704",
19        "platformProductTitle": "Custom Bluetooth Music Fridge Magnets, Personalized
20        Names Refrigerator Magnet with Music, Anniversaryy Gifts for Girlfriend 3.0",
21        "platformVariantTitle": "",
22        "platformVariantId": "",
23        "platformProductImage": "",
24        "quantity": 1,
25        "storeId": "179639630637846528"
26      }
27    ]
28  }
29}

Get order V1

GET/order-info
Query order detail

Request

Security: API Key

An API key is a token that you provide when making API calls. Include the token in a header parameter calledX-Api-Key

Example:X-Api-Key:123456789

Query Parameters

storeId*string

Store ID

Example:107530295472842304

platformOrderId*string

Third party order ID

Example:107530295472842366

Response

200400500404
OK
codenumber

Response status code

Example:

0

messagestring

Response description

Example:

OK

dataobject

Response data

idstring

ID

Example:

107530295472840704

quantitynumber

Purchase quantity

Example:

1

platformOrderIdstring

Third party order ID

Example:

6109536387361

platformOrderNostring

Third party order number

Example:

1027

platformCreatedAtstring

Order creation time

Example:

2024-11-04T08:34:46Z

lineItemsobject[]

Product list

idstring

ID

Example:

173471757179592705

orderIdstring

Store order ID

Example:

173471757179592704

platformOrderNostring

Third party order number

Example:

1027

platformOrderIdstring

Third party order ID

Example:

6109536387361

skustring

SKU

Example:

CMDemo5-23-2

platformProductIdstring

Third party platform product ID

Example:

988654556

customIdstring

Customization feature ID

Example:

129219908520116224

customInfoIdstring

Customization info ID

Example:

173471012095041536

customVersionstring

Customization version

Example:

129219908520116224

platformItemIdstring

Third party platform item ID

Example:

15191512514849

platformProductTitlestring

Third party platform product title

Example:

sadadqwdwqdtest1233

platformVariantTitlestring

Third party platform variant title

Example:

CMDemo5-23

platformVariantIdstring

Third party platform variant ID

Example:

49967332983073

platformProductImagestring

Third party platform product image

Example:

https://img-va.myshopline.com/image/store/1715051276308/2d4b670e-7fc8-4d22-a1f8-c897cab3938d.png?w=1000&h=1000

quantitynumber

Purchase quantity

Example:

1

Request
GET/order-info
1curl --location -H "X-Api-Key: 123456789" --request GET 'https://openapi.customeow.io/v1/order-info?storeId={storeId}&platformOrderId={platformOrderId}'
Response
1{
2  "code": 0,
3  "message": "OK",
4  "data": {
5    "id": "173471757179592704",
6    "quantity": 1,
7    "platformOrderId": "6109536387361",
8    "platformOrderNo": "1027",
9    "platformCreatedAt": "2024-11-04T08:34:46Z",
10    "lineItems": [
11      {
12        "id": "173471757179592705",
13        "orderId": "173471757179592704",
14        "platformOrderNo": "1027",
15        "platformOrderId": "6109536387361",
16        "sku": "CMDemo5-23-2",
17        "platformProductId": "988654556",
18        "customId": "129219908520116224",
19        "customInfoId": "173471012095041536",
20        "customVersion": "129219908520116224",
21        "platformItemId": "15191512514849",
22        "platformProductTitle": "sadadqwdwqdtest1233",
23        "platformVariantTitle": "CMDemo5-23",
24        "platformVariantId": "49967332983073",
25        "platformProductImage": "",
26        "quantity": 1
27      }
28    ]
29  }
30}

Get SKU list V1

GET/skus
Query SKU list

Request

Security: API Key

An API key is a token that you provide when making API calls. Include the token in a header parameter calledX-Api-Key

Example:X-Api-Key:123456789

Query Parameters

storeId*string

Store id

Example:179639630637846528

integratedStatusnumber

Status: 0=none, 1=not integrated, 2=integrating, 3=integrated, 4=integration mechanism removed

Example:1

pagestring

Page number

Example:1

pageSizestring

Total number of pages

Example:10

keywordstring

Keyword search

Example:sku

Response

200400500404
OK
codenumber

Response status code

Example:

0

messagestring

Response description

Example:

OK

dataobject

Response data

countnumber

Total quantity

Example:

1

listobject[]

SKU list

idstring

SKU id

Example:

173849875337719809

skustring

SKU

Example:

CustoMeowDemoSKU1

integratedStatusnumber

Status: 0=none, 1=not integrated, 2=integrating, 3=integrated, 4=integration mechanism removed

Example:

1

createdAtstring

Creation time

Example:

2025-03-07T08:49:19Z

updatedAtstring

Update time

Example:

2025-03-07T08:49:24Z

customobject

Custom feature info

idstring

Custom feature id

Example:

103237991190757376

titlestring

Custom feature title

Example:

Demo-Custom Photo Case

storeobject

Store info

idstring

Store id

Example:

179639630637846528

namestring

Store name

Example:

demo-store

Request
GET/skus
1curl --location -H "X-Api-Key: 123456789" --request GET 'https://openapi.customeow.io/v1/skus?storeId={storeId}&page={page}&pageSize={pageSize}'
Response
1{
2  "code": 0,
3  "message": "OK",
4  "data": {
5    "count": 1,
6    "list": [
7      {
8        "id": "218049111163670528", 
9        "sku": "CustoMeowDemoSKU1",
10        "integratedStatus": 3,
11        "createdAt": "2025-03-07T08:49:19Z",
12        "updatedAt": "2025-03-07T08:49:24Z",
13        "custom": {
14          "id": "218049112598118400",
15          "title": "Demo-Custom Photo Case"
16        },
17        "store":{
18          "id": "1959596565656",
19          "name": "demo-store"
20        }
21      }
22    ]
23  }
24}

Get custom data V1

GET/custom-info/{custom_id}?lang=en_US
Full access to custom data for production printing.

Request

Security: API Key

An API key is a token that you provide when making API calls. Include the token in a header parameter calledX-Api-Key

Example:X-Api-Key:123456789

Query Parameters

custom_id*string

Custom data ID, unique identifier for user-customized data.

Example:53424155105734656

lang*string

The language of the component label

Example:en_US

LanguageLang code
English (United States)en_US
Germande_DE
Frenchfr_FR
Portuguese (Brazil)pt_BR
Spanishes_ES
Japaneseja_JP
Italianit_IT
Dutchnl_NL
Traditional Chinesezh_TW
Simplified Chinesezh_CN
Hebrew (Israel)he_IL
Russianru_RU
Arabicar_AR
Thaith_TH
Indonesianid_ID
Turkishtr_TR
Vietnamesevi_VI
Swedishsv_SV
Polishpl_PL
Portuguesept_PT
Koreanko_KR
Greekel_GR
Czechcs_CZ
Romanianro_RO
Slovaksk_SK
Hungarianhu_HU
Bulgarianbg_BG

Response

200400404401
OK
codenumber

Response status code

Example:

0

messagestring

Response description

Example:

OK

dataobject

Response data

idstring

Custom data id

Example:

41518078235770880

customInfoobject

Custom data content

previewobject

Custom preview content

effectsarray

Preview images from preview component

Example:

['https://s3.amazonaws.com/a.storyblok.com/f/191576/1024x1024/d25e1a99d7/sample-05.png', 'https://s3.amazonaws.com/a.storyblok.com/f/191576/1024x1024/d25e1a99d7/sample-06.png']

imagesarray

Customized images url from user

Example:

['https://s3.amazonaws.com/a.storyblok.com/f/191576/1024x1024/d25e1a99d7/sample-05.png', 'https://s3.amazonaws.com/a.storyblok.com/f/191576/1024x1024/d25e1a99d7/sample-06.png']

textsarray

Customized text from user

Example:

[Grace, David]

storesobject[]

Component node data

idstring

Component node ID

Example:

41518078235770880

keystring

Component node Key

Example:

value

labelstring

Component label content

Example:

Text

moduleTypestring

Component type

Example:

text

propertyNamestring

Component property name

Example:

text

typestring

Component data type

Example:

string

valuestring

Component data value from user

Example:

test

Request
GET/custom-info/{custom_id}?lang=en_US
1curl --location --request GET 'https://openapi.customeow.io/v1/custom-info/{custom_id}?lang=en_US'
Response
1{
2    "code": 0,
3    "message": "OK",
4    "data": {
5        "id": "1",
6        "customInfo": {
7            "preview": {
8                "effects": [],
9                "images": [],
10                "texts": []
11            },
12            "stores": [
13                {
14                    "id": "123",
15                    "key": "value",
16                    "label": "text input box",
17                    "moduleType": "text",
18                    "propertyName": "text",
19                    "type": "string",
20                    "value": "45"
21                },
22            ]
23        }
24    }
25}

Get template data V1

GET/custom-info/{id}/templates
Full access to templates data for production printing.

Request

Security: API Key

An API key is a token that you provide when making API calls. Include the token in a header parameter calledX-Api-Key

Example:X-Api-Key:123456789

Query Parameters

id*string

Custom data ID, unique identifier for user-customized data.

Example:92615739516669952

Response

200400404
OK
codenumber

Response status code

Example:

0

messagestring

Response description

Example:

OK

dataobject

Response data

customInfoIdstring

Custom data id

Example:

41518078235770880

templateobject[]

Custom data template collections

titlestring

Template title

Example:

Custom Clock Template

compositeIdstring

The order template ID is used to synthesize the production picture

Example:

42196802438430720

Request
GET/custom-info/{id}/templates
1curl --location -H "X-Api-Key: 123456789" --request GET 'https://openapi.customeow.io/v1/custom-info/{id}/templates'
Response
1{
2    "code": 0,
3    "message": "OK",
4    "data": {
5        "customInfoId": "92615739516669952",
6        "template": [
7            {
8                "title": "Custom Clock Template(1)",
9                "compositeId": "42196802438430720"
10            }
11        ]
12    }
13}

Create production template task V1

POST/composite/task
Create production template task

Headers

The request header needs to specify the content-type as application-json

Example:Content-Type: application/json

Request

Security: API Key

An API key is a token that you provide when making API calls. Include the token in a header parameter calledX-Api-Key

Example:X-Api-Key:123456789

Data

customInfoId*string

Custom data ID, unique identifier for user-customized data.

Example:92615739516669952

compositeId*string

The order template ID is used to synthesize the production picture

Example:42196802438430720

Response

200400404500
OK
codenumber

Response status code

Example:

0

messagestring

Response description

Example:

OK

dataobject

Response data

idstring

Task id

Example:

107474436742987776

Request
POST/composite/task
1curl -X POST -H "Content-Type: application/json" -d '{"customInfoId":"92615739516669952","compositeId": "42196802438430720"}' \
2    https://openapi.customeow.io/v1/composite/task
Response
1{
2    "code": 0,
3    "message": "OK",
4    "data": {
5        "id": "107530295472840704"
6    }
7}

Query task result V1

GET/composite/task/{id}
Query the result of a production template task

Request

Security: API Key

An API key is a token that you provide when making API calls. Include the token in a header parameter calledX-Api-Key

Example:X-Api-Key:123456789

Query Parameters

id*string

Task id

Example:107530295472840704

Response

200404
OK
codenumber

Response status code

Example:

0

messagestring

Response description

Example:

OK

dataobject

Response data

idstring

Record id

Example:

107530295472840704

customInfoIdstring

Custom data id

Example:

41518078235770880

compositeIdstring

The order template ID is used to synthesize the production picture

Example:

42196802438430720

statusnumber

status:0=none,1=progress,2=success,3=fail

Example:

2

failedReasonstring

Failed reason

Example:

failed

resourcesstring[]

By default, the first resource address is used as the result

Example:

https://sunzi-cn.oss-cn-hangzhou.aliyuncs.com/archive/process/202456/1f104cfc-39e1-43ed-9f61-e92bca6ec6a1.png

Request
GET/composite/task/{id}
1curl --location -H "X-Api-Key: 123456789" --request GET 'https://openapi.customeow.io/v1/composite/task/{id}'
Response
1{
2    "code": 0,
3    "message": "OK",
4    "data": {
5        "id": "107480773086429184",
6        "customInfoId": "107443911374422016",
7        "compositeId": "102731283536281600",
8        "status": 2,
9        "failedReason": "",
10        "resources": [
11            "https://sunzi-cn.oss-cn-hangzhou.aliyuncs.com/archive/process/202456/9e948f06-46ba-4af3-939c-086b41494b99.png"
12        ]
13    }
14}

Webhooks

Manage webhooks url

Webhooks guide

Webhooks are a mechanism for pushing event notifications to your server via HTTP POST requests. When a Webhooks event you configure is triggered, Meowforu will push an HTTP POST request to your configured Webhook address. They can be thought of as reverse API calls: instead of your system calling Meowforu, Meowforu calls back your server. This is particularly useful for receiving event notifications triggered externally by your system, for example: when a process task is processed, you can be notified via Webhooks.

Receive and process Webhooks events

When a Webhooks event that you have subscribed to fires, CustoMeow sends an HTTP POST request to the Webhooks address that you have configured. The content of the request is a JSON object containing detailed information about the event.

All Webhooks push structures are the same, except for the contents of the payload field, which contains detailed information about the event, depending on the type of event, see Webhooks Event Types.

The following is an example of a Webhooks request:
1{
2  "id": "123456",
3  "webhookId": "1234567",
4  "event": "order.completedCustomInfo",
5  "objectId": "task_123456",
6  "pushTime": "2024-08-31T12:00:00Z",
7  "payload": {
8    "id": "139661964069597184",
9    "quantity": 2,
10    "platformOrderId": "164055361404309504",
11    "platformStoreId": "99654562",
12    "platformOrderNo": "JHSL108884",
13    "platformCreatedAt": "2024-10-11T12:00:00Z",
14    "lineltems": [
15        {
16            "id": "137129222412967936",
17            "title": "Personalized Leather Wallet Anti-Theft Brush RFID Protected Men's Wallet",
18            "productId": "16065458009186458933240845",
19            "variantTitle": "Verbesserte Acrylversion (BESTSELLER) / Stil D",
20            "variantId": "18063863770378089369030845",
21            "sku": "CCP0P200X01",
22            "image": "https://via.placeholder.com/400x400/405f8c/9f0be3.webp",
23            "customInfoId": "157168333232275456",
24            "customizerVersion": "164044840034668544",
25            "customId": "164044840034668544",
26            "quantity": "3",
27            "platformItemId": "13006912127055"
28        }
29    ]
30  }
31}

Webhooks Request Field Descriptions

FieldTypeDescription
idstringPush RecordsID
webhookIdstringWebhooksID
eventstringEvent types
objectIdstringID of the object that triggered the event
pushTimestringPush time in the format yyyy-MM-dd'T'HH:mm:ss'Z'
payloadobjectEvent details, the data structure is different depending on the event
idstringOrderID
quantitynumberTotal number of goods purchased
platformOrderIdstringThird party ordersID
platformStoreIdstringThird party storesID
platformOrderNostringThird Party Order Number
platformCreatedAtstringThird party order creation time
lineltemsobject []OrderItems
idstringOrderLineItemID
titlestringProduct Title
productIdstringThird party goodsID
variantTitlestringThird party variant title
variantIdstringThird party variantsID
skustringSKU
imagestringPicture
customInfoIdstringCustom InformationID
customizerVersionstringCustom version number
customIdstringCustomID
quantitystringNumber of goods purchased
platformItemIdstringThird party ordersLineItemID

You will need to do several things:

1. Receiving requests: Your server needs to have a public URL that can receive HTTP POST requests from CustoMeow.

2. Validating requests: You need to validate the request sent by CustoMeow to make sure it comes from CustoMeow.

3. Processing requests: You need to process requests sent by CustoMeow to execute your business logic.

4. Responding request: You need to send an HTTP response to CustoMeow. The status code of the response should be 2xx to confirm that you have successfully received and processed the request.

Webhooks event types

The following Webhooks event types are supported:

1. Order related events

Order Completion Customization Information
Event nameAvailabilityDescriptionAssociated methods
order.completedCustomInfoYOrder Completion Customization InformationGet order details
order.completedCustomInfo

The order.completedCustomInfo event is triggered when the order completes all customized information.

Payload:
1{
2  "id": "139661964069597184",
3  "quantity": 2,
4  "platformOrderId": "164055361404309504",
5  "platformStoreId": "99654562",
6  "platformOrderNo": "JHSL108884",
7  "platformCreatedAt": "2024-10-11T12:00:00Z",
8  "lineltems": [
9      {
10          "id": "137129222412967936",
11          "title": "Personalized Leather Wallet Anti-Theft Brush RFID Protected Men's Wallet",
12          "productId": "16065458009186458933240845",
13          "variantTitle": "Verbesserte Acrylversion (BESTSELLER) / Stil D",
14          "variantId": "18063863770378089369030845",
15          "sku": "CCP0P200X01",
16          "image": "https://via.placeholder.com/400x400/405f8c/9f0be3.webp",
17          "customInfoId": "157168333232275456",
18          "customizerVersion": "164044840034668544",
19          "customId": "164044840034668544",
20          "quantity": "3",
21          "platformItemId": "13006912127055"
22      }
23  ]
24}

2. SKU related events

Event nameAvailabilityDescriptionAssociated methods
sku.addYAdd SKUQuery SKU list
sku.addFeatureYAdd SKU customization function Query SKU list
sku.replaceFeatureYReplace SKU customization function Query SKU list
sku.deleteFeatureYTriggered when manually deleting SKU customization function or when the points customization function component is used and the points are insufficient after the payment periodQuery SKU list
sku.deleteYDelete SKUQuery SKU list

Field descriptions

FieldTypeDescription
storeobjectStore info
idstringStore id
namestringStore name
customobjectCustom feature info
idstringCustom feature id
titlestringCustom feature title
skusobject[]SKU list
idstringSKU id
skustringSKU
integratedStatusnumberStatus: 0=none, 1=not integrated, 2=integrating, 3=integrated, 4=integration mechanism removed
createdAtstringCreation time
updatedAtstringUpdate time
sku.add

When an sku is added, the sku.add event is triggered.

Pushed data
1{
2  "store": {
3    "id": "218049111163670528", 
4    "name": "CustoMeowDemoStore1"
5  },
6  "skus": [
7    {
8      "id": "218049111163670528", 
9      "sku": "CustoMeowDemoSKU1",
10      "integratedStatus": 1, 
11      "createdAt": "2025-03-07T08:49:19Z", 
12      "updatedAt": "2025-03-07T08:49:24Z"
13    },
14    {
15      "id": "218049111163670529",
16      "sku": "CustoMeowDemoSKU2", 
17      "integratedStatus": 1,
18      "createdAt": "2025-03-07T08:49:19Z",
19      "updatedAt": "2025-03-07T08:49:24Z"
20    },
21    {
22      "id": "218049111163670530",
23      "sku": "CustoMeowDemoSKU3",
24      "integratedStatus": 1,
25      "createdAt": "2025-03-07T08:49:19Z",
26      "updatedAt": "2025-03-07T08:49:24Z"
27    }
28  ]
29}
sku.addFeature

When the sku integrates custom functionality, the sku.addfeature event is triggered.

Pushed data
1{
2  "store":{
3    "id": "218049111163670528",
4    "name": "CustoMeowDemoStore1"
5  },
6  "skus": [
7    {
8      "id": "218049111163670528",
9      "sku": "CustoMeowDemoSKU1",
10      "integratedStatus": 3,
11      "createdAt": "2025-03-07T08:49:19Z",
12      "updatedAt": "2025-03-07T08:49:24Z"
13    },
14    {
15      "id": "218049111163670529",
16      "sku": "CustoMeowDemoSKU2",
17      "integratedStatus": 3,
18      "createdAt": "2025-03-07T08:49:19Z",
19      "updatedAt": "2025-03-07T08:49:24Z"
20    }
21  ],
22  "custom": {
23    "id": "218049112598118400",
24    "title": "Demo-Custom Photo Case"
25  }
26}
sku.replaceFeature

When the sku replaces the custom feature, the sku.replaceFeature event is triggered.

Pushed data
1{
2  "store":{
3    "id": "218049111163670528",
4    "name": "CustoMeowDemoStore1"
5  },
6  "skus": [
7    {
8      "id": "218049111163670528",
9      "sku": "CustoMeowDemoSKU1",
10      "integratedStatus": 3,
11      "createdAt": "2025-03-07T08:49:19Z",
12      "updatedAt": "2025-03-07T08:49:24Z"
13    },
14    {
15      "id": "218049111163670529",
16      "sku": "CustoMeowDemoSKU2",
17      "integratedStatus": 3,
18      "createdAt": "2025-03-07T08:49:19Z",
19      "updatedAt": "2025-03-07T08:49:24Z"
20    }
21  ],
22  "custom": {
23    "id": "218049112598118400",
24    "title": "Demo-Custom Photo Case"
25  }
26}
sku.deleteFeature

When the SKU deletes a custom function, the sku.deleteFeature event is triggered.

Pushed data
1{
2  "store":{
3    "id": "218049111163670528",
4    "name": "CustoMeowDemoStore1"
5  },
6  "skus": [
7    {
8      "id": "218049111163670528",
9      "sku": "CustoMeowDemoSKU1",
10      "createdAt": "2025-03-07T08:49:19Z",
11      "updatedAt": "2025-03-07T08:49:24Z"
12    },
13    {
14      "id": "218049111163670529",
15      "sku": "CustoMeowDemoSKU2",
16      "createdAt": "2025-03-07T08:49:19Z",
17      "updatedAt": "2025-03-07T08:49:24Z"
18    }
19  ]
20}
sku.delete

When the sku is deleted, the SKu.delete event is triggered.

Pushed data
1{
2  "store":{
3    "id": "218049111163670528",
4    "name": "CustoMeowDemoStore1"
5  },
6  "skus": [
7    {
8      "id": "218049111163670528",
9      "sku": "CustoMeowDemoSKU1"
10    },
11    {
12      "id": "218049111163670529",
13      "sku": "CustoMeowDemoSKU2"
14    }
15  ]
16}