Skip to docs navigation

Zid integration guide

Verified

How 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].

Open Zid on WEXTL →
  • Zid
  • WEXTL
  • Loyverse
  • Salla
  • BigCommerce
  • Amazon Seller Partner
  • Unleashed
  • Recharge
  • Booqable
  • ShipStation
  • Shipday
  • BoxHero
  • Lightspeed Retail
  • Hotmart
  • DHL
  • ShipEngine
  • Onfleet
  • Shippo
  • Gift Up
  • MemberPress
  • Patreon
  • SamCart
  • Ticket Tailor
  • Chowdeck
  • Glovo
  • Printavo
  • Sharetribe
  • Speedaf Express
Credential type option 1

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]

Credential type option 2

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]

  1. 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.
  2. Optional: In the Credential name field, enter a name for the credential.
  3. Enter the authentication credentials you copied from your Zid account, or follow the on-screen instructions to create the credential.
  4. If prompted, authenticate your account and confirm access.
  5. If you want to make changes to your credential in the future, follow the steps in Manage credentials →

Watch Events

TriggerInstant trigger for Zid store events.
Output fields[3]
FieldType
Eventtext
IDnumber
Invoice Numbernumber
Codetext
Store IDnumber
Order Urltext
Store Nametext
Shipping Method Codetext

110other output fields

Count Reviews

SearchReview totals per moderation state.
Input fields[3]
FieldType
StatusRequired
choice
Output fields[3]
FieldType
Statustext
Countnumber
Messageobject
Typetext
Codetext
Nametext
Descriptiontext

Find a Customer by Phone

SearchCustomer lookup from a phone number.
Input fields[3]
FieldType
Customer PhoneRequired
text
Output fields[3]
FieldType
IDnumber
Nametext
Emailtext
Mobiletext
Gendertext
Birth Datetext
Verifiedboolean
Is Activeboolean

8other output fields

Get a Brand

SearchLogo, description and SEO fields of a brand.
Input fields[3]
FieldType
BrandRequired
choice
Output fields[3]
FieldType
IDtext
Nametext
Slugtext
Descriptionobject
Arabictext
Englishtext
Logotext
Seo Titleobject
Arabictext
Englishtext
Seo Contentobject
Arabictext
Englishtext
Is Activeboolean

4other output fields

Get a Bundle Offer

SearchSetup of one bundle deal.
Input fields[3]
FieldType
Bundle OfferRequired
choice
Output fields[3]
FieldType
IDtext
Nameobject
Englishtext
Arabictext
Descriptionobject
Arabictext
Englishtext
Codetext
Conditionsarray
Actionsarray
Conditions Criteriatext
Uses Totaltext

9other output fields

Get a Category

SearchDetails of one product category.
Input fields[3]
FieldType
CategoryRequired
choice
Output fields[3]
FieldType
IDnumber
Nametext
UUIDtext
Slugtext
SEO Category Titletext
SEO Category Descriptiontext
I18n SEO Category Titleobject
Arabictext
Englishtext
I18n SEO Category Descriptionobject
Arabictext
Englishtext

15other output fields

Get a Coupon

SearchUsage and rules of one coupon.
Input fields[3]
FieldType
CouponRequired
choice
Output fields[3]
FieldType
Coupon IDnumber
IDnumber
Store IDnumber
Store Nametext
Store Logotext
Codetext
Uses Totalnumber
Created Attext

32other output fields

Get a Customer

SearchName, contact and birth data of a customer.
Input fields[3]
FieldType
CustomerRequired
choice
Output fields[3]
FieldType
IDnumber
Nametext
Emailtext
Mobiletext
Gendertext
Birth Datetext
Verifiedboolean
Is Activeboolean

16other output fields

Get a Customer Loyalty Summary

SearchLoyalty points position of a customer.
Input fields[3]
FieldType
Customer IDRequired
choice
Output fields[3]
FieldType
Points Balancenumber
Pending Points Balancenumber
Pending Negative Points Balancenumber
Available Poitnsnumber
Used Poitnsnumber
Total Positive Pointsnumber
Historyarray

Get a Customer Profile

SearchProfile page content of a customer.
Input fields[3]
FieldType
CustomerRequired
choice
Output fields[3]
FieldType
IDnumber
Nametext
Mobiletext
Emailtext
Gendertext
Birth Datetext
Notetext
Verifiedboolean

22other output fields

Get a Customer Ticket

SearchSupport ticket raised by a customer.
Input fields[3]
FieldType
TicketRequired
text
Output fields[3]
FieldType
IDtext
Order IDnumber
Store IDnumber
Customer IDnumber
Customer Phonetext
Typetext
Reasontext
Additional Detailstext

5other output fields

Get a Customer Wallet Balance

SearchMoney in a customer store wallet.
Input fields[3]
FieldType
CustomerRequired
choice
Output fields[3]
FieldType
Total Balancenumber
Balancenumber
Held Balancenumber
Currencytext
Pending Cashbacknumber

Get a Location

SearchDetails of an inventory location.
Input fields[3]
FieldType
LocationRequired
choice
Output fields[3]
FieldType
IDtext
Nameobject
Arabictext
Cityobject
IDnumber
Nametext
Arabic Nametext
Countryobject
Country Codetext
Typetext
Coordinatesobject
Latitudenumber
Longitudenumber
Full Addresstext
Short Addresstext
Districttext

8other output fields

Get a Product

SearchIdentity and codes of a catalog item.
Input fields[3]
FieldType
ProductRequired
choice
Output fields[3]
FieldType
IDtext
Product Classtext
SKUtext
Barcodetext
Parent IDtext
Nameobject
Arabictext
Slugtext
Pricenumber

47other output fields

Get a Product Stock

SearchInventory of a product at one place.
Input fields[3]
FieldType
ProductRequired
choice
StockRequired
choice
Output fields[3]
FieldType
IDtext
Locationobject
IDtext
Nametext
Typetext
Full Addresstext
Available Quantitytext
Is Infiniteboolean

Get an Abandoned Cart

SearchDetails of a cart left behind.
Input fields[3]
FieldType
CartRequired
choice
Output fields[3]
FieldType
IDtext
URLtext
Store IDtext
Store Nametext
Store Logotext
Store URLtext
Products Countnumber
Productsarray

