Company
Events categorised under company level will be triggered when any action performed on company. e.g. If new brand is created.
Events
company/location/create/v2
# Triggered when a new location is created for a company.
company/location/update/v2
# Triggered when an existing location is updated for a company.
Payload
Hide
company_id
integer
Required
Unique identifier of the company for which this event is triggered.
contains
array of string
Required
List of top-level keys present in the payload object for this event.
region
string
Geographic region in which this event was triggered.
zone
string
Zone in which this event was triggered.
event
object
Required
Show
payload
object
Required
Show
Payload Schema JSON
1{2 "type": "object",3 "required": [4 "company_id",5 "contains",6 "event",7 "payload"8 ],9 "properties": {10 "company_id": {11 "type": "integer",12 "description": "Unique identifier of the company for which this event is triggered."13 },14 "contains": {15 "type": "array",16 "description": "List of top-level keys present in the payload object for this event.",17 "items": {18 "type": "string"19 }20 },21 "region": {22 "type": "string",23 "description": "Geographic region in which this event was triggered.",24 "example": "asia-south1"25 },26 "zone": {27 "type": "string",28 "description": "Zone in which this event was triggered.",29 "example": "default"30 },31 "event": {32 "type": "object",33 "required": [34 "category",35 "created_timestamp",36 "id",37 "name",38 "trace_id",39 "type",40 "version"41 ],42 "properties": {43 "category": {44 "type": "string",45 "description": "Scope of the event, indicating whether it was triggered at the sales channel (application) level or the company level."46 },47 "created_timestamp": {48 "type": "integer",49 "description": "Timestamp indicating when the event was generated, in epoch milliseconds."50 },51 "id": {52 "type": "string",53 "description": "Unique identifier for the event. Use this ID to check whether the event has already been processed."54 },55 "name": {56 "type": "string",57 "description": "Name of the event"58 },59 "trace_id": {60 "type": "array",61 "description": "List of internal trace identifiers used by Fynd Commerce service.",62 "items": {63 "type": "string"64 }65 },66 "type": {67 "type": "string",68 "description": "Action that triggered the event, such as create, update, or delete."69 },70 "version": {71 "type": "string",72 "description": "Version of the event schema."73 },74 "referer": {75 "type": "string",76 "description": "Source that triggered the event.",77 "example": "fynd.com"78 }79 }80 },81 "payload": {82 "type": "object",83 "properties": {84 "location": {85 "type": "object",86 "properties": {87 "product_return_config": {88 "type": "object",89 "properties": {90 "on_same_store": {91 "type": "boolean",92 "description": "Whether a return can be initiated at the same store."93 }94 },95 "description": "Product return configuration for the location."96 },97 "contact_numbers": {98 "type": "array",99 "items": {100 "type": "object",101 "properties": {102 "number": {103 "type": "string",104 "description": "Contact number of the store."105 },106 "country_code": {107 "type": "integer",108 "description": "Country code for the contact number."109 }110 }111 },112 "description": "Contact numbers associated with the location."113 },114 "documents": {115 "type": "array",116 "description": "List of documents associated with the location."117 },118 "company": {119 "type": "integer",120 "description": "Company associated with the location."121 },122 "address": {123 "type": "object",124 "properties": {125 "address1": {126 "type": "string",127 "description": "First line of the location address."128 },129 "address2": {130 "type": "string",131 "description": "Additional lines of the location address."132 },133 "landmark": {134 "type": "string",135 "description": "Landmark of the location address."136 },137 "address_meta": {138 "type": "object",139 "additionalProperties": true,140 "description": "Contains metadata about the address, like state and pincode details, for additional validation and identification."141 },142 "state": {143 "type": "string",144 "description": "State or province of the location address."145 },146 "country_code": {147 "type": "string",148 "description": "Country code of the location address."149 },150 "city": {151 "type": "string",152 "description": "City of the location address."153 },154 "latitude": {155 "type": "number",156 "description": "Latitude of the location address."157 },158 "pincode": {159 "type": "string",160 "description": "Postal code of the location address."161 },162 "longitude": {163 "type": "number",164 "description": "Longitude of the location address."165 },166 "country": {167 "type": "string",168 "description": "Country of the location address."169 }170 },171 "description": "Address of the location."172 },173 "manager": {174 "type": "object",175 "properties": {176 "mobile_no": {177 "type": "object",178 "properties": {179 "number": {180 "type": "string",181 "description": "Phone number of the location manager."182 },183 "country_code": {184 "type": "integer",185 "description": "Country code for the mobile phone number of the location manager."186 }187 },188 "description": "Mobile phone number of the location manager."189 },190 "name": {191 "type": "string",192 "description": "Name of the location manager."193 },194 "email": {195 "type": "string",196 "description": "Email address of the location manager."197 }198 },199 "description": "Manager of the location."200 },201 "avg_order_processing_time": {202 "type": "object",203 "properties": {204 "duration_type": {205 "type": "string",206 "description": "Type of duration for the average order processing time."207 },208 "duration": {209 "type": "integer",210 "description": "Duration of the average order processing time."211 }212 },213 "description": "Average order processing time for the location."214 },215 "gst_credentials": {216 "type": "object",217 "properties": {218 "e_waybill": {219 "type": "object",220 "properties": {221 "enabled": {222 "type": "boolean",223 "description": "Flag indicating if E-Waybill is enabled for the location."224 }225 },226 "description": "E-Waybill credentials for the location."227 },228 "e_invoice": {229 "type": "object",230 "properties": {231 "enabled": {232 "type": "boolean",233 "description": "Flag indicating if E-Invoice is enabled for the location."234 }235 },236 "description": "E-Invoice credentials for the location."237 }238 },239 "description": "GST credentials for the location."240 },241 "auto_assign_courier_partner": {242 "type": "boolean",243 "description": "Flag indicating if auto-assignment of courier partner is enabled for the location."244 },245 "auto_invoice": {246 "type": "boolean",247 "description": "Flag indicating if auto invoice generation is enabled for the location."248 },249 "created_on": {250 "type": "string",251 "description": "The date and time when the location was created."252 },253 "modified_on": {254 "type": "string",255 "description": "The date and time when the location was last modified."256 },257 "timing": {258 "type": "array",259 "items": [260 {261 "type": "object",262 "properties": {263 "open": {264 "type": "boolean"265 },266 "weekday": {267 "type": "string"268 },269 "closing": {270 "type": "object",271 "properties": {272 "hour": {273 "type": "integer"274 },275 "minute": {276 "type": "integer"277 }278 }279 },280 "opening": {281 "type": "object",282 "properties": {283 "hour": {284 "type": "integer"285 },286 "minute": {287 "type": "integer"288 }289 }290 }291 }292 }293 ],294 "description": "Operational timings for the location."295 },296 "name": {297 "type": "string",298 "description": "The original name of the location."299 },300 "uid": {301 "type": "integer",302 "description": "Unique identifier for the location."303 },304 "stage": {305 "type": "string",306 "description": "Stage of the location.",307 "enum": [308 "verified",309 "complete",310 "pending"311 ]312 },313 "display_name": {314 "type": "string",315 "description": "Display name of the location on the platform for easier identification."316 },317 "credit_note": {318 "type": "boolean",319 "description": "Flag indicating if credit note generation is enabled for the location."320 },321 "code": {322 "type": "string",323 "description": "Store code for the location."324 },325 "bulk_shipment": {326 "type": "boolean",327 "description": "Flag indicating if bulk shipment is enabled for the location."328 },329 "multi_piece_shipment": {330 "type": "boolean",331 "description": "Flag indicating if multi-piece shipment is enabled for the location."332 },333 "tags": {334 "type": "array",335 "description": "Tags associated with the location."336 },337 "store_type": {338 "type": "string",339 "description": "Type of the store.",340 "enum": [341 "high_street",342 "mall",343 "warehouse"344 ]345 },346 "warnings": {347 "type": "object",348 "properties": {349 "msg": {350 "type": "string",351 "description": "Warning associated with the location."352 },353 "gst": {354 "type": "string",355 "description": "GST verification details",356 "example": "GST not verified."357 },358 "store_address": {359 "type": "string",360 "description": "Address-related warnings associated with the location."361 }362 },363 "description": "Any warnings related to the location."364 },365 "order_acceptance_timing": {366 "type": "array",367 "items": {368 "type": "object",369 "properties": {370 "open": {371 "type": "boolean"372 },373 "weekday": {374 "type": "string"375 },376 "closing": {377 "type": "object",378 "properties": {379 "hour": {380 "type": "integer"381 },382 "minute": {383 "type": "integer"384 }385 }386 },387 "opening": {388 "type": "object",389 "properties": {390 "hour": {391 "type": "integer"392 },393 "minute": {394 "type": "integer"395 }396 }397 }398 }399 },400 "description": "Order acceptance timing for the location."401 },402 "default_order_acceptance_timing": {403 "type": "boolean",404 "description": "Flag indicating if the default order acceptance timing is enabled for the location."405 },406 "notification_emails": {407 "type": "array",408 "items": {409 "type": "string"410 },411 "description": "Email addresses for notifications related to the location."412 },413 "_custom_json": {414 "type": "object",415 "description": "Custom JSON data specific to the store, allowing the seller to include additional information or metadata as needed."416 },417 "holiday": {418 "type": "array",419 "items": {420 "type": "object",421 "description": "Defines the details of a holiday, including its title, type, and dates.",422 "properties": {423 "date": {424 "description": "The start and end dates of the holiday.",425 "type": "object",426 "properties": {427 "end_date": {428 "type": "string",429 "format": "date-time",430 "description": "The end date and time of the holiday in ISO 8601 format."431 },432 "start_date": {433 "type": "string",434 "format": "date-time",435 "description": "The start date and time of the holiday in ISO 8601 format."436 }437 },438 "required": [439 "end_date",440 "start_date"441 ]442 },443 "title": {444 "type": "string",445 "description": "The name or title of the holiday."446 },447 "holiday_type": {448 "type": "string",449 "enum": [450 "national",451 "custom"452 ],453 "description": "The type of holiday, either national or custom."454 }455 },456 "required": [457 "date",458 "holiday_type",459 "title"460 ]461 }462 },463 "qc_based_return_inventory_sync": {464 "type": "boolean",465 "description": "Flag for returned items to be automatically added to either sellable or damaged stock based on the good/bad QC mark for each article."466 }467 },468 "description": "Details of the location associated with this event."469 }470 }471 }472 }473}
Payload Example
1{2 "event": {3 "trace_id": [4 "viking-utils.90aa0b6e-f308-11ee-a983-46abbc8259d6"5 ],6 "name": "location",7 "type": "create",8 "version": "2",9 "created_timestamp": 1712292860741,10 "id": "yi3B3NvHmHP0ac+g4YpCdyU1uPExMbGrK7AF3lzS5ws=",11 "category": "company",12 "referer": "fyndx1.de"13 },14 "company_id": 26167,15 "contains": [16 "location"17 ],18 "region": "asia-south1",19 "zone": "default",20 "payload": {21 "location": {22 "avg_order_processing_time": {23 "duration_type": "days",24 "duration": 125 },26 "contact_numbers": [27 {28 "country_code": 971,29 "number": "8888888888"30 }31 ],32 "display_name": "Brunt Test Company - 1712292860463",33 "tags": [],34 "manager": {35 "mobile_no": {36 "country_code": 971,37 "number": "8888888888"38 },39 "name": "sandbox user",40 "email": "test@example.com"41 },42 "stage": "complete",43 "default_order_acceptance_timing": true,44 "store_type": "high_street",45 "name": "Brunt Test Company - 1712292860463",46 "bulk_shipment": false,47 "multi_piece_shipment": false,48 "order_acceptance_timing": [49 {50 "closing": {51 "minute": 30,52 "hour": 2153 },54 "weekday": "monday",55 "open": true,56 "opening": {57 "minute": 0,58 "hour": 1159 }60 },61 {62 "closing": {63 "minute": 30,64 "hour": 2165 },66 "weekday": "tuesday",67 "open": true,68 "opening": {69 "minute": 0,70 "hour": 1171 }72 },73 {74 "closing": {75 "minute": 30,76 "hour": 2177 },78 "weekday": "wednesday",79 "open": true,80 "opening": {81 "minute": 0,82 "hour": 1183 }84 },85 {86 "closing": {87 "minute": 30,88 "hour": 2189 },90 "weekday": "thursday",91 "open": true,92 "opening": {93 "minute": 0,94 "hour": 1195 }96 },97 {98 "closing": {99 "minute": 30,100 "hour": 21101 },102 "weekday": "friday",103 "open": true,104 "opening": {105 "minute": 0,106 "hour": 11107 }108 },109 {110 "closing": {111 "minute": 30,112 "hour": 21113 },114 "weekday": "saturday",115 "open": true,116 "opening": {117 "minute": 0,118 "hour": 11119 }120 },121 {122 "closing": {123 "minute": 30,124 "hour": 21125 },126 "weekday": "sunday",127 "open": true,128 "opening": {129 "minute": 0,130 "hour": 11131 }132 }133 ],134 "auto_invoice": false,135 "company": 26167,136 "gst_credentials": {137 "e_waybill": {138 "enabled": false139 },140 "e_invoice": {141 "enabled": false142 }143 },144 "warnings": {},145 "uid": 55905,146 "product_return_config": {147 "on_same_store": true148 },149 "credit_note": false,150 "address": {151 "address1": "POLARIS",152 "latitude": 19.0653252,153 "longitude": 72.8423802,154 "country_code": "AE",155 "country": "UNITED ARAB EMIRATES",156 "sector": "AL AAHAD AREA",157 "city": "SHARJAH"158 },159 "documents": [],160 "notification_emails": [161 "test@example.com"162 ],163 "auto_assign_courier_partner": true,164 "timing": [165 {166 "closing": {167 "minute": 30,168 "hour": 21169 },170 "weekday": "monday",171 "open": true,172 "opening": {173 "minute": 0,174 "hour": 11175 }176 },177 {178 "closing": {179 "minute": 30,180 "hour": 21181 },182 "weekday": "tuesday",183 "open": true,184 "opening": {185 "minute": 0,186 "hour": 11187 }188 },189 {190 "closing": {191 "minute": 30,192 "hour": 21193 },194 "weekday": "wednesday",195 "open": true,196 "opening": {197 "minute": 0,198 "hour": 11199 }200 },201 {202 "closing": {203 "minute": 30,204 "hour": 21205 },206 "weekday": "thursday",207 "open": true,208 "opening": {209 "minute": 0,210 "hour": 11211 }212 },213 {214 "closing": {215 "minute": 30,216 "hour": 21217 },218 "weekday": "friday",219 "open": true,220 "opening": {221 "minute": 0,222 "hour": 11223 }224 },225 {226 "closing": {227 "minute": 30,228 "hour": 21229 },230 "weekday": "saturday",231 "open": true,232 "opening": {233 "minute": 0,234 "hour": 11235 }236 },237 {238 "closing": {239 "minute": 30,240 "hour": 21241 },242 "weekday": "sunday",243 "open": true,244 "opening": {245 "minute": 0,246 "hour": 11247 }248 }249 ],250 "code": "HS-d4ab1"251 }252 }253}
Payload
Hide
company_id
integer
Required
Unique identifier of the company for which this event is triggered.
contains
array of string
Required
List of top-level keys present in the payload object for this event.
region
string
Geographic region in which this event was triggered.
zone
string
Zone in which this event was triggered.
event
object
Required
Show
payload
object
Required
Show
Payload Schema JSON
1{2 "type": "object",3 "required": [4 "company_id",5 "contains",6 "event",7 "payload"8 ],9 "properties": {10 "company_id": {11 "type": "integer",12 "description": "Unique identifier of the company for which this event is triggered."13 },14 "contains": {15 "type": "array",16 "description": "List of top-level keys present in the payload object for this event.",17 "items": {18 "type": "string"19 }20 },21 "region": {22 "type": "string",23 "description": "Geographic region in which this event was triggered.",24 "example": "asia-south1"25 },26 "zone": {27 "type": "string",28 "description": "Zone in which this event was triggered.",29 "example": "default"30 },31 "event": {32 "type": "object",33 "required": [34 "category",35 "created_timestamp",36 "id",37 "name",38 "trace_id",39 "type",40 "version"41 ],42 "properties": {43 "category": {44 "type": "string",45 "description": "Scope of the event, indicating whether it was triggered at the sales channel level or the company level."46 },47 "created_timestamp": {48 "type": "integer",49 "description": "Timestamp indicating when the event was generated, in epoch milliseconds."50 },51 "id": {52 "type": "string",53 "description": "Unique identifier for the event. Use this ID to check whether the event has already been processed."54 },55 "name": {56 "type": "string",57 "description": "Name of the event, typically matching the entity type, such as location."58 },59 "trace_id": {60 "type": "array",61 "description": "List of internal trace identifiers used by Fynd Commerce services.",62 "items": {63 "type": "string"64 }65 },66 "type": {67 "type": "string",68 "description": "Action that triggered the event, such as create, update, or delete."69 },70 "version": {71 "type": "string",72 "description": "Version of the event schema."73 },74 "referer": {75 "type": "string",76 "description": "Source that triggered the event, typically the domain of the originating request.",77 "example": "fynd.com"78 }79 }80 },81 "payload": {82 "type": "object",83 "properties": {84 "location": {85 "type": "object",86 "properties": {87 "product_return_config": {88 "type": "object",89 "properties": {90 "on_same_store": {91 "type": "boolean",92 "description": "Whether a return can be initiated at the same store."93 }94 },95 "description": "Product return configuration for the location."96 },97 "warnings": {98 "type": "object",99 "properties": {100 "msg": {101 "type": "string",102 "description": "Warning associated with the location."103 },104 "gst": {105 "type": "string",106 "description": "GST verification details",107 "example": "GST not verified."108 },109 "store_address": {110 "type": "string",111 "description": "Address-related warnings associated with the location."112 }113 },114 "description": "Any warnings related to the location."115 },116 "manager": {117 "type": "object",118 "properties": {119 "mobile_no": {120 "type": "object",121 "properties": {122 "country_code": {123 "type": "integer",124 "description": "Country code for the mobile phone number of the location manager."125 },126 "number": {127 "type": "string",128 "description": "Phone number of the location manager."129 }130 },131 "description": "Mobile phone number of the location manager."132 },133 "email": {134 "type": "string",135 "description": "Email address of the location manager."136 },137 "name": {138 "type": "string",139 "description": "Name of the location manager."140 }141 },142 "description": "Manager of the location."143 },144 "uid": {145 "type": "integer",146 "description": "Unique identifier for the location."147 },148 "order_acceptance_timing": {149 "type": "array",150 "items": {151 "type": "object",152 "properties": {153 "closing": {154 "type": "object",155 "properties": {156 "minute": {157 "type": "integer",158 "description": "Closing minute of the store's operational hours."159 },160 "hour": {161 "type": "integer",162 "description": "Closing hour of the store's operational hours."163 }164 },165 "description": "Closing time of the store for a specific day."166 },167 "opening": {168 "type": "object",169 "properties": {170 "minute": {171 "type": "integer",172 "description": "Opening minute of the store's operational hours."173 },174 "hour": {175 "type": "integer",176 "description": "Opening hour of the store's operational hours."177 }178 },179 "description": "Opening time of the store for a specific day."180 },181 "open": {182 "type": "boolean",183 "description": "Flag indicating if the store is open on a specific day."184 },185 "weekday": {186 "type": "string",187 "description": "Specific day of the week."188 }189 },190 "description": "Describes the store's operational hours for each day of the week."191 },192 "description": "Order acceptance timing for the location."193 },194 "bulk_shipment": {195 "type": "boolean",196 "description": "Flag indicating if bulk shipment is enabled for the location."197 },198 "multi_piece_shipment": {199 "type": "boolean",200 "description": "Flag indicating if multi-piece shipment is enabled for the location."201 },202 "auto_invoice": {203 "type": "boolean",204 "description": "Flag indicating if auto invoice generation is enabled for the location."205 },206 "created_on": {207 "type": "string",208 "description": "The date and time when the location was created."209 },210 "modified_on": {211 "type": "string",212 "description": "The date and time when the location was last modified."213 },214 "credit_note": {215 "type": "boolean",216 "description": "Flag indicating if credit note generation is enabled for the location."217 },218 "avg_order_processing_time": {219 "type": "object",220 "properties": {221 "duration_type": {222 "type": "string",223 "description": "Type of duration for the average order processing time."224 },225 "duration": {226 "type": "integer",227 "description": "Duration of the average order processing time."228 }229 },230 "description": "Average order processing time for the location."231 },232 "documents": {233 "type": "array",234 "items": {},235 "description": "List of documents associated with the location."236 },237 "default_order_acceptance_timing": {238 "type": "boolean",239 "description": "Flag indicating if the default order acceptance timing is enabled for the location."240 },241 "auto_assign_courier_partner": {242 "type": "boolean",243 "description": "Flag indicating if auto-assignment of courier partner is enabled for the location."244 },245 "address": {246 "type": "object",247 "properties": {248 "pincode": {249 "type": "string",250 "description": "Postal code of the location address."251 },252 "latitude": {253 "type": "number",254 "description": "Latitude of the location address."255 },256 "country_code": {257 "type": "string",258 "description": "Country code of the location address."259 },260 "country": {261 "type": "string",262 "description": "Country of the location address."263 },264 "address1": {265 "type": "string",266 "description": "First line of the location address."267 },268 "address2": {269 "type": "string",270 "description": "Additional lines of the location address."271 },272 "landmark": {273 "type": "string",274 "description": "Landmark of the location address."275 },276 "address_meta": {277 "type": "object",278 "additionalProperties": true,279 "description": "Contains metadata about the address, like state and pincode details, for additional validation and identification."280 },281 "longitude": {282 "type": "number",283 "description": "Longitude of the location address."284 },285 "city": {286 "type": "string",287 "description": "City of the location address."288 },289 "state": {290 "type": "string",291 "description": "State or province of the location address."292 }293 },294 "description": "Address of the location."295 },296 "notification_emails": {297 "type": "array",298 "items": {299 "type": "string"300 },301 "description": "Email addresses for notifications related to the location."302 },303 "company": {304 "type": "integer",305 "description": "Company associated with the location."306 },307 "display_name": {308 "type": "string",309 "description": "Display name of the location."310 },311 "store_type": {312 "type": "string",313 "description": "Type of the store.",314 "enum": [315 "high_street",316 "mall",317 "warehouse"318 ]319 },320 "stage": {321 "type": "string",322 "description": "Stage of the location."323 },324 "name": {325 "type": "string",326 "description": "Name of the location."327 },328 "code": {329 "type": "string",330 "description": "Store code for the location."331 },332 "contact_numbers": {333 "type": "array",334 "items": [335 {336 "type": "object",337 "properties": {338 "country_code": {339 "type": "integer"340 },341 "number": {342 "type": "string"343 }344 }345 }346 ],347 "description": "Contact numbers associated with the location."348 },349 "gst_credentials": {350 "type": "object",351 "properties": {352 "e_invoice": {353 "type": "object",354 "properties": {355 "enabled": {356 "type": "boolean",357 "description": "Flag indicating if E-Invoice is enabled for the location."358 }359 },360 "description": "E-Invoice credentials for the location."361 },362 "e_waybill": {363 "type": "object",364 "properties": {365 "enabled": {366 "type": "boolean",367 "description": "Flag indicating if E-Waybill is enabled for the location."368 }369 },370 "description": "E-Waybill credentials for the location."371 }372 },373 "description": "GST credentials for the location."374 },375 "timing": {376 "type": "array",377 "items": [378 {379 "type": "object",380 "properties": {381 "closing": {382 "type": "object",383 "properties": {384 "minute": {385 "type": "integer"386 },387 "hour": {388 "type": "integer"389 }390 }391 },392 "opening": {393 "type": "object",394 "properties": {395 "minute": {396 "type": "integer"397 },398 "hour": {399 "type": "integer"400 }401 }402 },403 "open": {404 "type": "boolean"405 },406 "weekday": {407 "type": "string"408 }409 }410 }411 ],412 "description": "Operational timings for the location."413 },414 "tags": {415 "type": "array",416 "items": {417 "type": "string"418 },419 "description": "Tags associated with the location."420 },421 "verified_on": {422 "type": "string",423 "description": "Timestamp for when the location was verified."424 },425 "verified_by": {426 "type": "object",427 "properties": {428 "user_id": {429 "type": "string",430 "description": "User ID of the user who verified the location."431 }432 },433 "description": "User who verified the location."434 },435 "_custom_json": {436 "type": "object",437 "description": "Custom JSON data specific to the store, allowing the seller to include additional information or metadata as needed."438 },439 "holiday": {440 "type": "array",441 "items": {442 "type": "object",443 "description": "Defines the details of a holiday, including its title, type, and dates.",444 "properties": {445 "date": {446 "description": "The start and end dates of the holiday.",447 "type": "object",448 "properties": {449 "end_date": {450 "type": "string",451 "format": "date-time",452 "description": "The end date and time of the holiday in ISO 8601 format."453 },454 "start_date": {455 "type": "string",456 "format": "date-time",457 "description": "The start date and time of the holiday in ISO 8601 format."458 }459 },460 "required": [461 "end_date",462 "start_date"463 ]464 },465 "title": {466 "type": "string",467 "description": "The name or title of the holiday."468 },469 "holiday_type": {470 "type": "string",471 "enum": [472 "national",473 "custom"474 ],475 "description": "The type of holiday, either national or custom."476 }477 },478 "required": [479 "date",480 "holiday_type",481 "title"482 ]483 }484 },485 "qc_based_return_inventory_sync": {486 "type": "boolean",487 "description": "Flag for returned items to be automatically added to either sellable or damaged stock based on the good/bad QC mark for each article."488 }489 },490 "description": "Details of the location associated with this event."491 }492 }493 }494 }495}
Payload Example
1{2 "company_id": 680,3 "contains": [4 "location"5 ],6 "region": "asia-south1",7 "zone": "default",8 "event": {9 "category": "company",10 "created_timestamp": 1712296806094,11 "id": "TmmvBJ5721ruRBSryU9pJnW9I/I76uDnFcA5Kwv73vk=",12 "name": "location",13 "trace_id": [14 "WheelJack.c04725e2-f311-11ee-8496-f67d79aa4477"15 ],16 "type": "update",17 "version": "2",18 "referer": "fynd.com"19 },20 "payload": {21 "location": {22 "address": {23 "address1": "dummy address",24 "city": "West Delhi",25 "country": "India",26 "country_code": "IN",27 "latitude": 19.0653252,28 "longitude": 72.8423802,29 "pincode": 110041,30 "state": "Delhi"31 },32 "auto_assign_courier_partner": false,33 "auto_invoice": true,34 "avg_order_processing_time": {35 "duration": 48,36 "duration_type": "hours"37 },38 "bulk_shipment": true,39 "multi_piece_shipment": false,40 "code": "CAPL68003",41 "company": 680,42 "contact_numbers": [43 {44 "country_code": 91,45 "number": "8888888888"46 }47 ],48 "credit_note": true,49 "default_order_acceptance_timing": true,50 "display_name": "Mundka1",51 "documents": [52 {53 "legal_name": "CAMPUS ACTIVEWEAR LIMITED",54 "type": "gst",55 "url": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/company/680/stores/all/legal/documents/free/original/67hihLcgh-GST.pdf",56 "value": "07AAHCA3072C1Z3",57 "verified": true58 }59 ],60 "gst_credentials": {61 "e_invoice": {62 "enabled": false63 },64 "e_waybill": {65 "enabled": false66 }67 },68 "holiday": [],69 "manager": {70 "email": "test@example.com",71 "mobile_no": {72 "country_code": 91,73 "number": "8888888888"74 },75 "name": "AJAY"76 },77 "name": "Mundka1",78 "notification_emails": [79 "test@example.com"80 ],81 "order_acceptance_timing": [82 {83 "closing": {84 "hour": 22,85 "minute": 086 },87 "open": true,88 "opening": {89 "hour": 11,90 "minute": 091 },92 "weekday": "monday"93 },94 {95 "closing": {96 "hour": 22,97 "minute": 098 },99 "open": true,100 "opening": {101 "hour": 11,102 "minute": 0103 },104 "weekday": "tuesday"105 },106 {107 "closing": {108 "hour": 22,109 "minute": 0110 },111 "open": true,112 "opening": {113 "hour": 11,114 "minute": 0115 },116 "weekday": "wednesday"117 },118 {119 "closing": {120 "hour": 22,121 "minute": 0122 },123 "open": true,124 "opening": {125 "hour": 11,126 "minute": 0127 },128 "weekday": "thursday"129 },130 {131 "closing": {132 "hour": 22,133 "minute": 0134 },135 "open": true,136 "opening": {137 "hour": 11,138 "minute": 0139 },140 "weekday": "friday"141 },142 {143 "closing": {144 "hour": 22,145 "minute": 0146 },147 "open": true,148 "opening": {149 "hour": 11,150 "minute": 0151 },152 "weekday": "saturday"153 },154 {155 "closing": {156 "hour": 22,157 "minute": 0158 },159 "open": false,160 "opening": {161 "hour": 11,162 "minute": 0163 },164 "weekday": "sunday"165 }166 ],167 "product_return_config": {168 "on_same_store": true169 },170 "stage": "verified",171 "store_type": "warehouse",172 "tags": [],173 "timing": [174 {175 "closing": {176 "hour": 22,177 "minute": 0178 },179 "open": true,180 "opening": {181 "hour": 11,182 "minute": 0183 },184 "weekday": "monday"185 },186 {187 "closing": {188 "hour": 22,189 "minute": 0190 },191 "open": true,192 "opening": {193 "hour": 11,194 "minute": 0195 },196 "weekday": "tuesday"197 },198 {199 "closing": {200 "hour": 22,201 "minute": 0202 },203 "open": true,204 "opening": {205 "hour": 11,206 "minute": 0207 },208 "weekday": "wednesday"209 },210 {211 "closing": {212 "hour": 22,213 "minute": 0214 },215 "open": true,216 "opening": {217 "hour": 11,218 "minute": 0219 },220 "weekday": "thursday"221 },222 {223 "closing": {224 "hour": 22,225 "minute": 0226 },227 "open": true,228 "opening": {229 "hour": 11,230 "minute": 0231 },232 "weekday": "friday"233 },234 {235 "closing": {236 "hour": 22,237 "minute": 0238 },239 "open": true,240 "opening": {241 "hour": 11,242 "minute": 0243 },244 "weekday": "saturday"245 },246 {247 "closing": {248 "hour": 22,249 "minute": 0250 },251 "open": false,252 "opening": {253 "hour": 11,254 "minute": 0255 },256 "weekday": "sunday"257 }258 ],259 "uid": 22619,260 "verified_by": {261 "user_id": "0"262 },263 "verified_on": "2024-04-05T06:00:05.938631",264 "warnings": {265 "store_address": "Address seems to be inappropriate this might affect the delivery."266 }267 }268 }269}