Zone

v1

Description

Zone is a geographical region that contains a group of stores. Seller will be able to create or update shipping charges per product variant and location. Get notified whenever a zone is created or modified.

---

Supported Type

• Create
• Update

---

Payload

{
   "event":{
      "id":"rOcs838XXrj5ef6LoJkfu9y3TTW25tDekAsleAA4Eck=",
      "name":"zone",
      "type":"update",
      "version":"1",
      "category":"company",
      "trace_id":[
         "stormbreaker.492ed3f5-9da3-45d9-9922-31be1811438f"
      ],
      "created_timestamp":1661319161914
   },
   "payload":{
      "zone":{
         "new":{
            "zone_id":"6232d52653da68b0a99188ef",
            "slug":"delhi-region",
            "name":"delhi Region",
            "company_id":4,
            "store_ids":[
               1
            ],
            "product":{
               "type":"explicit",
               "tags":[
                  "liquid"
               ]
            },
            "channels":[
               {
                  "channel_id":"12345",
                  "channel_type":"application"
               }
            ]
         },
         "old":{
            
         }
      }
   },
   "contains":[
      "zone"
   ],
   "company_id":2
}

---

Object Properties

Key	Type	Description
zone	Object	contain details about created zone
zone.new	Object	New Created/Updated Zone
zone.old	Object	Contains older payload (same format as new) (empty during create)
zone.new.zone_id	String	Zone ID
zone.new.slug	String	Slug of the region associated with the zone
zone.new.name	String	Canonical name of slug
zone.new.company_id	Integer	Company ID of zone
zone.new.store_ids	List	List of stores for the created/updated zone
zone.new.product.type	String	Product type
zone.new.product.tags	List	Product tags associated with the zone
zone.new.channels[0].channel_id	String	Channel ID (Application or Extension ID)
zone.new.channels[0].channel_type	String	Channel type: Application or Extension