15other output fields

Get an Attribute

SearchOne attribute together with its allowed values.
Input fields[3]
FieldType
AttributeRequired
choice
Output fields[3]
FieldType
IDtext
Nametext
Slugtext
Presetsarray
Is Extraboolean
Is Enabledboolean
Display Ordertext
Preset Countnumber

Get an Order

SearchComplete record of a placed order.
Input fields[3]
FieldType
OrderRequired
choice
Output fields[3]
FieldType
IDnumber
Invoice Numbernumber
Codetext
Store IDnumber
Order URLtext
Store Nametext
Shipping Method Codetext
Store URLtext

66other output fields

Get an Order for a Return

SearchOrder data prepared for returns.
Input fields[3]
FieldType
OrderRequired
choice
Output fields[3]
FieldType
IDnumber
Invoice Numbernumber
Codetext
Store IDnumber
Order Statusobject
Nametext
Codetext
Payment Statustext
Currency Codetext
Order Totalnumber

5other output fields

Get Loyalty Analytics

SearchLoyalty results over a period.
Input fields[3]
FieldType
Date FromRequired
date
Date ToRequired
date
Output fields[3]
FieldType
Total Earned Pointsnumber
Total Redeemed Pointsnumber
Total Pending Pointsnumber
Total Customers With Pointsnumber
Total Customersnumber
Total Customers With Redeemed Pointsnumber
Total Redemption Countnumber

Get Loyalty Settings

SearchConfiguration of the loyalty program.
Output fields[3]
FieldType
Is Activeboolean
Is Trialboolean
End Trialboolean
Expiration Periodnumber
Redemption Sort Directiontext
Cashback Rulesarray
Redemption Rulesarray

Get Order Highlights

SearchSnapshot of recent order activity.
Input fields[3]
FieldType
Order Indextext
Output fields[3]
FieldType
Orders Countnumber
Order Indextext
Order IDnumber
Order Datetext

Get Store Languages and Currencies

SearchLanguage and money setup of the store.
Output fields[3]
FieldType
Languageobject
IDnumber
Nametext
Codetext
Directiontext
Languagesarray
Currencyobject
IDnumber
Nametext
Codetext
Symboltext
Countryobject
Currenciesarray

Get the App Subscription

SearchBilling state of the app in the store.
Output fields[3]
FieldType
App IDnumber
Store IDnumber
Store URLtext
Plan Nametext
Subscription Statustext
Start Datetext
End Datetext
Merchant Phone Notext

5other output fields

Get the Current Manager

SearchThe manager behind the credential.
Output fields[3]
FieldType
IDnumber
UUIDtext
Nametext
Emailtext
Mobiletext
Mobile Objectobject
Country Codetext
Mobiletext
Gendertext
Preferred Languagetext

1other output field

Get the Loyalty Status

SearchOn or off state of loyalty.
Output fields[3]
FieldType
Statustext
Loyalty Statusboolean
Messageobject
Typetext
Codetext
Nametext
Descriptiontext

Get the Manager Profile

SearchAccount details of the store manager.
Output fields[3]
FieldType
IDnumber
Old IDnumber
UUIDtext
Nametext
Usernametext
Emailtext
Email Pending Confirmationtext
Is Email Verifiedboolean

19other output fields

Get the Store

SearchBusiness details of your Zid store.
Output fields[3]
FieldType
IDnumber
UUIDtext
Titletext
Phonetext
Phone Objectobject
Country Codetext
Mobiletext
Emailtext
URLtext
Timezonetext

Get the Webhook Health

SearchDelivery health totals of webhooks.
Output fields[3]
FieldType
Healthynumber
Degradednumber
Brokennumber

Get VAT Settings

SearchHow the store handles value added tax.
Output fields[3]
FieldType
Can Use VATboolean
VAT Activateboolean
Is VAT Self Paidboolean
Is VAT Included In Product Priceboolean
Is Shipping Fee Included In VATboolean
Other Countries Tax Percentagenumber
Countriesarray

List Abandoned Carts

SearchCarts customers left unfinished.
Input fields[3]
FieldType
LimitRequired
number
Phasechoice
Search Termtext
Customer IDchoice
Has Reminderschoice
Created Fromdate
Created Todate
Sort Directionchoice

1other input field

Output fields[3]
FieldType
IDtext
Store IDtext
Session IDtext
URLtext
Cart IDtext
Order IDtext
Phasetext
Customer IDnumber

13other output fields

List Attribute Presets

SearchSelectable values for an attribute.
Input fields[3]
FieldType
LimitRequired
number
AttributeRequired
choice
Output fields[3]
FieldType
IDtext
Slugtext
Nametext
Valuetext
Typetext
Type Valuetext
Display Ordertext
Attribute Image IDtext

1other output field

List Attributes

SearchAll product attribute definitions.
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
IDtext
Nametext
Slugtext
Presetsarray
Is Extraboolean
Is Enabledboolean
Display Ordertext
Preset Countnumber

List Brands

SearchProduct brands of the store.
Input fields[3]
FieldType
LimitRequired
number
Searchtext
Activechoice
Output fields[3]
FieldType
IDtext
Nametext
Slugtext
Descriptionobject
Arabictext
Englishtext
Logotext
Seo Titleobject
Arabictext
Englishtext
Seo Contentobject
Arabictext
Englishtext
Is Activeboolean

4other output fields

List Broken Webhooks

SearchWebhooks that fail to deliver.
Input fields[3]
FieldType
LimitRequired
number

List Bundle Offers

SearchBundle deals defined in the store.
Input fields[3]
FieldType
LimitRequired
number
Codetext
Statuschoice
Search Termtext
Output fields[3]
FieldType
IDtext
Nameobject
Englishtext
Arabictext
Descriptionobject
Arabictext
Englishtext
Codetext
Conditionsarray
Actionsarray
Conditions Criteriatext
Uses Totaltext

9other output fields

List Categories

SearchProduct categories of the store.
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
IDnumber
UUIDtext
Nametext
Slugtext
SEO Category Titletext
SEO Category Descriptiontext
Namesobject
Englishtext
Arabictext
Descriptiontext

