Zid integration guide
VerifiedHow to connect Zid to WEXTL and use its 1 trigger and 146 actions in your workflows. About Zid: E-commerce platform for stores, products, and orders.
- 1 trigger
- 68 searches
- 78 actions
- Instant (webhooks)
- Auth: OAuth
- Auth: API key
AI-assisted documentation42 min read
This documentation is compiled from our integration source code, internal specs for Zid, its official API documentation and anonymized requests logs we collect from our support team[2].
Requirements
Get your Zid credentials
Zid
You’ll be redirected to sign in and approve access. Your password is never shared with WEXTL.
- Client IDtextRequired
In the Partner Dashboard open Apps, then your app, then General settings, API keys. Add the redirect URL shown on this connection form to the allowed Redirection URLs of your app. It must match exactly. The merchant must be logged in to Zid while connecting. A connection that is not used for about a year can no longer refresh and has to be reconnected.[1]
- Client SecretpasswordRequired
The client secret of your app, from the same API keys page.[1]
- Store IDtextRequired
The numeric ID of the store you are connecting. Zid does not return it with the tokens. It is shown in the Partner Dashboard and in Get Manager Profile (user.store.id).[1]
Zid - Tokens
- Authorization TokenpasswordRequired
The authorization value Zid returned when your app was authorized (a long token starting with eyJ). You can get it without code from Zid Bridge: https://bridge.zid.dev[1]
- Manager TokenpasswordRequired
The access_token value from the same authorization (also called X-Manager-Token). Paste it exactly as given. When the pair expires, paste a new pair here.[1]
- Store IDtextRequired
The numeric store ID shown with the tokens in Zid Bridge, or user.store.id in Get Manager Profile.[1]
Connect Zid in WEXTL
- Log in to your WEXTL account, add the Zid node module to your workflow, and click Create new credential.Instant triggers use webhooks. Click Create a webhook first when adding one, then create the credential.
- Optional: In the Credential name field, enter a name for the credential.
- Enter the authentication credentials you copied from your Zid account, or follow the on-screen instructions to create the credential.
- If prompted, authenticate your account and confirm access.
- If you want to make changes to your credential in the future, follow the steps in Manage credentials →
Zid triggers and actions on WEXTL
The list below is a reference of every Zid node module the integration supports. You will be able to pick any of them on the workflow canvas while building automations.
Open any Zid node module below to inspect its input parameters, outputs, and connection requirements.
Watch Events
TriggerInstant trigger for Zid store events.
| Field | Type |
|---|---|
| Event | text |
| ID | number |
| Invoice Number | number |
| Code | text |
| Store ID | number |
| Order Url | text |
| Store Name | text |
| Shipping Method Code | text |
110other output fields
Count Reviews
SearchReview totals per moderation state.
| Field | Type |
|---|---|
StatusRequired | choice |
| Field | Type |
|---|---|
| Status | text |
| Count | number |
| Message | object |
| Type | text |
| Code | text |
| Name | text |
| Description | text |
Find a Customer by Phone
SearchCustomer lookup from a phone number.
| Field | Type |
|---|---|
Customer PhoneRequired | text |
| Field | Type |
|---|---|
| ID | number |
| Name | text |
| text | |
| Mobile | text |
| Gender | text |
| Birth Date | text |
| Verified | boolean |
| Is Active | boolean |
8other output fields
Get a Brand
SearchLogo, description and SEO fields of a brand.
| Field | Type |
|---|---|
BrandRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Slug | text |
| Description | object |
| Arabic | text |
| English | text |
| Logo | text |
| Seo Title | object |
| Arabic | text |
| English | text |
| Seo Content | object |
| Arabic | text |
| English | text |
| Is Active | boolean |
4other output fields
Get a Bundle Offer
SearchSetup of one bundle deal.
| Field | Type |
|---|---|
Bundle OfferRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Name | object |
| English | text |
| Arabic | text |
| Description | object |
| Arabic | text |
| English | text |
| Code | text |
| Conditions | array |
| Actions | array |
| Conditions Criteria | text |
| Uses Total | text |
9other output fields
Get a Category
SearchDetails of one product category.
| Field | Type |
|---|---|
CategoryRequired | choice |
| Field | Type |
|---|---|
| ID | number |
| Name | text |
| UUID | text |
| Slug | text |
| SEO Category Title | text |
| SEO Category Description | text |
| I18n SEO Category Title | object |
| Arabic | text |
| English | text |
| I18n SEO Category Description | object |
| Arabic | text |
| English | text |
15other output fields
Get a Coupon
SearchUsage and rules of one coupon.
| Field | Type |
|---|---|
CouponRequired | choice |
| Field | Type |
|---|---|
| Coupon ID | number |
| ID | number |
| Store ID | number |
| Store Name | text |
| Store Logo | text |
| Code | text |
| Uses Total | number |
| Created At | text |
32other output fields
Get a Customer
SearchName, contact and birth data of a customer.
| Field | Type |
|---|---|
CustomerRequired | choice |
| Field | Type |
|---|---|
| ID | number |
| Name | text |
| text | |
| Mobile | text |
| Gender | text |
| Birth Date | text |
| Verified | boolean |
| Is Active | boolean |
16other output fields
Get a Customer Loyalty Summary
SearchLoyalty points position of a customer.
| Field | Type |
|---|---|
Customer IDRequired | choice |
| Field | Type |
|---|---|
| Points Balance | number |
| Pending Points Balance | number |
| Pending Negative Points Balance | number |
| Available Poitns | number |
| Used Poitns | number |
| Total Positive Points | number |
| History | array |
Get a Customer Profile
SearchProfile page content of a customer.
| Field | Type |
|---|---|
CustomerRequired | choice |
| Field | Type |
|---|---|
| ID | number |
| Name | text |
| Mobile | text |
| text | |
| Gender | text |
| Birth Date | text |
| Note | text |
| Verified | boolean |
22other output fields
Get a Customer Ticket
SearchSupport ticket raised by a customer.
| Field | Type |
|---|---|
TicketRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Order ID | number |
| Store ID | number |
| Customer ID | number |
| Customer Phone | text |
| Type | text |
| Reason | text |
| Additional Details | text |
5other output fields
Get a Customer Wallet Balance
SearchMoney in a customer store wallet.
| Field | Type |
|---|---|
CustomerRequired | choice |
| Field | Type |
|---|---|
| Total Balance | number |
| Balance | number |
| Held Balance | number |
| Currency | text |
| Pending Cashback | number |
Get a Location
SearchDetails of an inventory location.
| Field | Type |
|---|---|
LocationRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Name | object |
| Arabic | text |
| City | object |
| ID | number |
| Name | text |
| Arabic Name | text |
| Country | object |
| Country Code | text |
| Type | text |
| Coordinates | object |
| Latitude | number |
| Longitude | number |
| Full Address | text |
| Short Address | text |
| District | text |
8other output fields
Get a Product
SearchIdentity and codes of a catalog item.
| Field | Type |
|---|---|
ProductRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Product Class | text |
| SKU | text |
| Barcode | text |
| Parent ID | text |
| Name | object |
| Arabic | text |
| Slug | text |
| Price | number |
47other output fields
Get a Product Stock
SearchInventory of a product at one place.
| Field | Type |
|---|---|
ProductRequired | choice |
StockRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Location | object |
| ID | text |
| Name | text |
| Type | text |
| Full Address | text |
| Available Quantity | text |
| Is Infinite | boolean |
Get an Abandoned Cart
SearchDetails of a cart left behind.
| Field | Type |
|---|---|
CartRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| URL | text |
| Store ID | text |
| Store Name | text |
| Store Logo | text |
| Store URL | text |
| Products Count | number |
| Products | array |
15other output fields
Get an Attribute
SearchOne attribute together with its allowed values.
| Field | Type |
|---|---|
AttributeRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Slug | text |
| Presets | array |
| Is Extra | boolean |
| Is Enabled | boolean |
| Display Order | text |
| Preset Count | number |
Get an Order
SearchComplete record of a placed order.
| Field | Type |
|---|---|
OrderRequired | choice |
| Field | Type |
|---|---|
| ID | number |
| Invoice Number | number |
| Code | text |
| Store ID | number |
| Order URL | text |
| Store Name | text |
| Shipping Method Code | text |
| Store URL | text |
66other output fields
Get an Order for a Return
SearchOrder data prepared for returns.
| Field | Type |
|---|---|
OrderRequired | choice |
| Field | Type |
|---|---|
| ID | number |
| Invoice Number | number |
| Code | text |
| Store ID | number |
| Order Status | object |
| Name | text |
| Code | text |
| Payment Status | text |
| Currency Code | text |
| Order Total | number |
5other output fields
Get Loyalty Analytics
SearchLoyalty results over a period.
| Field | Type |
|---|---|
Date FromRequired | date |
Date ToRequired | date |
| Field | Type |
|---|---|
| Total Earned Points | number |
| Total Redeemed Points | number |
| Total Pending Points | number |
| Total Customers With Points | number |
| Total Customers | number |
| Total Customers With Redeemed Points | number |
| Total Redemption Count | number |
Get Loyalty Settings
SearchConfiguration of the loyalty program.
| Field | Type |
|---|---|
| Is Active | boolean |
| Is Trial | boolean |
| End Trial | boolean |
| Expiration Period | number |
| Redemption Sort Direction | text |
| Cashback Rules | array |
| Redemption Rules | array |
Get Order Highlights
SearchSnapshot of recent order activity.
| Field | Type |
|---|---|
| Order Index | text |
| Field | Type |
|---|---|
| Orders Count | number |
| Order Index | text |
| Order ID | number |
| Order Date | text |
Get Store Languages and Currencies
SearchLanguage and money setup of the store.
| Field | Type |
|---|---|
| Language | object |
| ID | number |
| Name | text |
| Code | text |
| Direction | text |
| Languages | array |
| Currency | object |
| ID | number |
| Name | text |
| Code | text |
| Symbol | text |
| Country | object |
| Currencies | array |
Get the App Subscription
SearchBilling state of the app in the store.
| Field | Type |
|---|---|
| App ID | number |
| Store ID | number |
| Store URL | text |
| Plan Name | text |
| Subscription Status | text |
| Start Date | text |
| End Date | text |
| Merchant Phone No | text |
5other output fields
Get the Current Manager
SearchThe manager behind the credential.
| Field | Type |
|---|---|
| ID | number |
| UUID | text |
| Name | text |
| text | |
| Mobile | text |
| Mobile Object | object |
| Country Code | text |
| Mobile | text |
| Gender | text |
| Preferred Language | text |
1other output field
Get the Loyalty Status
SearchOn or off state of loyalty.
| Field | Type |
|---|---|
| Status | text |
| Loyalty Status | boolean |
| Message | object |
| Type | text |
| Code | text |
| Name | text |
| Description | text |
Get the Manager Profile
SearchAccount details of the store manager.
| Field | Type |
|---|---|
| ID | number |
| Old ID | number |
| UUID | text |
| Name | text |
| Username | text |
| text | |
| Email Pending Confirmation | text |
| Is Email Verified | boolean |
19other output fields
Get the Store
SearchBusiness details of your Zid store.
| Field | Type |
|---|---|
| ID | number |
| UUID | text |
| Title | text |
| Phone | text |
| Phone Object | object |
| Country Code | text |
| Mobile | text |
| text | |
| URL | text |
| Timezone | text |
Get the Webhook Health
SearchDelivery health totals of webhooks.
| Field | Type |
|---|---|
| Healthy | number |
| Degraded | number |
| Broken | number |
Get VAT Settings
SearchHow the store handles value added tax.
| Field | Type |
|---|---|
| Can Use VAT | boolean |
| VAT Activate | boolean |
| Is VAT Self Paid | boolean |
| Is VAT Included In Product Price | boolean |
| Is Shipping Fee Included In VAT | boolean |
| Other Countries Tax Percentage | number |
| Countries | array |
List Abandoned Carts
SearchCarts customers left unfinished.
| Field | Type |
|---|---|
LimitRequired | number |
| Phase | choice |
| Search Term | text |
| Customer ID | choice |
| Has Reminders | choice |
| Created From | date |
| Created To | date |
| Sort Direction | choice |
1other input field
| Field | Type |
|---|---|
| ID | text |
| Store ID | text |
| Session ID | text |
| URL | text |
| Cart ID | text |
| Order ID | text |
| Phase | text |
| Customer ID | number |
13other output fields
List Attribute Presets
SearchSelectable values for an attribute.
| Field | Type |
|---|---|
LimitRequired | number |
AttributeRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Slug | text |
| Name | text |
| Value | text |
| Type | text |
| Type Value | text |
| Display Order | text |
| Attribute Image ID | text |
1other output field
List Attributes
SearchAll product attribute definitions.
| Field | Type |
|---|---|
LimitRequired | number |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Slug | text |
| Presets | array |
| Is Extra | boolean |
| Is Enabled | boolean |
| Display Order | text |
| Preset Count | number |
List Brands
SearchProduct brands of the store.
| Field | Type |
|---|---|
LimitRequired | number |
| Search | text |
| Active | choice |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Slug | text |
| Description | object |
| Arabic | text |
| English | text |
| Logo | text |
| Seo Title | object |
| Arabic | text |
| English | text |
| Seo Content | object |
| Arabic | text |
| English | text |
| Is Active | boolean |
4other output fields
List Broken Webhooks
SearchWebhooks that fail to deliver.
| Field | Type |
|---|---|
LimitRequired | number |
List Bundle Offers
SearchBundle deals defined in the store.
| Field | Type |
|---|---|
LimitRequired | number |
| Code | text |
| Status | choice |
| Search Term | text |
| Field | Type |
|---|---|
| ID | text |
| Name | object |
| English | text |
| Arabic | text |
| Description | object |
| Arabic | text |
| English | text |
| Code | text |
| Conditions | array |
| Actions | array |
| Conditions Criteria | text |
| Uses Total | text |
9other output fields
List Categories
SearchProduct categories of the store.
| Field | Type |
|---|---|
LimitRequired | number |
| Field | Type |
|---|---|
| ID | number |
| UUID | text |
| Name | text |
| Slug | text |
| SEO Category Title | text |
| SEO Category Description | text |
| Names | object |
| English | text |
| Arabic | text |
| Description | text |
10other output fields
List Cities for a Country
SearchCities available inside a country.
| Field | Type |
|---|---|
LimitRequired | number |
CountryRequired | choice |
| Field | Type |
|---|---|
| Name | text |
| ID | number |
| National ID | number |
| Priority | number |
| Country ID | number |
| Country Name | text |
| Country Code | text |
| Arabic Name | text |
1other output field
List Countries
SearchCountries known to Zid.
| Field | Type |
|---|---|
LimitRequired | number |
| Field | Type |
|---|---|
| ID | number |
| Name | text |
| Code | text |
| Country Code | text |
| Flag | text |
List Coupons
SearchPromo codes defined for the store.
| Field | Type |
|---|---|
LimitRequired | number |
| Search Term | text |
| Status | choice |
| Date From | date |
| Date To | date |
| Date Filter Field | choice |
| Order By | choice |
| Sort Direction | choice |
| Field | Type |
|---|---|
| Coupon ID | number |
| ID | number |
| Store ID | number |
| Store Name | text |
| Store Logo | text |
| Code | text |
| Uses Total | number |
| Created At | text |
27other output fields
List Custom Order Statuses
SearchOrder statuses together with their sub statuses.
| Field | Type |
|---|---|
LimitRequired | number |
| Field | Type |
|---|---|
| ID | number |
| Status | text |
| Code | text |
| Is Customizable | boolean |
| Sub Statuses | array |
List Customer Points History
SearchLoyalty point log of one shopper.
| Field | Type |
|---|---|
LimitRequired | number |
CustomerRequired | choice |
| Field | Type |
|---|---|
| Date | text |
| Reason | text |
| Points | number |
| Direction | text |
| Type | text |
| Order Number | text |
| Order Code | text |
| Expiry Date | text |
3other output fields
List Customer Tags
SearchLabels available for customers.
| Field | Type |
|---|---|
LimitRequired | number |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Store ID | text |
List Customer Tickets
SearchSupport tickets raised by customers.
| Field | Type |
|---|---|
LimitRequired | number |
| Status | choice |
| Field | Type |
|---|---|
| ID | text |
| Order ID | number |
| Store ID | number |
| Customer ID | number |
| Customer Phone | text |
| Type | text |
| Reason | text |
| Additional Details | text |
5other output fields
List Customer Wallets
SearchWallet balances across customers.
| Field | Type |
|---|---|
LimitRequired | number |
| Balance From | number |
| Balance To | number |
| Expiring Within Days | number |
| Expiring Before | text |
| Field | Type |
|---|---|
| Customer ID | number |
| Name | text |
| Phone Number | text |
| text | |
| Balance | text |
| Total Balance | text |
| Held Balance | number |
| Currency | text |
3other output fields
List Customers
SearchCustomers registered in the store.
| Field | Type |
|---|---|
LimitRequired | number |
| Type | choice |
| Gender | choice |
| Search Term | text |
| Phone | text |
| Created From | date |
| Created To | date |
| Verified Phone Only | choice |
| Field | Type |
|---|---|
| ID | number |
| Name | text |
| text | |
| Mobile | text |
| Gender | text |
| Birth Date | text |
| Verified | boolean |
| Is Active | boolean |
16other output fields
List Customers (Basic)
SearchCompact customer listing for large stores.
| Field | Type |
|---|---|
LimitRequired | number |
| Field | Type |
|---|---|
| ID | number |
| Name | text |
| text | |
| Mobile | text |
| Gender | text |
| Birth Date | text |
| Verified | boolean |
| Is Active | boolean |
13other output fields
List Locations
SearchPlaces where inventory is held.
| Field | Type |
|---|---|
LimitRequired | number |
| Field | Type |
|---|---|
| ID | text |
| Name | object |
| Arabic | text |
| City | object |
| ID | number |
| Name | text |
| Arabic Name | text |
| Country | object |
| Country Code | text |
| Type | text |
| Coordinates | object |
| Latitude | number |
| Longitude | number |
| Full Address | text |
| Short Address | text |
| District | text |
8other output fields
List Order Credit Notes
SearchRefund documents of an order.
| Field | Type |
|---|---|
LimitRequired | number |
OrderRequired | choice |
List Order Fulfillment Locations
SearchStock sites able to ship an order.
| Field | Type |
|---|---|
LimitRequired | number |
OrderRequired | choice |
| Field | Type |
|---|---|
| Inventory ID | number |
| Inventory Name | text |
| Products | array |
List Order Tags
SearchTags that can be put on orders and their usage.
| Field | Type |
|---|---|
LimitRequired | number |
| Name | text |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Store ID | text |
| User ID | text |
| Orders | array |
List Orders
SearchOrders placed in the store.
| Field | Type |
|---|---|
LimitRequired | number |
| Response Detail | choice |
| Order Status | choice |
| Payment Method | choice |
| Customer | choice |
| Created From | date |
| Created To | date |
| Sort Direction | choice |
11other input fields
| Field | Type |
|---|---|
| ID | number |
| Invoice Number | number |
| Code | text |
| Store ID | number |
| Order URL | text |
| Store Name | text |
| Shipping Method Code | text |
| Store URL | text |
35other output fields
List Payment Methods
SearchWays customers can pay.
| Field | Type |
|---|---|
LimitRequired | number |
| Field | Type |
|---|---|
| Enabled | boolean |
| Code | text |
| Fees | number |
| Fees String | text |
| Type | text |
| Name | text |
| Icons | array |
| ID | number |
List Payment Options
SearchCheckout payment choices of the store.
| Field | Type |
|---|---|
| Status | text |
| Payment Options | array |
| Message | object |
| Type | text |
| Code | text |
| Name | text |
| Description | text |
List Pending Cashbacks
SearchCashback waiting for a customer.
| Field | Type |
|---|---|
LimitRequired | number |
CustomerRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Store ID | number |
| Customer ID | number |
| Order ID | number |
| Amount | text |
| Currency | text |
| Expiry Days | number |
| Status | text |
3other output fields
List Product Badges
SearchBadge labels available for products.
| Field | Type |
|---|---|
LimitRequired | number |
| Field | Type |
|---|---|
| Body | object |
| Arabic | text |
| English | text |
| Is Example | boolean |
| Icon | object |
| Code | text |
List Product Images
SearchGallery pictures belonging to a product.
| Field | Type |
|---|---|
LimitRequired | number |
ProductRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Image | object |
| Large | text |
| Medium | text |
| Small | text |
| Full Size | text |
| Thumbnail | text |
| Alt Text | text |
| Display Order | number |
List Product Questions
SearchShopper questions found on a product.
| Field | Type |
|---|---|
LimitRequired | number |
ProductRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Store | text |
| Product | text |
| Product Name | text |
| Customer | text |
| Name | text |
| text | |
| Is Anonymous | boolean |
7other output fields
List Product Settings
SearchStore-wide product display settings.
| Field | Type |
|---|---|
| Extended Search Support | boolean |
| Related Products Status | boolean |
| Related Products Count | number |
| Sold Products Count Status | boolean |
| Min Sold Products Count | number |
| Default Products Ordering | text |
| Has Products Filtration | boolean |
| Is Wishlist Enabled | boolean |
1other output field
List Product Stock
SearchInventory of a product by place.
| Field | Type |
|---|---|
LimitRequired | number |
ProductRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Location | object |
| ID | text |
| Name | text |
| Type | text |
| Full Address | text |
| Available Quantity | text |
| Is Infinite | boolean |
List Products
SearchProducts of the store catalog.
| Field | Type |
|---|---|
LimitRequired | number |
| Product Class | choice |
| Published | choice |
| Quantity From | number |
| Quantity To | number |
| Categories | choice |
| Search | text |
| Order By | choice |
3other input fields
| Field | Type |
|---|---|
| ID | text |
| Product Class | text |
| SKU | text |
| Barcode | text |
| Parent ID | text |
| Name | object |
| Arabic | text |
| English | text |
| Slug | text |
| Price | number |
40other output fields
List Question Answers
SearchReplies to a product question.
| Field | Type |
|---|---|
LimitRequired | number |
QuestionRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Question ID | text |
| Answer | text |
| Created At | text |
List Return Reasons
SearchReturn causes defined in the store.
| Field | Type |
|---|---|
LimitRequired | number |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
List Reviews
SearchShopper reviews and ratings.
| Field | Type |
|---|---|
LimitRequired | number |
Review TypeRequired | choice |
| Status | choice |
| Search Term | text |
| Created From | date |
| Created To | date |
| Order By | choice |
| Sort Direction | choice |
| Field | Type |
|---|---|
| ID | text |
| Customer | object |
| ID | number |
| Name | text |
| Product | object |
| ID | text |
| Name | text |
| Bought This Item | boolean |
| Image | text |
| Status | text |
| Is Anonymous | boolean |
| Rating | number |
| Comment | text |
| Edit Requested | boolean |
5other output fields
List Shipping Methods
SearchDelivery options of the store.
| Field | Type |
|---|---|
LimitRequired | number |
Payload TypeRequired | text |
| Field | Type |
|---|---|
| ID | number |
| Name | text |
| System Option Code | text |
| Select Cities | array |
| Shipping Method Status | text |
List Store Countries
SearchStore countries with codes and flags.
| Field | Type |
|---|---|
LimitRequired | number |
| Field | Type |
|---|---|
| ID | number |
| Name | text |
| Code | text |
| Country Code | text |
| Flag | text |
List Store Questions
SearchQuestions from every product page.
| Field | Type |
|---|---|
LimitRequired | number |
| Anonymous | choice |
| Asked by the Store | choice |
| Published | choice |
| New | choice |
| Question | text |
| Created From | date |
| Created To | date |
1other input field
| Field | Type |
|---|---|
| ID | number |
| Product | number |
| Product Name | text |
| Customer | text |
| Name | text |
| text | |
| Is Anonymous | boolean |
| Is Owner | boolean |
5other output fields
List Wallet Transactions
SearchMoney history of a customer wallet.
| Field | Type |
|---|---|
LimitRequired | number |
CustomerRequired | choice |
| Field | Type |
|---|---|
| Transaction ID | text |
| Transaction Number | text |
| Amount | text |
| Currency | text |
| Type | text |
| Status | text |
| Description | text |
| Order ID | number |
2other output fields
List Webhooks
SearchRegistered webhook subscriptions of the store.
| Field | Type |
|---|---|
LimitRequired | number |
| Field | Type |
|---|---|
| ID | text |
| Event | text |
| Target URL | text |
| Store ID | text |
| Conditions | array |
| Original ID | text |
| Subscriber | text |
| Active | boolean |
1other output field
Add a Customer
ActionNew store customer with contact and company details.
| Field | Type |
|---|---|
TypeRequired | choice |
NameRequired | text |
MobileRequired | text |
| text | |
| Gender | choice |
| Business Name | text |
| Tax Number | text |
| Commercial Registration | text |
| Field | Type |
|---|---|
| ID | number |
| Name | text |
| text | |
| Mobile | text |
| Gender | text |
| Birth Date | text |
| Verified | boolean |
| Is Active | boolean |
17other output fields
Add a Customer Tag
ActionGives a customer record a label.
| Field | Type |
|---|---|
CustomerRequired | choice |
NameRequired | text |
| Field | Type |
|---|---|
| ID | number |
| Name | text |
| text | |
| Mobile | text |
| Gender | text |
| Birth Date | text |
| Verified | boolean |
| Is Active | boolean |
17other output fields
Add a Product to a Category
ActionLinks a catalog item to a section of the store.
| Field | Type |
|---|---|
ProductRequired | choice |
CategoryRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Slug | text |
| Description | text |
| Cover Image | text |
| Image | text |
| Display Order | number |
| Meta | object |
| Childs | array |
| Parents | array |
Add a Return Reason
ActionSelectable cause for product returns.
| Field | Type |
|---|---|
NameRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
Add an Order Comment
ActionRecords a progress comment on an order.
| Field | Type |
|---|---|
OrderRequired | choice |
CommentRequired | text |
| Field | Type |
|---|---|
| ID | number |
| Invoice Number | number |
| Code | text |
| Store ID | number |
| Order URL | text |
| Store Name | text |
| Store URL | text |
| Order Status | object |
| Name | text |
| Code | text |
12other output fields
Add an Order Tag
ActionLabel attached to an order.
| Field | Type |
|---|---|
OrderRequired | choice |
NameRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Store ID | text |
| User ID | text |
| Orders | array |
Add Customers in Bulk
ActionBatch registration of store customers.
| Field | Type |
|---|---|
CustomersRequired | array |
| Customer | object |
| Field | Type |
|---|---|
| Status | text |
| Customers | array |
| Message | object |
| Type | text |
| Code | text |
| Name | text |
| Description | text |
Add Products to a Category in Bulk
ActionMulti-category assignment for a product.
| Field | Type |
|---|---|
ProductRequired | choice |
Category IDsRequired | array |
Adjust Customer Points
ActionManual loyalty balance change.
| Field | Type |
|---|---|
Customer IDRequired | choice |
DirectionRequired | choice |
PointsRequired | number |
| Reason | text |
| Field | Type |
|---|---|
| Date | text |
| Reason | text |
| Points | number |
| Direction | text |
| Type | text |
| Order Number | text |
| Expiry Date | text |
| Point Status | text |
1other output field
Calculate Return Totals
ActionPreview of the amounts for a return.
| Field | Type |
|---|---|
Order IDRequired | choice |
Partial ReturnRequired | boolean |
| Products | array |
| Product | object |
| Field | Type |
|---|---|
| Invoice | array |
Change an Order Status
ActionAdvances or cancels an order.
| Field | Type |
|---|---|
OrderRequired | choice |
Order StatusRequired | choice |
| Tracking Number | text |
| Tracking URL | text |
| Waybill URL | text |
| Comment | text |
| Inventory Location ID | choice |
| Marketplace Cancellation Reason | choice |
| Field | Type |
|---|---|
| ID | number |
| Invoice Number | number |
| Code | text |
| Store ID | number |
| Order URL | text |
| Store Name | text |
| Shipping Method Code | text |
| Store URL | text |
67other output fields
Create a Bundle Offer
ActionRule-based product bundle discount.
| Field | Type |
|---|---|
CodeRequired | choice |
NameRequired | object |
| English | text |
| Arabic | text |
ConditionsRequired | text |
ActionsRequired | text |
| Description | object |
| English | text |
| Arabic | text |
| Total Uses | number |
| Uses per Customer | number |
| Conditions Match | choice |
4other input fields
| Field | Type |
|---|---|
| ID | text |
| Name | object |
| English | text |
| Arabic | text |
| Description | object |
| English | text |
| Arabic | text |
| Code | text |
| Conditions | array |
| Actions | array |
| Conditions Criteria | text |
| Uses Total | number |
10other output fields
Create a Category
ActionNew section of the product catalog.
| Field | Type |
|---|---|
NameRequired | object |
| Arabic | text |
| English | text |
DescriptionRequired | object |
| Arabic | text |
| English | text |
| Parent Category | choice |
| Field | Type |
|---|---|
| ID | number |
| Name | text |
| UUID | text |
| Slug | text |
| SEO Category Title | text |
| SEO Category Description | text |
| I18n SEO Category Title | object |
| Arabic | text |
| English | text |
| I18n SEO Category Description | object |
| Arabic | text |
| English | text |
15other output fields
Create a Coupon
ActionDiscount code with usage limits.
| Field | Type |
|---|---|
NameRequired | text |
Discount TypeRequired | choice |
| Code | text |
| Discount | number |
| Free Shipping | boolean |
| Free COD | boolean |
| Status | boolean |
| Applying Method | choice |
18other input fields
| Field | Type |
|---|---|
| Coupon ID | number |
| ID | number |
| Store ID | number |
| Store Name | text |
| Store Logo | text |
| Code | text |
| Uses Total | number |
| Created At | text |
34other output fields
Create a Custom Input Field
ActionFree-entry field on a product page.
| Field | Type |
|---|---|
ProductRequired | choice |
TypeRequired | text |
LabelRequired | object |
EnglishRequired | text |
ArabicRequired | text |
| Hint | object |
| English | text |
| Arabic | text |
| Price | number |
| Required | boolean |
| Published | boolean |
| Display Order | number |
1other input field
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Hint | object |
| English | text |
| Arabic | text |
| Label | object |
| English | text |
| Arabic | text |
| Display Order | number |
| Is Required | boolean |
| Price | number |
| Formatted Price | text |
3other output fields
Create a Custom Option
ActionPick-list option on a product.
| Field | Type |
|---|---|
ProductRequired | choice |
LabelRequired | object |
ArabicRequired | text |
EnglishRequired | text |
ChoicesRequired | array |
| Choice | object |
| Hint | object |
ArabicRequired | text |
EnglishRequired | text |
| Type | text |
| Min Choices | number |
| Max Choices | number |
| Can Choose Multiple Options | boolean |
3other input fields
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Label | object |
| Arabic | text |
| English | text |
| Hint | object |
| Arabic | text |
| English | text |
| Min Choices | number |
| Max Choices | number |
| Can Choose Multiple Options | boolean |
| Is Published | boolean |
4other output fields
Create a Location
ActionNew inventory location for the store.
| Field | Type |
|---|---|
NameRequired | object |
ArabicRequired | text |
EnglishRequired | text |
CoordinatesRequired | object |
LongitudeRequired | number |
LatitudeRequired | number |
Full AddressRequired | text |
Default LocationRequired | boolean |
PrivateRequired | boolean |
EnabledRequired | boolean |
CityRequired | choice |
CountryRequired | choice |
1other input field
| Field | Type |
|---|---|
| ID | text |
| Name | object |
| English | text |
| City | object |
| ID | number |
| Name | text |
| Arabic Name | text |
| Country | object |
| Country Code | text |
| Type | text |
| Coordinates | object |
| Latitude | number |
| Longitude | number |
| Full Address | text |
| Short Address | text |
| District | text |
8other output fields
Create a Product
ActionNew catalog item with bilingual name.
| Field | Type |
|---|---|
PriceRequired | number |
SKURequired | text |
NameRequired | object |
ArabicRequired | text |
EnglishRequired | text |
| Sale Price | number |
| Draft | boolean |
| Unlimited Stock | boolean |
| Quantity | number |
| Requires Shipping | boolean |
1other input field
| Field | Type |
|---|---|
| ID | text |
| Name | object |
| Arabic | text |
| English | text |
| Product Class | text |
| SKU | text |
| Price | number |
| Is Draft | boolean |
| Is Published | boolean |
| Requires Shipping | boolean |
2other output fields
Create a Product Answer
ActionStore reply to a product question.
| Field | Type |
|---|---|
ProductRequired | choice |
QuestionRequired | choice |
AnswerRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Question ID | text |
| Answer | text |
| Created At | text |
Create a Product Question
ActionNew question on a product listing page.
| Field | Type |
|---|---|
ProductRequired | choice |
QuestionRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Store | text |
| Product | text |
| Product Name | text |
| Customer | text |
| Name | text |
| text | |
| Is Anonymous | boolean |
7other output fields
Create a Product Stock
ActionInventory record for a product and place.
| Field | Type |
|---|---|
ProductRequired | choice |
LocationRequired | choice |
Available QuantityRequired | number |
Unlimited StockRequired | boolean |
| Field | Type |
|---|---|
| ID | text |
| Location | text |
| Available Quantity | number |
| Is Infinite | boolean |
Create a Return Order
ActionNew return request against an order.
| Field | Type |
|---|---|
Order IDRequired | choice |
Consignee NameRequired | text |
Consignee MobileRequired | text |
Consignee Address 1Required | text |
Consignee Address 2Required | text |
CountryRequired | choice |
CityRequired | choice |
Inventory LocationRequired | choice |
1other input field
| Field | Type |
|---|---|
| ID | text |
| Store ID | text |
| Order ID | number |
| Is Partial | boolean |
| Consignee Name | text |
| Consignee Mobile | text |
| Consignee City | object |
| ID | number |
| Country ID | number |
| Zone ID | number |
| Name | text |
| Arabic Name | text |
| Code | text |
| Status | number |
| Priority | number |
| Created At | text |
| Updated At | text |
| Consignee Address 1 | text |
13other output fields
Create a Return Refund
ActionMoney returned to the buyer after a return.
| Field | Type |
|---|---|
Order Reverse IDRequired | text |
AmountRequired | number |
Payment MethodRequired | choice |
| Notes | text |
| Field | Type |
|---|---|
| ID | text |
| Store ID | text |
| Order ID | number |
| Is Partial | number |
| Consignee Name | text |
| Consignee Mobile | text |
| Consignee City | object |
| ID | number |
| Country ID | number |
| Zone ID | number |
| Name | text |
| Arabic Name | text |
| Code | text |
| Status | number |
| Priority | number |
| Created At | text |
| Updated At | text |
| Consignee Address 1 | text |
13other output fields
Create a Return Waybill
ActionZidShip label for a return.
| Field | Type |
|---|---|
Order IDRequired | choice |
Standalone ZidShip WaybillRequired | boolean |
| Field | Type |
|---|---|
| ID | text |
| Store ID | text |
| Order ID | number |
| Consignee Name | text |
| Consignee Mobile | text |
| Consignee City | object |
| ID | number |
| Country | object |
| Arabic Name | text |
| English Name | text |
| Name | text |
| Priority | number |
| Consignee Address 1 | text |
| Consignee Address 2 | text |
3other output fields
Create an Attribute
ActionNew product attribute with a bilingual name.
| Field | Type |
|---|---|
NameRequired | object |
| Arabic | text |
| English | text |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Slug | text |
| Presets | array |
| Is Extra | boolean |
| Is Enabled | boolean |
| Display Order | text |
| Preset Count | text |
Create an Attribute Preset
ActionSelectable value of an attribute.
| Field | Type |
|---|---|
AttributeRequired | choice |
ValueRequired | object |
| Arabic | text |
| English | text |
| Field | Type |
|---|---|
| ID | text |
| Slug | text |
| Name | text |
| Value | text |
| Type | text |
| Type Value | text |
| Display Order | text |
| Attribute Image ID | text |
1other output field
Create an Order
ActionDraft order built from products and delivery data.
| Field | Type |
|---|---|
Currency CodeRequired | text |
CustomerRequired | object |
Full NameRequired | text |
Mobile Country CodeRequired | text |
Mobile NumberRequired | text |
EmailRequired | text |
ConsigneeRequired | object |
ContactRequired | object |
AddressRequired | object |
Gift OrderRequired | boolean |
Notify Gift RecipientRequired | boolean |
ProductsRequired | array |
| Product | object |
Shipping Method TypeRequired | text |
Shipping MethodRequired | choice |
4other input fields
| Field | Type |
|---|---|
| ID | number |
| Invoice Number | number |
| Code | text |
| Store ID | number |
| Order URL | text |
| Store Name | text |
| Shipping Method Code | text |
| Store URL | text |
67other output fields
Create Product Variants
ActionAttribute-based variations of a product.
| Field | Type |
|---|---|
ProductRequired | choice |
VariantsRequired | array |
| Variant | object |
| Field | Type |
|---|---|
| ID | text |
| Name | object |
| Arabic | text |
| English | text |
| SKU | text |
| Slug | text |
| Currency | text |
| Currency Symbol | text |
| Price | number |
| Sale Price | text |
27other output fields
Credit a Customer Wallet
ActionMoney added to a customer wallet.
| Field | Type |
|---|---|
CustomerRequired | choice |
AmountRequired | number |
| Reason | text |
| Expires At | date |
| Field | Type |
|---|---|
| Message | text |
| Transaction ID | text |
| Amount | text |
Debit a Customer Wallet
ActionMoney deducted from a customer wallet.
| Field | Type |
|---|---|
CustomerRequired | choice |
AmountRequired | number |
| Reason | text |
| Field | Type |
|---|---|
| Message | text |
| Transaction ID | text |
| Amount | text |
Delete a Bundle Offer
ActionRemoves a single bundle deal.
| Field | Type |
|---|---|
Bundle OfferRequired | choice |
Delete a Category
ActionClears one product section out of the catalog.
| Field | Type |
|---|---|
CategoryRequired | choice |
| Field | Type |
|---|---|
| Status | text |
| Message | text |
Delete a Coupon
ActionRemoves one coupon code from the store.
| Field | Type |
|---|---|
CouponRequired | choice |
| Field | Type |
|---|---|
| Status | text |
| Message | object |
| Type | text |
| Code | text |
| Name | text |
| Description | text |
Delete a Custom Input Field
ActionA buyer-entry field no longer on the product.
| Field | Type |
|---|---|
ProductRequired | choice |
Input FieldRequired | text |
Delete a Custom Option
ActionA pick-list choice taken off the product.
| Field | Type |
|---|---|
ProductRequired | choice |
OptionRequired | text |
Delete a Customer
ActionDeletes a shopper from the customer list.
| Field | Type |
|---|---|
CustomerRequired | choice |
| Field | Type |
|---|---|
| Status | text |
| Message | object |
| Type | text |
| Code | text |
| Name | text |
| Description | text |
Delete a Product
ActionDeletes an item from the whole catalog.
| Field | Type |
|---|---|
ProductRequired | choice |
Delete a Product Image
ActionRemoves one product picture.
| Field | Type |
|---|---|
ProductRequired | choice |
ImageRequired | choice |
Delete an Attribute
ActionRemoves one attribute definition.
| Field | Type |
|---|---|
AttributeRequired | choice |
Delete an Attribute Preset
ActionRemoves one selectable attribute value.
| Field | Type |
|---|---|
AttributeRequired | choice |
PresetRequired | choice |
Delete Bundle Offers in Bulk
ActionMass removal of bundle deals.
| Field | Type |
|---|---|
Discount Rule IDsRequired | array |
Delete Coupons in Bulk
ActionMass removal of coupons.
| Field | Type |
|---|---|
Coupons IDsRequired | array |
| Field | Type |
|---|---|
| Status | text |
| Message | object |
| Type | text |
| Code | text |
| Name | text |
| Description | text |
Duplicate a Coupon
ActionClones one coupon with identical discount settings.
| Field | Type |
|---|---|
CouponRequired | choice |
| Field | Type |
|---|---|
| Status | text |
| Message | object |
| Type | text |
| Code | text |
| Name | text |
| Description | text |
Duplicate Coupons in Bulk
ActionMass cloning of coupon codes.
| Field | Type |
|---|---|
IDsRequired | array |
| Field | Type |
|---|---|
| Status | text |
| Message | object |
| Type | text |
| Code | text |
| Name | text |
| Description | text |
Generate Coupons in Bulk
ActionBatch of coupons from one template.
| Field | Type |
|---|---|
NameRequired | text |
Coupons AmountRequired | number |
Discount TypeRequired | choice |
| Code | text |
| Discount | number |
| Free Shipping | boolean |
| Free COD | boolean |
| Minimum Cart Total | number |
17other input fields
| Field | Type |
|---|---|
| Status | text |
| Message | object |
| Type | text |
| Code | text |
| Name | text |
| Description | text |
Make an API Call
universalDirect Zid REST API access for uncovered endpoints.
| Field | Type |
|---|---|
URLRequired | text |
MethodRequired | choice |
| Headers | array |
| Header | object |
| Query string | array |
| Parameter | object |
| Body | text |
| Field | Type |
|---|---|
| Body | text |
| Headers | object |
| Key | text |
| Value | text |
| Status code | number |
Recover Broken Webhooks
ActionRestores delivery of failed webhooks.
| Field | Type |
|---|---|
WebhooksRequired | array |
| Webhook | object |
| Field | Type |
|---|---|
| Status | text |
| Data | array |
| Message | object |
| Type | text |
| Code | text |
| Name | text |
| Description | text |
Remove a Customer Tag
ActionUnlabels a customer in the store.
| Field | Type |
|---|---|
CustomerRequired | choice |
TagRequired | choice |
| Field | Type |
|---|---|
| ID | number |
| Name | text |
| text | |
| Mobile | text |
| Gender | text |
| Birth Date | text |
| Verified | boolean |
| Is Active | boolean |
17other output fields
Remove a Product from a Category
ActionUnlinks a catalog item from a section.
| Field | Type |
|---|---|
ProductRequired | choice |
CategoryRequired | choice |
Remove All Products from a Category
ActionClears the product list of a category.
| Field | Type |
|---|---|
CategoryRequired | choice |
| Field | Type |
|---|---|
| ID | number |
| Name | text |
| UUID | text |
| Slug | text |
| SEO Category Title | text |
| SEO Category Description | text |
| I18n SEO Category Title | object |
| Arabic | text |
| English | text |
| I18n SEO Category Description | object |
| Arabic | text |
| English | text |
15other output fields
Reset Manual Product Order
ActionRemoves the manual ordering of products.
| Field | Type |
|---|---|
ConfirmRequired | text |
Send an Abandoned Cart Reminder
ActionNudges shoppers about unfinished carts.
| Field | Type |
|---|---|
Abandoned CartsRequired | array |
Notification SettingsRequired | object |
TypeRequired | choice |
| ID | text |
TitleRequired | text |
SettingsRequired | object |
| Field | Type |
|---|---|
| Status | text |
| Message | object |
| Type | text |
| Code | text |
| Name | text |
| Description | text |
| Abandoned Cart Notifications | text |
Set a Category Published
ActionPublication state of a category.
| Field | Type |
|---|---|
CategoryRequired | choice |
PublishedRequired | boolean |
| Field | Type |
|---|---|
| Status | text |
| Message | object |
| Type | text |
| Code | text |
| Name | text |
| Description | text |
Set a Coupon Note
ActionInternal remark attached to a coupon.
| Field | Type |
|---|---|
CouponRequired | choice |
NoteRequired | text |
| Field | Type |
|---|---|
| Status | text |
| Message | object |
| Type | text |
| Code | text |
| Name | text |
| Description | text |
Set a Manual Product Order
ActionCustom product display order.
| Field | Type |
|---|---|
Product IDsRequired | array |
| Category | choice |
Set Bulk Coupon Status
ActionMass activation of coupons.
| Field | Type |
|---|---|
Coupons IDsRequired | array |
ActiveRequired | boolean |
| Field | Type |
|---|---|
| Status | text |
| Message | object |
| Type | text |
| Code | text |
| Name | text |
| Description | text |
Set Coupon Status
ActionTurns a coupon code on or off.
| Field | Type |
|---|---|
CouponRequired | choice |
ActiveRequired | boolean |
| Field | Type |
|---|---|
| Coupon ID | number |
| ID | number |
| Store ID | number |
| Store Name | text |
| Store Logo | text |
| Code | text |
| Uses Total | number |
| Created At | text |
34other output fields
Set Customer Tags
ActionFull tag list for a customer.
| Field | Type |
|---|---|
CustomerRequired | choice |
TagsRequired | array |
| Field | Type |
|---|---|
| ID | number |
| Name | text |
| text | |
| Mobile | text |
| Gender | text |
| Birth Date | text |
| Verified | boolean |
| Is Active | boolean |
17other output fields
Set the Category Nesting
ActionReorders the category hierarchy.
| Field | Type |
|---|---|
DataRequired | array |
| Data | object |
| Field | Type |
|---|---|
| Status | text |
| Message | text |
Set the Product Stock at a Location
ActionStock counts for one place.
| Field | Type |
|---|---|
LocationRequired | choice |
Stock RowsRequired | array |
| Stock Row | object |
Update a Bundle Offer
ActionRevised bundle discount rule.
| Field | Type |
|---|---|
Bundle OfferRequired | choice |
| Code | choice |
| Name | object |
| English | text |
| Arabic | text |
| Description | object |
| English | text |
| Arabic | text |
| Total Uses | number |
| Uses per Customer | number |
| Conditions Match | choice |
| Status | choice |
6other input fields
| Field | Type |
|---|---|
| ID | text |
| Name | object |
| English | text |
| Arabic | text |
| Description | object |
| English | text |
| Arabic | text |
| Code | text |
| Conditions | array |
| Actions | array |
| Conditions Criteria | text |
| Uses Total | number |
10other output fields
Update a Category
ActionRevised store category with new texts.
| Field | Type |
|---|---|
CategoryRequired | choice |
| Name | object |
| Arabic | text |
| English | text |
| Description | object |
| Arabic | text |
| English | text |
| Img Alt Text | object |
| Arabic | text |
| English | text |
| Category URL | text |
| Category Title | object |
| Arabic | text |
| English | text |
| Category Description | object |
| Arabic | text |
| English | text |
| Parent ID | choice |
1other input field
| Field | Type |
|---|---|
| ID | number |
| Name | object |
| Arabic | text |
| English | text |
| Slug | text |
| Description | text |
| Image | object |
| Path | text |
| Thumbnail | text |
| Parent ID | text |
| Children | array |
| Products Count | number |
Update a Coupon
ActionRevised discount code with new limits.
| Field | Type |
|---|---|
CouponRequired | choice |
NameRequired | text |
CodeRequired | text |
Discount TypeRequired | choice |
DiscountRequired | text |
| Status | choice |
| Applying Method | choice |
| Apply To | choice |
20other input fields
| Field | Type |
|---|---|
| Coupon ID | number |
| ID | number |
| Store ID | number |
| Store Name | text |
| Store Logo | text |
| Code | text |
| Uses Total | number |
| Created At | text |
29other output fields
Update a Custom Input Field
ActionRevised free-entry field.
| Field | Type |
|---|---|
ProductRequired | choice |
Input FieldRequired | text |
| Type | text |
| Label | object |
EnglishRequired | text |
ArabicRequired | text |
| Hint | object |
| English | text |
| Arabic | text |
| Price | number |
| Required | choice |
| Published | choice |
3other input fields
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Hint | object |
| English | text |
| Arabic | text |
| Label | object |
| English | text |
| Arabic | text |
| Display Order | number |
| Is Required | boolean |
| Price | number |
| Formatted Price | text |
3other output fields
Update a Custom Option
ActionRevised option on a product page.
| Field | Type |
|---|---|
ProductRequired | choice |
OptionRequired | text |
| Label | object |
ArabicRequired | text |
EnglishRequired | text |
| Hint | object |
ArabicRequired | text |
EnglishRequired | text |
| Type | text |
| Min Choices | number |
| Max Choices | number |
| Can Choose Multiple Options | choice |
5other input fields
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Label | object |
| Arabic | text |
| English | text |
| Hint | object |
| Arabic | text |
| English | text |
| Min Choices | number |
| Max Choices | number |
| Can Choose Multiple Options | boolean |
| Is Published | boolean |
4other output fields
Update a Customer
ActionRevised customer record with new details.
| Field | Type |
|---|---|
CustomerRequired | choice |
| Type | choice |
| Name | text |
| Mobile | text |
| text | |
| Gender | choice |
| Birth Date | date |
| Business Name | text |
3other input fields
| Field | Type |
|---|---|
| ID | number |
| Name | text |
| text | |
| Mobile | text |
| Gender | text |
| Birth Date | text |
| Verified | boolean |
| Is Active | boolean |
17other output fields
Update a Location
ActionRevised inventory location with new details.
| Field | Type |
|---|---|
LocationRequired | choice |
| Name | text |
| Coordinates | object |
LatitudeRequired | text |
LongitudeRequired | text |
| Full Address | text |
| Default Location | choice |
| Private | choice |
| Enabled | choice |
| Short Address | text |
1other input field
| Field | Type |
|---|---|
| ID | text |
| Name | object |
| Arabic | text |
| English | text |
| City | object |
| ID | number |
| Name | text |
| Arabic Name | text |
| Country | object |
| Country Code | text |
| Type | text |
| Coordinates | object |
| Latitude | number |
| Longitude | number |
| Full Address | text |
| Short Address | text |
| District | text |
8other output fields
Update a Product
ActionRevised catalog item with new data.
| Field | Type |
|---|---|
ProductRequired | choice |
| Name | object |
ArabicRequired | text |
EnglishRequired | text |
| Description | object |
ArabicRequired | text |
EnglishRequired | text |
| Short Description | object |
ArabicRequired | text |
EnglishRequired | text |
| SKU | text |
| Barcode | text |
| Price | number |
| Sale Price | number |
12other input fields
| Field | Type |
|---|---|
| ID | text |
| Product Class | text |
| SKU | text |
| Barcode | text |
| Parent ID | text |
| Name | object |
| Arabic | text |
| English | text |
| Slug | text |
| Price | number |
46other output fields
Update a Product Image Order
ActionChanges the position of a picture.
| Field | Type |
|---|---|
ProductRequired | choice |
ImageRequired | choice |
Display OrderRequired | number |
| Field | Type |
|---|---|
| ID | text |
| Image | object |
| Large | text |
| Small | text |
| Full Size | text |
| Medium | text |
| Thumbnail | text |
| Alt Text | text |
| Display Order | number |
Update a Product Stock
ActionRevised inventory record for one place.
| Field | Type |
|---|---|
ProductRequired | choice |
StockRequired | choice |
LocationRequired | choice |
Available QuantityRequired | number |
Unlimited StockRequired | boolean |
| Field | Type |
|---|---|
| Product ID | text |
| Location | text |
| Quantity | number |
| Is Infinite | boolean |
Update an Attribute
ActionRetitles a product property.
| Field | Type |
|---|---|
AttributeRequired | choice |
NameRequired | object |
| Arabic | text |
| English | text |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Slug | text |
| Presets | array |
| Is Extra | boolean |
| Is Enabled | boolean |
| Display Order | number |
| Preset Count | text |
Update an Attribute Preset
ActionEdits one attribute value.
| Field | Type |
|---|---|
AttributeRequired | choice |
PresetRequired | choice |
ValueRequired | object |
| Arabic | text |
| English | text |
| Field | Type |
|---|---|
| ID | text |
| Slug | text |
| Name | text |
| Value | text |
| Type | text |
| Type Value | text |
| Display Order | text |
| Attribute Image ID | text |
1other output field
Update Bulk Coupons
ActionSame discount rules on many coupons.
| Field | Type |
|---|---|
Coupons IDsRequired | array |
Discount TypeRequired | choice |
DiscountRequired | text |
| Free Shipping | choice |
| Free COD | choice |
| Minimum Cart Total | text |
| Maximum Cart Total | text |
| Maximum Cart Weight (kg) | number |
17other input fields
| Field | Type |
|---|---|
| Status | text |
| Message | object |
| Type | text |
| Code | text |
| Name | text |
| Description | text |
Update Product Stock in Bulk
ActionStock levels across several locations together.
| Field | Type |
|---|---|
ProductRequired | choice |
Stock RowsRequired | array |
| Stock Row | object |
Update Products in Bulk
ActionShared edits across many products.
| Field | Type |
|---|---|
Product IDsRequired | array |
| Name | object |
| Arabic | text |
| English | text |
| Description | object |
| Arabic | text |
| English | text |
| Weight | object |
| Value | number |
| Unit | text |
| Keywords | array |
| Field | Type |
|---|---|
| ID | text |
| Product Class | text |
| SKU | text |
| Barcode | text |
| Parent ID | text |
| Name | object |
| Arabic | text |
| English | text |
| Slug | text |
| Price | number |
46other output fields
Update Return Products
ActionReceipt counts for returned goods.
| Field | Type |
|---|---|
Order Reverse IDRequired | text |
ProductsRequired | array |
| Product | object |
| Field | Type |
|---|---|
| ID | text |
| Store ID | text |
| Order ID | number |
| Is Partial | number |
| Consignee Name | text |
| Consignee Mobile | text |
| Consignee City | object |
| ID | number |
| Country ID | number |
| Zone ID | number |
| Name | text |
| Arabic Name | text |
| Code | text |
| Status | number |
| Priority | number |
| Created At | text |
| Updated At | text |
| Consignee Address 1 | text |
13other output fields
Upload a Product Image
ActionNew gallery picture for a product.
| Field | Type |
|---|---|
ProductRequired | choice |
ImageRequired | text |
File NameRequired | text |
Alt TextRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Image | object |
| Full Size | text |
| Medium | text |
| Large | text |
| Small | text |
| Thumbnail | text |
| Alt Text | text |
| Display Order | number |
Validate an Order
ActionDry-run check of an order payload.
| Field | Type |
|---|---|
Currency CodeRequired | text |
CustomerRequired | object |
Full NameRequired | text |
Mobile Country CodeRequired | text |
Mobile NumberRequired | text |
| text | |
ConsigneeRequired | object |
ContactRequired | object |
AddressRequired | object |
Gift OrderRequired | boolean |
Notify Gift RecipientRequired | boolean |
ProductsRequired | array |
| Product | object |
Shipping Method TypeRequired | text |
Shipping MethodRequired | choice |
4other input fields
| Field | Type |
|---|---|
| Code | text |
| Message | text |
Templates
Look for Zid templates in the WEXTL template library.
Browse templates →Other commerce integrations on WEXTL
Loyverse[2]Point of sale for retail stores and restaurants, with inventory.
SallaCommerce platform for products, orders, customers, and store operations.
BigCommerceEcommerce platform for online stores, catalogs, orders, and customers.
Amazon Seller PartnerAmazon API for selling partners to manage orders, listings, inventory and reports.
UnleashedCloud inventory management for products, stock, and orders.
References
- WEXTL® Zid Source Code connector implementation.
- Our users use cases and automations.
- Official API Documentation for Zid.
- WEXTL® visual workflow builder data.
Last updated: Nov 14, 2026 14:55
How we write our apps documentation
How we compile these docs: sources, the role of AI, and how we verify.


