10other output fields

List Cities for a Country

SearchCities available inside a country.
Input fields[3]
FieldType
LimitRequired
number
CountryRequired
choice
Output fields[3]
FieldType
Nametext
IDnumber
National IDnumber
Prioritynumber
Country IDnumber
Country Nametext
Country Codetext
Arabic Nametext

1other output field

List Countries

SearchCountries known to Zid.
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
IDnumber
Nametext
Codetext
Country Codetext
Flagtext

List Coupons

SearchPromo codes defined for the store.
Input fields[3]
FieldType
LimitRequired
number
Search Termtext
Statuschoice
Date Fromdate
Date Todate
Date Filter Fieldchoice
Order Bychoice
Sort Directionchoice
Output fields[3]
FieldType
Coupon IDnumber
IDnumber
Store IDnumber
Store Nametext
Store Logotext
Codetext
Uses Totalnumber
Created Attext

27other output fields

List Custom Order Statuses

SearchOrder statuses together with their sub statuses.
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
IDnumber
Statustext
Codetext
Is Customizableboolean
Sub Statusesarray

List Customer Points History

SearchLoyalty point log of one shopper.
Input fields[3]
FieldType
LimitRequired
number
CustomerRequired
choice
Output fields[3]
FieldType
Datetext
Reasontext
Pointsnumber
Directiontext
Typetext
Order Numbertext
Order Codetext
Expiry Datetext

3other output fields

List Customer Tags

SearchLabels available for customers.
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
IDtext
Nametext
Store IDtext

List Customer Tickets

SearchSupport tickets raised by customers.
Input fields[3]
FieldType
LimitRequired
number
Statuschoice
Output fields[3]
FieldType
IDtext
Order IDnumber
Store IDnumber
Customer IDnumber
Customer Phonetext
Typetext
Reasontext
Additional Detailstext

5other output fields

List Customer Wallets

SearchWallet balances across customers.
Input fields[3]
FieldType
LimitRequired
number
Balance Fromnumber
Balance Tonumber
Expiring Within Daysnumber
Expiring Beforetext
Output fields[3]
FieldType
Customer IDnumber
Nametext
Phone Numbertext
Emailtext
Balancetext
Total Balancetext
Held Balancenumber
Currencytext

3other output fields

List Customers

SearchCustomers registered in the store.
Input fields[3]
FieldType
LimitRequired
number
Typechoice
Genderchoice
Search Termtext
Phonetext
Created Fromdate
Created Todate
Verified Phone Onlychoice
Output fields[3]
FieldType
IDnumber
Nametext
Emailtext
Mobiletext
Gendertext
Birth Datetext
Verifiedboolean
Is Activeboolean

16other output fields

List Customers (Basic)

SearchCompact customer listing for large stores.
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
IDnumber
Nametext
Emailtext
Mobiletext
Gendertext
Birth Datetext
Verifiedboolean
Is Activeboolean

13other output fields

List Locations

SearchPlaces where inventory is held.
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
IDtext
Nameobject
Arabictext
Cityobject
IDnumber
Nametext
Arabic Nametext
Countryobject
Country Codetext
Typetext
Coordinatesobject
Latitudenumber
Longitudenumber
Full Addresstext
Short Addresstext
Districttext

8other output fields

List Order Credit Notes

SearchRefund documents of an order.
Input fields[3]
FieldType
LimitRequired
number
OrderRequired
choice

List Order Fulfillment Locations

SearchStock sites able to ship an order.
Input fields[3]
FieldType
LimitRequired
number
OrderRequired
choice
Output fields[3]
FieldType
Inventory IDnumber
Inventory Nametext
Productsarray

List Order Tags

SearchTags that can be put on orders and their usage.
Input fields[3]
FieldType
LimitRequired
number
Nametext
Output fields[3]
FieldType
IDtext
Nametext
Store IDtext
User IDtext
Ordersarray

List Orders

SearchOrders placed in the store.
Input fields[3]
FieldType
LimitRequired
number
Response Detailchoice
Order Statuschoice
Payment Methodchoice
Customerchoice
Created Fromdate
Created Todate
Sort Directionchoice

11other input fields

Output fields[3]
FieldType
IDnumber
Invoice Numbernumber
Codetext
Store IDnumber
Order URLtext
Store Nametext
Shipping Method Codetext
Store URLtext

35other output fields

List Payment Methods

SearchWays customers can pay.
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
Enabledboolean
Codetext
Feesnumber
Fees Stringtext
Typetext
Nametext
Iconsarray
IDnumber

List Payment Options

SearchCheckout payment choices of the store.
Output fields[3]
FieldType
Statustext
Payment Optionsarray
Messageobject
Typetext
Codetext
Nametext
Descriptiontext

List Pending Cashbacks

SearchCashback waiting for a customer.
Input fields[3]
FieldType
LimitRequired
number
CustomerRequired
choice
Output fields[3]
FieldType
IDtext
Store IDnumber
Customer IDnumber
Order IDnumber
Amounttext
Currencytext
Expiry Daysnumber
Statustext

3other output fields

List Product Badges

SearchBadge labels available for products.
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
Bodyobject
Arabictext
Englishtext
Is Exampleboolean
Iconobject
Codetext

List Product Images

SearchGallery pictures belonging to a product.
Input fields[3]
FieldType
LimitRequired
number
ProductRequired
choice
Output fields[3]
FieldType
IDtext
Imageobject
Largetext
Mediumtext
Smalltext
Full Sizetext
Thumbnailtext
Alt Texttext
Display Ordernumber

List Product Questions

SearchShopper questions found on a product.
Input fields[3]
FieldType
LimitRequired
number
ProductRequired
choice
Output fields[3]
FieldType
IDtext
Storetext
Producttext
Product Nametext
Customertext
Nametext
Emailtext
Is Anonymousboolean

7other output fields

List Product Settings

SearchStore-wide product display settings.
Output fields[3]
FieldType
Extended Search Supportboolean
Related Products Statusboolean
Related Products Countnumber
Sold Products Count Statusboolean
Min Sold Products Countnumber
Default Products Orderingtext
Has Products Filtrationboolean
Is Wishlist Enabledboolean

1other output field

List Product Stock

SearchInventory of a product by place.
Input fields[3]
FieldType
LimitRequired
number
ProductRequired
choice
Output fields[3]
FieldType
IDtext
Locationobject
IDtext
Nametext
Typetext
Full Addresstext
Available Quantitytext
Is Infiniteboolean

List Products

SearchProducts of the store catalog.
Input fields[3]
FieldType
LimitRequired
number
Product Classchoice
Publishedchoice
Quantity Fromnumber
Quantity Tonumber
Categorieschoice
Searchtext
Order Bychoice

3other input fields

Output fields[3]
FieldType
IDtext
Product Classtext
SKUtext
Barcodetext
Parent IDtext
Nameobject
Arabictext
Englishtext
Slugtext
Pricenumber

40other output fields

List Question Answers

SearchReplies to a product question.
Input fields[3]
FieldType
LimitRequired
number
QuestionRequired
choice
Output fields[3]
FieldType
IDtext
Question IDtext
Answertext
Created Attext

List Return Reasons

SearchReturn causes defined in the store.
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
IDtext
Nametext

List Reviews

SearchShopper reviews and ratings.
Input fields[3]
FieldType
LimitRequired
number
Review TypeRequired
choice
Statuschoice
Search Termtext
Created Fromdate
Created Todate
Order Bychoice
Sort Directionchoice
Output fields[3]
FieldType
IDtext
Customerobject
IDnumber
Nametext
Productobject
IDtext
Nametext
Bought This Itemboolean
Imagetext
Statustext
Is Anonymousboolean
Ratingnumber
Commenttext
Edit Requestedboolean

5other output fields

List Shipping Methods

SearchDelivery options of the store.
Input fields[3]
FieldType
LimitRequired
number
Payload TypeRequired
text
Output fields[3]
FieldType
IDnumber
Nametext
System Option Codetext
Select Citiesarray
Shipping Method Statustext

List Store Countries

SearchStore countries with codes and flags.
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
IDnumber
Nametext
Codetext
Country Codetext
Flagtext

List Store Questions

SearchQuestions from every product page.
Input fields[3]
FieldType
LimitRequired
number
Anonymouschoice
Asked by the Storechoice
Publishedchoice
Newchoice
Questiontext
Created Fromdate
Created Todate

1other input field

Output fields[3]
FieldType
IDnumber
Productnumber
Product Nametext
Customertext
Nametext
Emailtext
Is Anonymousboolean
Is Ownerboolean

5other output fields

List Wallet Transactions

SearchMoney history of a customer wallet.
Input fields[3]
FieldType
LimitRequired
number
CustomerRequired
choice
Output fields[3]
FieldType
Transaction IDtext
Transaction Numbertext
Amounttext
Currencytext
Typetext
Statustext
Descriptiontext
Order IDnumber

2other output fields

List Webhooks

SearchRegistered webhook subscriptions of the store.
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
IDtext
Eventtext
Target URLtext
Store IDtext
Conditionsarray
Original IDtext
Subscribertext
Activeboolean

1other output field

Add a Customer

ActionNew store customer with contact and company details.
Input fields[3]
FieldType
TypeRequired
choice
NameRequired
text
MobileRequired
text
Emailtext
Genderchoice
Business Nametext
Tax Numbertext
Commercial Registrationtext
Output fields[3]
FieldType
IDnumber
Nametext
Emailtext
Mobiletext
Gendertext
Birth Datetext
Verifiedboolean
Is Activeboolean

17other output fields

Add a Customer Tag

ActionGives a customer record a label.
Input fields[3]
FieldType
CustomerRequired
choice
NameRequired
text
Output fields[3]
FieldType
IDnumber
Nametext
Emailtext
Mobiletext
Gendertext
Birth Datetext
Verifiedboolean
Is Activeboolean

17other output fields

Add a Product to a Category

ActionLinks a catalog item to a section of the store.
Input fields[3]
FieldType
ProductRequired
choice
CategoryRequired
choice
Output fields[3]
FieldType
IDtext
Nametext
Slugtext
Descriptiontext
Cover Imagetext
Imagetext
Display Ordernumber
Metaobject
Childsarray
Parentsarray

Add a Return Reason

ActionSelectable cause for product returns.
Input fields[3]
FieldType
NameRequired
text
Output fields[3]
FieldType
IDtext
Nametext

Add an Order Comment

ActionRecords a progress comment on an order.
Input fields[3]
FieldType
OrderRequired
choice
CommentRequired
text
Output fields[3]
FieldType
IDnumber
Invoice Numbernumber
Codetext
Store IDnumber
Order URLtext
Store Nametext
Store URLtext
Order Statusobject
Nametext
Codetext

12other output fields

Add an Order Tag

ActionLabel attached to an order.
Input fields[3]
FieldType
OrderRequired
choice
NameRequired
text
Output fields[3]
FieldType
IDtext
Nametext
Store IDtext
User IDtext
Ordersarray

Add Customers in Bulk

ActionBatch registration of store customers.
Input fields[3]
FieldType
CustomersRequired
array
Customerobject
Output fields[3]
FieldType
Statustext
Customersarray
Messageobject
Typetext
Codetext
Nametext
Descriptiontext

Add Products to a Category in Bulk

ActionMulti-category assignment for a product.
Input fields[3]
FieldType
ProductRequired
choice
Category IDsRequired
array

Adjust Customer Points

ActionManual loyalty balance change.
Input fields[3]
FieldType
Customer IDRequired
choice
DirectionRequired
choice
PointsRequired
number
Reasontext
Output fields[3]
FieldType
Datetext
Reasontext
Pointsnumber
Directiontext
Typetext
Order Numbertext
Expiry Datetext
Point Statustext

1other output field

Calculate Return Totals

ActionPreview of the amounts for a return.
Input fields[3]
FieldType
Order IDRequired
choice
Partial ReturnRequired
boolean
Productsarray
Productobject
Output fields[3]
FieldType
Invoicearray

Change an Order Status

ActionAdvances or cancels an order.
Input fields[3]
FieldType
OrderRequired
choice
Order StatusRequired
choice
Tracking Numbertext
Tracking URLtext
Waybill URLtext
Commenttext
Inventory Location IDchoice
Marketplace Cancellation Reasonchoice
Output fields[3]
FieldType
IDnumber
Invoice Numbernumber
Codetext
Store IDnumber
Order URLtext
Store Nametext
Shipping Method Codetext
Store URLtext

67other output fields

Create a Bundle Offer

ActionRule-based product bundle discount.
Input fields[3]
FieldType
CodeRequired
choice
NameRequired
object
Englishtext
Arabictext
ConditionsRequired
text
ActionsRequired
text
Descriptionobject
Englishtext
Arabictext
Total Usesnumber
Uses per Customernumber
Conditions Matchchoice

4other input fields

Output fields[3]
FieldType
IDtext
Nameobject
Englishtext
Arabictext
Descriptionobject
Englishtext
Arabictext
Codetext
Conditionsarray
Actionsarray
Conditions Criteriatext
Uses Totalnumber

10other output fields

Create a Category

ActionNew section of the product catalog.
Input fields[3]
FieldType
NameRequired
object
Arabictext
Englishtext
DescriptionRequired
object
Arabictext
Englishtext
Parent Categorychoice
Output fields[3]
FieldType
IDnumber
Nametext
UUIDtext
Slugtext
SEO Category Titletext
SEO Category Descriptiontext
I18n SEO Category Titleobject
Arabictext
Englishtext
I18n SEO Category Descriptionobject
Arabictext
Englishtext

15other output fields

Create a Coupon

ActionDiscount code with usage limits.
Input fields[3]
FieldType
NameRequired
text
Discount TypeRequired
choice
Codetext
Discountnumber
Free Shippingboolean
Free CODboolean
Statusboolean
Applying Methodchoice

18other input fields

Output fields[3]
FieldType
Coupon IDnumber
IDnumber
Store IDnumber
Store Nametext
Store Logotext
Codetext
Uses Totalnumber
Created Attext

34other output fields

Create a Custom Input Field

ActionFree-entry field on a product page.
Input fields[3]
FieldType
ProductRequired
choice
TypeRequired
text
LabelRequired
object
EnglishRequired
text
ArabicRequired
text
Hintobject
Englishtext
Arabictext
Pricenumber
Requiredboolean
Publishedboolean
Display Ordernumber

1other input field

Output fields[3]
FieldType
IDtext
Typetext
Hintobject
Englishtext
Arabictext
Labelobject
Englishtext
Arabictext
Display Ordernumber
Is Requiredboolean
Pricenumber
Formatted Pricetext

3other output fields

Create a Custom Option

ActionPick-list option on a product.
Input fields[3]
FieldType
ProductRequired
choice
LabelRequired
object
ArabicRequired
text
EnglishRequired
text
ChoicesRequired
array
Choiceobject
Hintobject
ArabicRequired
text
EnglishRequired
text
Typetext
Min Choicesnumber
Max Choicesnumber
Can Choose Multiple Optionsboolean

3other input fields

Output fields[3]
FieldType
IDtext
Typetext
Labelobject
Arabictext
Englishtext
Hintobject
Arabictext
Englishtext
Min Choicesnumber
Max Choicesnumber
Can Choose Multiple Optionsboolean
Is Publishedboolean

4other output fields

Create a Location

ActionNew inventory location for the store.
Input fields[3]
FieldType
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

Output fields[3]
FieldType
IDtext
Nameobject
Englishtext
Cityobject
IDnumber
Nametext
Arabic Nametext
Countryobject
Country Codetext
Typetext
Coordinatesobject
Latitudenumber
Longitudenumber
Full Addresstext
Short Addresstext
Districttext

8other output fields

Create a Product

ActionNew catalog item with bilingual name.
Input fields[3]
FieldType
PriceRequired
number
SKURequired
text
NameRequired
object
ArabicRequired
text
EnglishRequired
text
Sale Pricenumber
Draftboolean
Unlimited Stockboolean
Quantitynumber
Requires Shippingboolean

1other input field

Output fields[3]
FieldType
IDtext
Nameobject
Arabictext
Englishtext
Product Classtext
SKUtext
Pricenumber
Is Draftboolean
Is Publishedboolean
Requires Shippingboolean

2other output fields

Create a Product Answer

ActionStore reply to a product question.
Input fields[3]
FieldType
ProductRequired
choice
QuestionRequired
choice
AnswerRequired
text
Output fields[3]
FieldType
IDtext
Question IDtext
Answertext
Created Attext

Create a Product Question

ActionNew question on a product listing page.
Input fields[3]
FieldType
ProductRequired
choice
QuestionRequired
text
Output fields[3]
FieldType
IDtext
Storetext
Producttext
Product Nametext
Customertext
Nametext
Emailtext
Is Anonymousboolean

7other output fields

Create a Product Stock

ActionInventory record for a product and place.
Input fields[3]
FieldType
ProductRequired
choice
LocationRequired
choice
Available QuantityRequired
number
Unlimited StockRequired
boolean
Output fields[3]
FieldType
IDtext
Locationtext
Available Quantitynumber
Is Infiniteboolean

Create a Return Order

ActionNew return request against an order.
Input fields[3]
FieldType
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

Output fields[3]
FieldType
IDtext
Store IDtext
Order IDnumber
Is Partialboolean
Consignee Nametext
Consignee Mobiletext
Consignee Cityobject
IDnumber
Country IDnumber
Zone IDnumber
Nametext
Arabic Nametext
Codetext
Statusnumber
Prioritynumber
Created Attext
Updated Attext
Consignee Address 1text

13other output fields

Create a Return Refund

ActionMoney returned to the buyer after a return.
Input fields[3]
FieldType
Order Reverse IDRequired
text
AmountRequired
number
Payment MethodRequired
choice
Notestext
Output fields[3]
FieldType
IDtext
Store IDtext
Order IDnumber
Is Partialnumber
Consignee Nametext
Consignee Mobiletext
Consignee Cityobject
IDnumber
Country IDnumber
Zone IDnumber
Nametext
Arabic Nametext
Codetext
Statusnumber
Prioritynumber
Created Attext
Updated Attext
Consignee Address 1text

13other output fields

Create a Return Waybill

ActionZidShip label for a return.
Input fields[3]
FieldType
Order IDRequired
choice
Standalone ZidShip WaybillRequired
boolean
Output fields[3]
FieldType
IDtext
Store IDtext
Order IDnumber
Consignee Nametext
Consignee Mobiletext
Consignee Cityobject
IDnumber
Countryobject
Arabic Nametext
English Nametext
Nametext
Prioritynumber
Consignee Address 1text
Consignee Address 2text

3other output fields

Create an Attribute

ActionNew product attribute with a bilingual name.
Input fields[3]
FieldType
NameRequired
object
Arabictext
Englishtext
Output fields[3]
FieldType
IDtext
Nametext
Slugtext
Presetsarray
Is Extraboolean
Is Enabledboolean
Display Ordertext
Preset Counttext

Create an Attribute Preset

ActionSelectable value of an attribute.
Input fields[3]
FieldType
AttributeRequired
choice
ValueRequired
object
Arabictext
Englishtext
Output fields[3]
FieldType
IDtext
Slugtext
Nametext
Valuetext
Typetext
Type Valuetext
Display Ordertext
Attribute Image IDtext

1other output field

Create an Order

ActionDraft order built from products and delivery data.
Input fields[3]
FieldType
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
Productobject
Shipping Method TypeRequired
text
Shipping MethodRequired
choice

4other input fields

Output fields[3]
FieldType
IDnumber
Invoice Numbernumber
Codetext
Store IDnumber
Order URLtext
Store Nametext
Shipping Method Codetext
Store URLtext

67other output fields

Create Product Variants

ActionAttribute-based variations of a product.
Input fields[3]
FieldType
ProductRequired
choice
VariantsRequired
array
Variantobject
Output fields[3]
FieldType
IDtext
Nameobject
Arabictext
Englishtext
SKUtext
Slugtext
Currencytext
Currency Symboltext
Pricenumber
Sale Pricetext

27other output fields

Credit a Customer Wallet

ActionMoney added to a customer wallet.
Input fields[3]
FieldType
CustomerRequired
choice
AmountRequired
number
Reasontext
Expires Atdate
Output fields[3]
FieldType
Messagetext
Transaction IDtext
Amounttext

Debit a Customer Wallet

ActionMoney deducted from a customer wallet.
Input fields[3]
FieldType
CustomerRequired
choice
AmountRequired
number
Reasontext
Output fields[3]
FieldType
Messagetext
Transaction IDtext
Amounttext

Delete a Bundle Offer

ActionRemoves a single bundle deal.
Input fields[3]
FieldType
Bundle OfferRequired
choice

Delete a Category

ActionClears one product section out of the catalog.
Input fields[3]
FieldType
CategoryRequired
choice
Output fields[3]
FieldType
Statustext
Messagetext

Delete a Coupon

ActionRemoves one coupon code from the store.
Input fields[3]
FieldType
CouponRequired
choice
Output fields[3]
FieldType
Statustext
Messageobject
Typetext
Codetext
Nametext
Descriptiontext

Delete a Custom Input Field

ActionA buyer-entry field no longer on the product.
Input fields[3]
FieldType
ProductRequired
choice
Input FieldRequired
text

Delete a Custom Option

ActionA pick-list choice taken off the product.
Input fields[3]
FieldType
ProductRequired
choice
OptionRequired
text

Delete a Customer

ActionDeletes a shopper from the customer list.
Input fields[3]
FieldType
CustomerRequired
choice
Output fields[3]
FieldType
Statustext
Messageobject
Typetext
Codetext
Nametext
Descriptiontext

Delete a Product

ActionDeletes an item from the whole catalog.
Input fields[3]
FieldType
ProductRequired
choice

Delete a Product Image

ActionRemoves one product picture.
Input fields[3]
FieldType
ProductRequired
choice
ImageRequired
choice

Delete an Attribute

ActionRemoves one attribute definition.
Input fields[3]
FieldType
AttributeRequired
choice

Delete an Attribute Preset

ActionRemoves one selectable attribute value.
Input fields[3]
FieldType
AttributeRequired
choice
PresetRequired
choice

Delete Bundle Offers in Bulk

ActionMass removal of bundle deals.
Input fields[3]
FieldType
Discount Rule IDsRequired
array

Delete Coupons in Bulk

ActionMass removal of coupons.
Input fields[3]
FieldType
Coupons IDsRequired
array
Output fields[3]
FieldType
Statustext
Messageobject
Typetext
Codetext
Nametext
Descriptiontext

Duplicate a Coupon

ActionClones one coupon with identical discount settings.
Input fields[3]
FieldType
CouponRequired
choice
Output fields[3]
FieldType
Statustext
Messageobject
Typetext
Codetext
Nametext
Descriptiontext

Duplicate Coupons in Bulk

ActionMass cloning of coupon codes.
Input fields[3]
FieldType
IDsRequired
array
Output fields[3]
FieldType
Statustext
Messageobject
Typetext
Codetext
Nametext
Descriptiontext

Generate Coupons in Bulk

ActionBatch of coupons from one template.
Input fields[3]
FieldType
NameRequired
text
Coupons AmountRequired
number
Discount TypeRequired
choice
Codetext
Discountnumber
Free Shippingboolean
Free CODboolean
Minimum Cart Totalnumber

17other input fields

Output fields[3]
FieldType
Statustext
Messageobject
Typetext
Codetext
Nametext
Descriptiontext

Make an API Call

universalDirect Zid REST API access for uncovered endpoints.
Input fields[3]
FieldType
URLRequired
text
MethodRequired
choice
Headersarray
Headerobject
Query stringarray
Parameterobject
Bodytext
Output fields[3]
FieldType
Bodytext
Headersobject
Keytext
Valuetext
Status codenumber

Recover Broken Webhooks

ActionRestores delivery of failed webhooks.
Input fields[3]
FieldType
WebhooksRequired
array
Webhookobject
Output fields[3]
FieldType
Statustext
Dataarray
Messageobject
Typetext
Codetext
Nametext
Descriptiontext

Remove a Customer Tag

ActionUnlabels a customer in the store.
Input fields[3]
FieldType
CustomerRequired
choice
TagRequired
choice
Output fields[3]
FieldType
IDnumber
Nametext
Emailtext
Mobiletext
Gendertext
Birth Datetext
Verifiedboolean
Is Activeboolean

17other output fields

Remove a Product from a Category

ActionUnlinks a catalog item from a section.
Input fields[3]
FieldType
ProductRequired
choice
CategoryRequired
choice

Remove All Products from a Category

ActionClears the product list of a category.
Input fields[3]
FieldType
CategoryRequired
choice
Output fields[3]
FieldType
IDnumber
Nametext
UUIDtext
Slugtext
SEO Category Titletext
SEO Category Descriptiontext
I18n SEO Category Titleobject
Arabictext
Englishtext
I18n SEO Category Descriptionobject
Arabictext
Englishtext

15other output fields

Reset Manual Product Order

ActionRemoves the manual ordering of products.
Input fields[3]
FieldType
ConfirmRequired
text

Send an Abandoned Cart Reminder

ActionNudges shoppers about unfinished carts.
Input fields[3]
FieldType
Abandoned CartsRequired
array
Notification SettingsRequired
object
TypeRequired
choice
IDtext
TitleRequired
text
SettingsRequired
object
Output fields[3]
FieldType
Statustext
Messageobject
Typetext
Codetext
Nametext
Descriptiontext
Abandoned Cart Notificationstext

Set a Category Published

ActionPublication state of a category.
Input fields[3]
FieldType
CategoryRequired
choice
PublishedRequired
boolean
Output fields[3]
FieldType
Statustext
Messageobject
Typetext
Codetext
Nametext
Descriptiontext

Set a Coupon Note

ActionInternal remark attached to a coupon.
Input fields[3]
FieldType
CouponRequired
choice
NoteRequired
text
Output fields[3]
FieldType
Statustext
Messageobject
Typetext
Codetext
Nametext
Descriptiontext

Set a Manual Product Order

ActionCustom product display order.
Input fields[3]
FieldType
Product IDsRequired
array
Categorychoice

Set Bulk Coupon Status

ActionMass activation of coupons.
Input fields[3]
FieldType
Coupons IDsRequired
array
ActiveRequired
boolean
Output fields[3]
FieldType
Statustext
Messageobject
Typetext
Codetext
Nametext
Descriptiontext

Set Coupon Status

ActionTurns a coupon code on or off.
Input fields[3]
FieldType
CouponRequired
choice
ActiveRequired
boolean
Output fields[3]
FieldType
Coupon IDnumber
IDnumber
Store IDnumber
Store Nametext
Store Logotext
Codetext
Uses Totalnumber
Created Attext

34other output fields

Set Customer Tags

ActionFull tag list for a customer.
Input fields[3]
FieldType
CustomerRequired
choice
TagsRequired
array
Output fields[3]
FieldType
IDnumber
Nametext
Emailtext
Mobiletext
Gendertext
Birth Datetext
Verifiedboolean
Is Activeboolean

17other output fields

Set the Category Nesting

ActionReorders the category hierarchy.
Input fields[3]
FieldType
DataRequired
array
Dataobject
Output fields[3]
FieldType
Statustext
Messagetext

Set the Product Stock at a Location

ActionStock counts for one place.
Input fields[3]
FieldType
LocationRequired
choice
Stock RowsRequired
array
Stock Rowobject

Update a Bundle Offer

ActionRevised bundle discount rule.
Input fields[3]
FieldType
Bundle OfferRequired
choice
Codechoice
Nameobject
Englishtext
Arabictext
Descriptionobject
Englishtext
Arabictext
Total Usesnumber
Uses per Customernumber
Conditions Matchchoice
Statuschoice

6other input fields

Output fields[3]
FieldType
IDtext
Nameobject
Englishtext
Arabictext
Descriptionobject
Englishtext
Arabictext
Codetext
Conditionsarray
Actionsarray
Conditions Criteriatext
Uses Totalnumber

10other output fields

Update a Category

ActionRevised store category with new texts.
Input fields[3]
FieldType
CategoryRequired
choice
Nameobject
Arabictext
Englishtext
Descriptionobject
Arabictext
Englishtext
Img Alt Textobject
Arabictext
Englishtext
Category URLtext
Category Titleobject
Arabictext
Englishtext
Category Descriptionobject
Arabictext
Englishtext
Parent IDchoice

1other input field

Output fields[3]
FieldType
IDnumber
Nameobject
Arabictext
Englishtext
Slugtext
Descriptiontext
Imageobject
Pathtext
Thumbnailtext
Parent IDtext
Childrenarray
Products Countnumber

Update a Coupon

ActionRevised discount code with new limits.
Input fields[3]
FieldType
CouponRequired
choice
NameRequired
text
CodeRequired
text
Discount TypeRequired
choice
DiscountRequired
text
Statuschoice
Applying Methodchoice
Apply Tochoice

20other input fields

Output fields[3]
FieldType
Coupon IDnumber
IDnumber
Store IDnumber
Store Nametext
Store Logotext
Codetext
Uses Totalnumber
Created Attext

29other output fields

Update a Custom Input Field

ActionRevised free-entry field.
Input fields[3]
FieldType
ProductRequired
choice
Input FieldRequired
text
Typetext
Labelobject
EnglishRequired
text
ArabicRequired
text
Hintobject
Englishtext
Arabictext
Pricenumber
Requiredchoice
Publishedchoice

3other input fields

Output fields[3]
FieldType
IDtext
Typetext
Hintobject
Englishtext
Arabictext
Labelobject
Englishtext
Arabictext
Display Ordernumber
Is Requiredboolean
Pricenumber
Formatted Pricetext

3other output fields

Update a Custom Option

ActionRevised option on a product page.
Input fields[3]
FieldType
ProductRequired
choice
OptionRequired
text
Labelobject
ArabicRequired
text
EnglishRequired
text
Hintobject
ArabicRequired
text
EnglishRequired
text
Typetext
Min Choicesnumber
Max Choicesnumber
Can Choose Multiple Optionschoice

5other input fields

Output fields[3]
FieldType
IDtext
Typetext
Labelobject
Arabictext
Englishtext
Hintobject
Arabictext
Englishtext
Min Choicesnumber
Max Choicesnumber
Can Choose Multiple Optionsboolean
Is Publishedboolean

4other output fields

Update a Customer

ActionRevised customer record with new details.
Input fields[3]
FieldType
CustomerRequired
choice
Typechoice
Nametext
Mobiletext
Emailtext
Genderchoice
Birth Datedate
Business Nametext

3other input fields

Output fields[3]
FieldType
IDnumber
Nametext
Emailtext
Mobiletext
Gendertext
Birth Datetext
Verifiedboolean
Is Activeboolean

17other output fields

Update a Location

ActionRevised inventory location with new details.
Input fields[3]
FieldType
LocationRequired
choice
Nametext
Coordinatesobject
LatitudeRequired
text
LongitudeRequired
text
Full Addresstext
Default Locationchoice
Privatechoice
Enabledchoice
Short Addresstext

1other input field

Output fields[3]
FieldType
IDtext
Nameobject
Arabictext
Englishtext
Cityobject
IDnumber
Nametext
Arabic Nametext
Countryobject
Country Codetext
Typetext
Coordinatesobject
Latitudenumber
Longitudenumber
Full Addresstext
Short Addresstext
Districttext

8other output fields

Update a Product

ActionRevised catalog item with new data.
Input fields[3]
FieldType
ProductRequired
choice
Nameobject
ArabicRequired
text
EnglishRequired
text
Descriptionobject
ArabicRequired
text
EnglishRequired
text
Short Descriptionobject
ArabicRequired
text
EnglishRequired
text
SKUtext
Barcodetext
Pricenumber
Sale Pricenumber

12other input fields

Output fields[3]
FieldType
IDtext
Product Classtext
SKUtext
Barcodetext
Parent IDtext
Nameobject
Arabictext
Englishtext
Slugtext
Pricenumber

46other output fields

Update a Product Image Order

ActionChanges the position of a picture.
Input fields[3]
FieldType
ProductRequired
choice
ImageRequired
choice
Display OrderRequired
number
Output fields[3]
FieldType
IDtext
Imageobject
Largetext
Smalltext
Full Sizetext
Mediumtext
Thumbnailtext
Alt Texttext
Display Ordernumber

Update a Product Stock

ActionRevised inventory record for one place.
Input fields[3]
FieldType
ProductRequired
choice
StockRequired
choice
LocationRequired
choice
Available QuantityRequired
number
Unlimited StockRequired
boolean
Output fields[3]
FieldType
Product IDtext
Locationtext
Quantitynumber
Is Infiniteboolean

Update an Attribute

ActionRetitles a product property.
Input fields[3]
FieldType
AttributeRequired
choice
NameRequired
object
Arabictext
Englishtext
Output fields[3]
FieldType
IDtext
Nametext
Slugtext
Presetsarray
Is Extraboolean
Is Enabledboolean
Display Ordernumber
Preset Counttext

Update an Attribute Preset

ActionEdits one attribute value.
Input fields[3]
FieldType
AttributeRequired
choice
PresetRequired
choice
ValueRequired
object
Arabictext
Englishtext
Output fields[3]
FieldType
IDtext
Slugtext
Nametext
Valuetext
Typetext
Type Valuetext
Display Ordertext
Attribute Image IDtext

1other output field

Update Bulk Coupons

ActionSame discount rules on many coupons.
Input fields[3]
FieldType
Coupons IDsRequired
array
Discount TypeRequired
choice
DiscountRequired
text
Free Shippingchoice
Free CODchoice
Minimum Cart Totaltext
Maximum Cart Totaltext
Maximum Cart Weight (kg)number

17other input fields

Output fields[3]
FieldType
Statustext
Messageobject
Typetext
Codetext
Nametext
Descriptiontext

Update Product Stock in Bulk

ActionStock levels across several locations together.
Input fields[3]
FieldType
ProductRequired
choice
Stock RowsRequired
array
Stock Rowobject

Update Products in Bulk

ActionShared edits across many products.
Input fields[3]
FieldType
Product IDsRequired
array
Nameobject
Arabictext
Englishtext
Descriptionobject
Arabictext
Englishtext
Weightobject
Valuenumber
Unittext
Keywordsarray
Output fields[3]
FieldType
IDtext
Product Classtext
SKUtext
Barcodetext
Parent IDtext
Nameobject
Arabictext
Englishtext
Slugtext
Pricenumber

46other output fields

Update Return Products

ActionReceipt counts for returned goods.
Input fields[3]
FieldType
Order Reverse IDRequired
text
ProductsRequired
array
Productobject
Output fields[3]
FieldType
IDtext
Store IDtext
Order IDnumber
Is Partialnumber
Consignee Nametext
Consignee Mobiletext
Consignee Cityobject
IDnumber
Country IDnumber
Zone IDnumber
Nametext
Arabic Nametext
Codetext
Statusnumber
Prioritynumber
Created Attext
Updated Attext
Consignee Address 1text

13other output fields

Upload a Product Image

ActionNew gallery picture for a product.
Input fields[3]
FieldType
ProductRequired
choice
ImageRequired
text
File NameRequired
text
Alt TextRequired
text
Output fields[3]
FieldType
IDtext
Imageobject
Full Sizetext
Mediumtext
Largetext
Smalltext
Thumbnailtext
Alt Texttext
Display Ordernumber

Validate an Order

ActionDry-run check of an order payload.
Input fields[3]
FieldType
Currency CodeRequired
text
CustomerRequired
object
Full NameRequired
text
Mobile Country CodeRequired
text
Mobile NumberRequired
text
Emailtext
ConsigneeRequired
object
ContactRequired
object
AddressRequired
object
Gift OrderRequired
boolean
Notify Gift RecipientRequired
boolean
ProductsRequired
array
Productobject
Shipping Method TypeRequired
text
Shipping MethodRequired
choice

4other input fields

Output fields[3]
FieldType
Codetext
Messagetext

Look for Zid templates in the WEXTL template library.

Browse templates →
  1. WEXTL® Zid Source Code connector implementation.
  2. Our users use cases and automations.
  3. Official API Documentation for Zid.
  4. 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.