{"info":{"title":"Fynd Platform's Platform Side APIs","version":"1.4.1","description":"Fynd Platform's Platform Side APIs"},"openapi":"3.0.2","paths":{"/service/platform/audit-trail/v1.0/company/{company_id}/logs":{"get":{"description":"Get a paginated set of logs that can be filtered using the available set of parameters and get the relevant group of logs","summary":"getAuditLogs | Get paginated audit logs","tags":["AuditTrail"],"parameters":[{"in":"path","name":"company_id","description":"Compnay Id","required":true,"schema":{"type":"string","example":"1"}},{"in":"query","name":"qs","description":"Logs Query","required":true,"schema":{"type":"string","example":"%7B%7D&limit=10&company=61&sort=%7B%22_id%22%3A-1%7D"}},{"name":"limit","in":"query","schema":{"type":"integer"},"description":"Current request items count"},{"name":"sort","in":"query","schema":{"type":"object","properties":{"_id":{"type":"integer","enum":[-1,1]}}},"description":"To sort based on _id"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LogSchemaResponse"},"examples":{"default":{"$ref":"#/components/examples/LogSchemaResponse"}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Payload or query is not valid"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"},"example":{"message":"Something wrong happend at our end. we are looking into it."}}}}}},"post":{"description":"Create a log instance that stores all the relevant info to be logged","summary":"createAuditLog | Create logs for auditing later on","tags":["AuditTrail"],"parameters":[{"name":"company_id","in":"path","description":"Company Id","required":true,"schema":{"type":"string","example":"1"}}],"requestBody":{"required":true,"description":"Log Details to be logged","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestBodyAuditLog"},"examples":{"default":{"value":{"log_meta":{"application":"5b9ba586ea176a622163bf4f","entity":{"type":"sales-channel-configuration","id":"5c66bc249f1eef6233b88064","action":"create"},"modifier":{"user_id":"5b9b98150df588546aaea6d2","as_administrator":true,"user_details":{"email":"paullobo@xyz.com","first_name":"Paul","full_name":"Paul Lobo","last_name":"Lobo"}},"device_info":{"user_agent":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/93.0.4577.63 Safari/537.36"},"location":{"IP":"182.48.213.250"},"sessions":""},"log_payload":{"info":"log payload is where you can dump a raw object of your change/update, below is an example of creation of sales channel configuration","configuration":{"sync":{"inventory":true,"price":true},"code":"ANAVBPhsVdRoAUJXWryj","scope":"smartconnect::inventories smartconnect::events smartconnect::pricing smartconnect::orders","grant_type":"authorization_code","redirect_uri":"https://platform.fynd.com/oauth","merchant_id":"A1LHGHL1UX8VZP","key_alias":"arn:aws:kms:eu-west-1:926578745462:alias/A1LHGHL1UX8VZP"},"worker":0,"worker_assigned":"automatic","_id":"6112594ad947b36123b8788c","marketplace":"amazonsmartconnect","created_at":"2021-08-10T10:47:41.635Z","updated_at":"2021-09-07T15:19:25.260Z","is_active":true,"store_mapping_enabled":true,"company_id":1098,"store_mapping":[{"enabled":true,"quantity_buffer":0,"_id":"612e24c27fc3b1b0d75d924a","store_id":11359,"marketplace_store_id":"d49f2853-6b31-485b-ad24-4d99d054c59c"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateLogResponse"},"examples":{"default":{"value":{"message":"Audit log recorded successfully !","internal_message":"Audit log queued"}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Payload is not valid"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"},"example":{"message":"Something wrong happend at our end. we are looking into it."}}}}}}},"/service/platform/audit-trail/v1.0/company/{company_id}/logs/{id}":{"get":{"description":"Get detailed log information by their id","summary":"getAuditLog | Get audit log","tags":["AuditTrail"],"parameters":[{"in":"path","name":"company_id","description":"Compnay Id","required":true,"schema":{"type":"string","example":"1"}},{"in":"path","name":"id","description":"log uuid","required":true,"schema":{"type":"string","example":"602a1366a7486d63f1e915b2"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LogSchemaResponse"},"examples":{"default":{"value":{"entity":{"type":"update-shipment-status","id":"16660872182851894278","action":"update"},"modifier":{"user_id":"a8d7a69b4cd980acc5d2455c","as_administrator":true,"user_details":{"first_name":"Paul","last_name":"Lobo","full_name":"Paul Lobo","email":"paullobo@xyz.com"}},"device_info":{"user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/106.0.0.0 Safari/537.36"},"location":{"IP":"103.173.241.155"},"_id":"634eef735e84e7e1b09aa07c","company":1,"application":null,"sessions":"","date":"2022-10-18T18:24:51.329Z","logs":{"request":{"status_update":{"bags":[403501,403502,403503],"status":"bag_confirmed"}},"response":{"shipments":{"16660872182851894278":{"status":true,"error":"","message":["Requested change is being performed"]}},"error_shipments":[]}},"created_at":"2022-10-18T18:24:51.400Z","modified_at":"2022-10-18T18:24:51.400Z","meta":{"browser":{"name":"Chrome","version":"106.0.0.0","major":"106"},"device":{},"cpu":{},"os":{"name":"Mac OS","version":"10.15.7"},"engine":{"name":"Blink","version":"106.0.0.0"}}}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Payload or query is not valid"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"},"example":{"message":"Something wrong happend at our end. we are looking into it."}}}}}}},"/service/platform/audit-trail/v1.0/company/{company_id}/entity-types":{"get":{"description":"Get a consolidated list of entity types from all the logs stored on the db, which further helps to filter the logs better","summary":"getEntityTypes | Get entity types","tags":["AuditTrail"],"parameters":[{"name":"company_id","in":"path","description":"Company Id","required":true,"schema":{"type":"string","example":"1"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityTypesResponse"},"examples":{"default":{"$ref":"#/components/examples/EntityTypesResponse"}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Payload or query is not valid"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"},"example":{"message":"Something wrong happend at our end. we are looking into it."}}}}}}},"/service/platform/billing/v1.0/company/{company_id}/coupon/check-validity":{"get":{"summary":"checkCouponValidity | Check coupon validity","description":"Check coupon validity.","tags":["Billing"],"x-accessScopes":["company/finance/read"],"parameters":[{"in":"path","name":"company_id","description":"Customer unique id. In case of company it will be company id.","required":true,"schema":{"type":"string","example":"1"}},{"in":"query","name":"plan","description":"ID of the plan.","required":true,"schema":{"type":"string","example":"61a5d6ea3e8c230f3aa2c507"}},{"in":"query","name":"coupon_code","description":"Coupon code.","required":true,"schema":{"type":"string","example":"FYND1"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckValidityResponse"}}}},"400":{"description":"Request failed due to invalid data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Invalid coupon"}}}}}}},"/service/platform/billing/v1.0/company/{company_id}/extension/{extension_id}/subscription":{"post":{"summary":"createSubscriptionCharge | Create subscription charge","description":"Register subscription charge for a seller of your extension.","tags":["Billing"],"x-accessScopes":["company/finance/write"],"parameters":[{"in":"path","name":"company_id","description":"Customer unique id. In case of company it will be company id.","required":true,"schema":{"type":"string","example":"1"}},{"in":"path","name":"extension_id","description":"Extension _id","required":true,"schema":{"type":"string","example":"5f7acb709e76da30e3b92cdb"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSubscriptionCharge"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSubscriptionResponse"}}}},"400":{"description":"Request failed due to invalid data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"examples":{"Multiple Recurring Charge":{"value":{"message":"Multiple `recurring charges` not allowed"}},"Missing recurring field":{"value":{"message":"Missing `recurring` field"}}}}}}}}},"/service/platform/billing/v1.0/company/{company_id}/extension/{extension_id}/subscription/{subscription_id}":{"get":{"summary":"getSubscriptionCharge | Get subscription charge details","description":"Get created subscription charge details","tags":["Billing"],"x-accessScopes":["company/finance/read"],"parameters":[{"in":"path","name":"company_id","description":"Customer unique id. In case of company it will be company id.","required":true,"schema":{"type":"string","example":"1"}},{"in":"path","name":"extension_id","description":"Extension _id","required":true,"schema":{"type":"string","example":"5f7acb709e76da30e3b92cdb"}},{"in":"path","name":"subscription_id","description":"Subscription charge _id","required":true,"schema":{"type":"string","example":"5f7acb709e76da30e3b92cdb"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntitySubscription"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFound"},"example":{"message":"Subscription not found"}}}}}}},"/service/platform/billing/v1.0/company/{company_id}/extension/{extension_id}/subscription/{subscription_id}/cancel":{"post":{"summary":"cancelSubscriptionCharge | Cancel subscription charge","description":"Cancel subscription and attached charges.","tags":["Billing"],"x-accessScopes":["company/finance/write"],"parameters":[{"in":"path","name":"company_id","description":"Customer unique id. In case of company it will be company id.","required":true,"schema":{"type":"string","example":"1"}},{"in":"path","name":"extension_id","description":"Extension _id","required":true,"schema":{"type":"string","example":"5f7acb709e76da30e3b92cdb"}},{"in":"path","name":"subscription_id","description":"Subscription charge _id","required":true,"schema":{"type":"string","example":"5f7acb709e76da30e3b92cdb"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntitySubscription"}}}},"400":{"description":"Request failed due to invalid data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Subscription is already cancelled"}}}},"404":{"description":"Resource Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFound"},"example":{"message":"Subscription not found"}}}}}}},"/service/platform/billing/v1.0/company/{company_id}/extension/{extension_id}/one_time_charge":{"post":{"summary":"createOneTimeCharge | Create one time subscription charge","description":"Register one time subscription charge for a seller of your extension.","tags":["Billing"],"x-accessScopes":["company/finance/write"],"parameters":[{"in":"path","name":"company_id","description":"Customer unique id. In case of company it will be company id.","required":true,"schema":{"type":"string","example":"1"}},{"in":"path","name":"extension_id","description":"Extension _id","required":true,"schema":{"type":"string","example":"5f7acb709e76da30e3b92cdb"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOneTimeCharge"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOneTimeChargeResponse"}}}},"400":{"description":"Request failed due to invalid data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"examples":{"Missing one_time field":{"value":{"message":"Missing `one_time` field"}}}}}}}}},"/service/platform/billing/v1.0/company/{company_id}/extension/{extension_id}/charge/{charge_id}":{"get":{"summary":"getChargeDetails | Get subscription charge details","description":"Get created subscription charge details","tags":["Billing"],"x-accessScopes":["company/finance/read"],"parameters":[{"in":"path","name":"company_id","description":"Customer unique id. In case of company it will be company id.","required":true,"schema":{"type":"string","example":"1"}},{"in":"path","name":"extension_id","description":"Extension _id","required":true,"schema":{"type":"string","example":"5f7acb709e76da30e3b92cdb"}},{"in":"path","name":"charge_id","description":"Standalone charge _id","required":true,"schema":{"type":"string","example":"5f7acb709e76da30e3b92cdb"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OneTimeChargeEntity"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFound"},"example":{"message":"Charge not found"}}}}}}},"/service/platform/billing/v1.0/company/{company_id}/invoice/list":{"get":{"summary":"getInvoices | Get invoices","description":"Get invoices.","x-accessScopes":["company/finance/read"],"tags":["Billing"],"parameters":[{"in":"path","name":"company_id","description":"Customer unique id. In case of company it will be company id.","required":true,"schema":{"type":"string","example":"1"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Invoices"},"examples":{"default":{"$ref":"#/components/examples/Invoices"}}}}}}}},"/service/platform/billing/v1.0/company/{company_id}/invoice/{invoice_id}":{"get":{"summary":"getInvoiceById | Get invoice by id","description":"Get invoice by id.","x-accessScopes":["company/finance/read"],"tags":["Billing"],"parameters":[{"in":"path","name":"company_id","description":"Customer unique id. In case of company it will be company id.","required":true,"schema":{"type":"string","example":"1"}},{"in":"path","name":"invoice_id","description":"Invoice id","required":true,"schema":{"type":"string","example":"5f7acb709e76da30e3b92cdb"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Invoice"},"examples":{"default":{"$ref":"#/components/examples/Invoice"}}}}}}}},"/service/platform/billing/v1.0/company/{company_id}/subscription/customer-detail":{"get":{"summary":"getCustomerDetail | Get subscription customer detail","description":"Get subscription customer detail.","x-accessScopes":["company/finance/read"],"tags":["Billing"],"parameters":[{"in":"path","name":"company_id","description":"Customer unique id. In case of company it will be company id.","required":true,"schema":{"type":"string","example":"1"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionCustomer"},"examples":{"default":{"$ref":"#/components/examples/SubscriptionCustomerRes"}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFound"},"example":{"message":"Customer not found"}}}}}},"post":{"summary":"upsertCustomerDetail | Upsert subscription customer detail","description":"Upsert subscription customer detail.","x-accessScopes":["company/finance/write"],"tags":["Billing"],"parameters":[{"in":"path","name":"company_id","description":"Customer unique id. In case of company it will be company id.","required":true,"schema":{"type":"string","example":"1"}}],"requestBody":{"description":"Customer upsert req data","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionCustomerCreate"},"examples":{"default":{"$ref":"#/components/examples/SubscriptionCustomerPostReq"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionCustomer"},"examples":{"default":{"$ref":"#/components/examples/SubscriptionCustomerRes"}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFound"},"example":{"message":"Customer not found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"},"example":{"message":"Opps something went wrong !!","code":"INTERNAL_SERVER_ERROR"}}}}}}},"/service/platform/billing/v1.0/company/{company_id}/subscription/current":{"get":{"summary":"getSubscription | Get current subscription detail","description":"If subscription is active then it will return is_enabled true and return subscription object. If subscription is not active then is_enabled false and message.\n","x-accessScopes":["company/finance/read"],"tags":["Billing"],"parameters":[{"in":"path","name":"company_id","description":"Customer unique id. In case of company it will be company id.","required":true,"schema":{"type":"string","example":"1"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionStatus"},"examples":{"Active subscription":{"$ref":"#/components/examples/SubscriptionActiveRes"},"Inactive subscription":{"$ref":"#/components/examples/SubscriptionInactiveRes"}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"},"example":{"message":"Opps something went wrong !!","code":"INTERNAL_SERVER_ERROR"}}}}}}},"/service/platform/billing/v1.0/company/{company_id}/subscription/current-limit":{"get":{"summary":"getFeatureLimitConfig | Get subscription subscription limits","description":"Get subscription subscription limits.","x-accessScopes":["company/finance/read"],"tags":["Billing"],"parameters":[{"in":"path","name":"company_id","description":"Customer unique id. In case of company it will be company id.","required":true,"schema":{"type":"string","example":"1"}},{"in":"query","name":"product_suite","schema":{"type":"string"}},{"in":"query","name":"type","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionLimit"},"examples":{"default":{"$ref":"#/components/examples/CurrentLimitRes"}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"},"example":{"message":"Opps something went wrong !!","code":"INTERNAL_SERVER_ERROR"}}}}}}},"/service/platform/billing/v1.0/company/{company_id}/subscription/activate":{"post":{"summary":"activateSubscriptionPlan | Activate subscription","description":"It will activate subscription plan for customer","x-accessScopes":["company/finance/read"],"tags":["Billing"],"parameters":[{"in":"path","name":"company_id","description":"Customer unique id. In case of company it will be company id.","required":true,"schema":{"type":"string","example":"1"}}],"requestBody":{"description":"Subscription activate req","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionActivateReq"},"examples":{"default":{"$ref":"#/components/examples/SubscriptionActivateReq"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionActivateRes"},"examples":{"default":{"$ref":"#/components/examples/SubscriptionActivateRes"}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFound"},"example":{"message":"Customer not found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"},"example":{"message":"Opps something went wrong !!","code":"INTERNAL_SERVER_ERROR"}}}}}}},"/service/platform/billing/v1.0/company/{company_id}/subscription/cancel":{"post":{"summary":"cancelSubscriptionPlan | Cancel subscription","description":"It will cancel current active subscription.","x-accessScopes":["company/finance/read"],"tags":["Billing"],"parameters":[{"in":"path","name":"company_id","description":"Customer unique id. In case of company it will be company id.","required":true,"schema":{"type":"string","example":"1"}}],"requestBody":{"description":"subscription cancellation req","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelSubscriptionReq"},"examples":{"default":{"$ref":"#/components/examples/CancelSubscriptionReq"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelSubscriptionRes"},"examples":{"default":{"$ref":"#/components/examples/CancelSubscriptionRes"}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFound"},"example":{"message":"Subscription not found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"},"example":{"message":"Opps something went wrong !!","code":"INTERNAL_SERVER_ERROR"}}}}}}},"/service/platform/billing/v1.0/company/{company_id}/plans":{"get":{"summary":"getEnterprisePlans | Get Enterprise Plans","description":"Get Enterprise Plans.\n","x-accessScopes":["company/finance/read"],"tags":["Billing"],"parameters":[{"in":"path","name":"company_id","description":"Customer unique id. In case of company it will be company id.","required":true,"schema":{"type":"string","example":"1"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Plan"}},"examples":{"Enterprise Plans":{"$ref":"#/components/examples/PlanListGet"}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"},"example":{"message":"Opps something went wrong !!","code":"INTERNAL_SERVER_ERROR"}}}}}}},"/service/platform/billing/v1.0/company/{company_id}/plan/status":{"patch":{"summary":"planStatusUpdate | Update Status of The plan","description":"It will update the status of the plan","x-accessScopes":["company/finance/write"],"tags":["Billing"],"parameters":[{"in":"path","name":"company_id","description":"Customer unique id. In case of company it will be company id.","required":true,"schema":{"type":"string","example":"1"}}],"requestBody":{"description":"plan status req","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlanStatusUpdateReq"},"examples":{"default":{"$ref":"#/components/examples/PlanDetailedGet"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Plan"},"examples":{"default":{"$ref":"#/components/examples/PlanDetailedGet"}}}}},"400":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"},"example":{"message":"Reason is required"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"},"example":{"message":"Opps something went wrong !!","code":"INTERNAL_SERVER_ERROR"}}}}}}},"/service/platform/billing/v1.0/company/{company_id}/payment/initiate":{"post":{"summary":"subscripePlan | Subscribe plan.","description":"It will subscribe a plan.","x-accessScopes":["company/finance/write"],"tags":["Billing"],"parameters":[{"in":"path","name":"company_id","description":"Customer unique id. In case of company it will be company id.","required":true,"schema":{"type":"string","example":"1"}}],"requestBody":{"description":"subscribe plan.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SunscribePlan"},"examples":{"default":{"$ref":"#/components/examples/SunscribePlanExample"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscribePlanRes"},"examples":{"default":{"$ref":"#/components/examples/SubscriptionPlanResExample"}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFound"},"example":{"message":"Subscription not found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"},"example":{"message":"Opps something went wrong !!","code":"INTERNAL_SERVER_ERROR"}}}}}}},"/service/platform/billing/v1.0/company/{company_id}/entity/detail":{"get":{"summary":"getentityDetail | Generic api to get the entity detail","description":"Generic api to get the entity detail","tags":["Billing"],"x-accessScopes":["company/finance/read"],"parameters":[{"in":"path","name":"company_id","description":"Customer unique id. In case of company it will be company id.","required":true,"schema":{"type":"string","example":"1"}},{"in":"query","name":"entity_name","description":"Entity name.","required":true,"schema":{"type":"string","example":"plan/subscription"}},{"in":"query","name":"entity_id","description":"Entity unique id.","required":false,"schema":{"type":"string","example":"1"}},{"in":"query","name":"channel","description":"Ordering channel.","required":true,"schema":{"type":"string","example":"ecomm"}},{"in":"query","name":"component","description":"The coponents the user would like to know.","required":false,"schema":{"type":"string","example":"fee/feature"}},{"in":"query","name":"component_name","description":"The name of component the preferred to be fetched.","required":false,"schema":{"type":"string","example":"logistic_fee"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityResponse"}}}},"400":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"},"example":{"message":"Reason is required"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFound"},"example":{"message":"Subscription not found"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"},"example":{"message":"Opps something went wrong !!","code":"INTERNAL_SERVER_ERROR"}}}}}}},"/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/coupon":{"get":{"summary":"getCoupons | Get with single coupon details or coupon list","description":"Get coupon list with pagination","tags":["Cart"],"parameters":[{"schema":{"type":"string"},"description":"Current company id","in":"path","required":true,"name":"company_id"},{"schema":{"type":"string"},"description":"Current Application _id","in":"path","required":true,"name":"application_id"},{"name":"page_no","in":"query","schema":{"type":"integer","default":0,"description":"current page no as per pagination"}},{"name":"page_size","in":"query","schema":{"type":"integer","default":10,"description":"Coupon max records fetched in single request"}},{"name":"is_archived","in":"query","schema":{"type":"boolean","description":"Filter by active or inactive coupon","default":false}},{"name":"title","in":"query","schema":{"type":"string","description":"Filter by `title`"}},{"name":"is_public","in":"query","schema":{"type":"boolean","description":"Filter by `is_public`"}},{"name":"is_display","in":"query","schema":{"type":"boolean","description":"Filter by `is_display`"}},{"name":"type_slug","in":"query","schema":{"type":"string","description":"Filter by coupon type"}},{"name":"code","in":"query","schema":{"type":"string","description":"Filter by `code`"}}],"responses":{"200":{"description":"Coupon List for sent page_size and page_no","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CouponsResponse"},"examples":{"Coupon list for sent filter and page size":{"value":{"items":[{"_id":"5e1d9bec6d6b7e000146c840","rule":[],"identifiers":{},"validity":{"priority":0},"type_slug":"bundle_quantity_absolute","display_meta":{"title":"percent50 title"},"_schedule":{"next_schedule":[{"start":"2020-01-14T10:45:03.600000+00:00","end":"2020-01-16T10:45:03+00:00"}],"duration":null,"start":"2020-01-14T10:45:03.600000+00:00","end":"2020-01-16T10:45:03+00:00","cron":""},"state":{"is_public":true,"is_display":true,"is_archived":false},"ownership":{"payable_category":"seller","payable_by":""},"code":"percent50","rule_definition":{"type":"percentage","scope":["category_id"],"applicable_on":"quantity","calculate_on":"esp","value_type":"percentage"}}],"page":{"type":"","has_next":true,"size":10,"current":1,"item_total":30}}}}}}}}},"post":{"summary":"createCoupon | Create new coupon","description":"Create new coupon","tags":["Cart"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CouponAdd"},"example":{"rule_definition":{"scope":["brand_id"],"calculate_on":"esp","is_exact":false,"currency_code":"INR","type":"bundle","applicable_on":"quantity","auto_apply":false,"value_type":"absolute"},"display_meta":{"description":"","remove":{"subtitle":"","title":""},"apply":{"subtitle":"You saved 1000 bucks","title":"Wow! You just got an awesome deal"},"subtitle":"test subtitle","auto":{"subtitle":"","title":""},"title":"1000 Off on first 2 items"},"rule":[{"max":0,"min":3000,"value":1001,"key":2}],"state":{"is_display":true,"is_archived":false,"is_public":true},"identifiers":{"user_id":[],"brand_id":[9]},"ownership":{"payable_category":"seller","payable_by":""},"_schedule":{"duration":null,"end":"2019-10-19T08:47:39.025Z","next_schedule":[{"start":"2019-10-18T08:35:39.000Z","end":"2019-10-19T08:47:39.025Z"}],"published":false,"start":"2019-10-18T08:35:39.000Z","cron":null},"validation":{"user_registered_after":null,"app_id":["5e1d9bec6d6b7e000146c840"],"anonymous":true},"validity":{"priority":0},"action":{"action_date":null,"txn_mode":"coupon"},"type_slug":"bundle_quantity_absolute","restrictions":{"uses":{"remaining":{"app":-1,"total":-1,"user":-1},"maximum":{"app":-1,"total":-1,"user":-1}},"post_order":{"return_allowed":true,"cancellation_allowed":true},"platforms":["web","android","ios"]},"code":"1000off"}}}},"responses":{"201":{"description":"Coupon Created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessMessage"},"example":{"success":true,"message":"Coupon Created"}}}},"400":{"description":"Invalid coupon data or existing coupon code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationErrorResponse"},"examples":{"Coupon code exists":{"value":{"success":false,"message":"Coupon already code exist"}}}}}}},"parameters":[{"schema":{"type":"string"},"description":"Current company id","in":"path","required":true,"name":"company_id"},{"schema":{"type":"string"},"description":"Current Application _id","in":"path","required":true,"name":"application_id"}]}},"/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/coupon/{id}":{"get":{"summary":"getCouponById | Get with single coupon details or coupon list","description":"Get single coupon details with `id` in path param","tags":["Cart"],"parameters":[{"schema":{"type":"string"},"description":"Current company id","in":"path","required":true,"name":"company_id"},{"schema":{"type":"string"},"description":"Current Application _id","in":"path","required":true,"name":"application_id"},{"name":"id","in":"path","required":true,"schema":{"type":"string","description":"Coupon mongo _id for fetching single coupon data for editing"}}],"responses":{"200":{"description":"Coupon object for sent `id`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CouponUpdate"},"example":{"_id":"5e1d9bec6d6b7e000146c840","validation":{"anonymous":true,"app_id":["5cd3db5e9d692cfe5302a7ba"],"user_registered_after":null},"rule":[{"key":1,"max":1500,"min":3000,"value":50}],"display_meta":{"title":"percent50 title","description":"percent50 description","auto":{"title":"","subtitle":""},"subtitle":"percent50 subtitle","remove":{"title":"","subtitle":""},"apply":{"title":"percen50 mt","subtitle":"percen50 ms"}},"date_meta":{"modified_on":"2020-02-04T14:27:00.577000+00:00","created_on":"2020-01-14T10:46:04.474000+00:00"},"action":{"action_date":null,"txn_mode":"coupon"},"identifiers":{"category_id":[465,192,133,134,150,151,155,193,157,191,154,152,417,168,416,167,166,162,161,163,165,160],"user_id":[],"store_id":[],"company_id":[]},"author":{"modified_by":"23109086","created_by":"23206328"},"_schedule":{"next_schedule":[{"start":"2020-01-14T10:45:03.600000+00:00","end":"2020-01-16T10:45:03+00:00"}],"duration":null,"start":"2020-01-14T10:45:03.600000+00:00","end":"2020-01-16T10:45:03+00:00","cron":""},"state":{"is_public":true,"is_display":true,"is_archived":false},"ownership":{"payable_category":"seller","payable_by":""},"validity":{"priority":0},"code":"percent50","rule_definition":{"calculate_on":"esp","value_type":"percentage","is_exact":false,"type":"percentage","scope":["category_id"],"auto_apply":false,"applicable_on":"quantity","currency_code":"INR"},"restrictions":{"price_range":{"max":-1,"min":-1},"uses":{"remaining":{"app":-1,"user":-1,"total":-1},"maximum":{"app":-1,"user":-1,"total":-1}},"post_order":{"cancellation_allowed":true,"return_allowed":true},"platforms":["web","android","ios"]},"type_slug":"percentage_quantity_percentage"}}}},"404":{"description":"Coupon not found for passed `id`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationErrorResponse"},"example":{"success":false,"message":"Coupon Not found"}}}}}},"put":{"summary":"updateCoupon | Update existing coupon configuration","description":"Update coupon with id sent in `id`","tags":["Cart"],"parameters":[{"schema":{"type":"string"},"description":"Current company id","in":"path","required":true,"name":"company_id"},{"schema":{"type":"string"},"description":"Current Application _id","in":"path","required":true,"name":"application_id"},{"name":"id","in":"path","schema":{"type":"string","description":"Coupon mongo _id for fetching single coupon data for editing"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CouponUpdate"},"example":{"rule_definition":{"scope":["brand_id"],"calculate_on":"esp","is_exact":false,"currency_code":"INR","type":"bundle","applicable_on":"quantity","auto_apply":false,"value_type":"absolute"},"display_meta":{"description":"","remove":{"subtitle":"","title":""},"apply":{"subtitle":"You saved 1000 bucks","title":"Wow! You just got an awesome deal"},"subtitle":"test subtitle","auto":{"subtitle":"","title":""},"title":"1000 Off on first 2 items"},"rule":[{"max":0,"min":3000,"value":1001,"key":2}],"state":{"is_display":true,"is_archived":false,"is_public":true},"identifiers":{"user_id":[],"brand_id":[9]},"ownership":{"payable_category":"seller","payable_by":""},"_schedule":{"duration":null,"end":"2019-10-19T08:47:39.025Z","next_schedule":[{"start":"2019-10-18T08:35:39.000Z","end":"2019-10-19T08:47:39.025Z"}],"published":false,"start":"2019-10-18T08:35:39.000Z","cron":null},"validation":{"user_registered_after":null,"app_id":["5e1d9bec6d6b7e000146c840"],"anonymous":true},"validity":{"priority":0},"action":{"action_date":null,"txn_mode":"coupon"},"type_slug":"bundle_quantity_absolute","restrictions":{"uses":{"remaining":{"app":-1,"total":-1,"user":-1},"maximum":{"app":-1,"total":-1,"user":-1}},"post_order":{"return_allowed":true,"cancellation_allowed":true},"platforms":["web","android","ios"]},"code":"1000off"}}}},"responses":{"200":{"description":"Coupon updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessMessage"},"example":{"success":true,"message":"Coupon Updated"}}}},"404":{"description":"Coupon not found for `id` from path params","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationErrorResponse"},"example":{"success":false,"message":"Coupon Not found"}}}}}},"patch":{"summary":"updateCouponPartially | Update coupon archive state and schedule","description":"Update archive/unarchive and change schedule for coupon","tags":["Cart"],"parameters":[{"schema":{"type":"string"},"description":"Current company id","in":"path","required":true,"name":"company_id"},{"schema":{"type":"string"},"description":"Current Application _id","in":"path","required":true,"name":"application_id"},{"name":"id","in":"path","schema":{"type":"string","description":"Coupon mongo _id for fetching single coupon data for editing"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CouponPartialUpdate"},"examples":{"Archive/Unarchive coupon":{"value":{"archive":true}},"Change coupon schedule":{"value":{"schedule":{"cron":"","start":"2020-01-14T10:45:03.600000+00:00","end":"2020-01-16T10:45:03+00:00","duration":null}}}}}}},"responses":{"200":{"description":"Coupon updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessMessage"},"examples":{"Archive or Unarchive coupon":{"value":{"success":true,"message":"Coupon Updated"}},"Coupon schedule updated successfully":{"value":{"success":true,"message":"Coupon schedule updated"}}}}}},"404":{"description":"Coupon not found for `id` from path params","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationErrorResponse"},"example":{"success":false,"message":"Coupon Not found"}}}}}}},"/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/promotion":{"get":{"summary":"getPromotions | Get promotion list","description":"Get promotion list with pagination","tags":["Cart"],"parameters":[{"schema":{"type":"string"},"description":"Current company id","in":"path","required":true,"name":"company_id"},{"schema":{"type":"string"},"description":"Current Application _id","in":"path","required":true,"name":"application_id"},{"name":"page_no","in":"query","schema":{"type":"integer","default":0,"description":"current page no as per pagination"}},{"name":"page_size","in":"query","schema":{"type":"integer","default":10,"description":"Promotion max records fetched in single request"}},{"name":"q","in":"query","schema":{"type":"string","description":"Filter by name"}},{"name":"is_active","in":"query","schema":{"type":"boolean","description":"Filter by active or inactive promotion","default":true}},{"name":"promo_group","in":"query","schema":{"type":"string","description":"Filter promotion group","enum":["product","cart","contract","ladder_price","limited_timer"]}},{"name":"promotion_type","in":"query","schema":{"type":"string","description":"Filter promotion type"}},{"name":"fp_panel","in":"query","schema":{"type":"string","description":"Filter non extension promotions"}},{"name":"promotion_id","in":"query","schema":{"type":"string","description":"Filter by promotion _id"}}],"responses":{"200":{"description":"Promotion List for sent page_size and page_no","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PromotionsResponse"},"examples":{"Promotion list for sent filter and page size":{"value":{"items":[{"_id":"61dc8dc9adf45b2273a70a6e","application_id":"000000000000000000000004","promo_group":"product","promotion_type":"bogo","date_meta":{"modified_on":"2022-01-11T05:47:11.503000+00:00","created_on":"2022-01-10T19:49:29.917000+00:00"},"display_meta":{"name":"Test BOGO promo"},"ownership":{"payable_category":"seller","payable_by":""},"author":{"created_by":"5","modified_by":"5"},"_schedule":{"start":"2022-01-10T18:45:36.311000+00:00","end":"2025-01-10T18:45:36.311000+00:00","published":true,"next_schedule":[{"start":"2022-01-10T18:45:36.311000+00:00","end":null,"cron":""}],"duration":0},"discount_rules":[{"buy_condition":"( rule#1 )","offer":{"max_offer_quantity":2},"discount_type":"bogo","item_criteria":{"item_brand":[2,14,65]}}],"buy_rules":{"rule#1":{"cart_quantity":{"greater_than_equals":5},"item_brand":[1,2,14,16,29,39,43,65,73]}},"mode":"promotion"}],"page":{"type":"number","has_next":true,"size":10,"current":1,"item_total":30}}}}}}}}},"post":{"summary":"createPromotion | Create new promotion","description":"Create new promotion","tags":["Cart"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PromotionAdd"},"example":{"application_id":"000000000000000000000001","promo_group":"product","promotion_type":"bogo","date_meta":{"modified_on":"2022-01-11T05:47:11.503000+00:00","created_on":"2022-01-10T19:49:29.917000+00:00"},"discount_rules":[{"buy_condition":"( rule#1 )","offer":{"max_offer_quantity":2},"discount_type":"bogo","item_criteria":{"item_brand":[2,14,65]}}],"buy_rules":{"rule#1":{"cart_quantity":{"greater_than_equals":5},"item_brand":[1,2,14,16,29,39,43,65,73]}},"display_meta":{"offer_text":"Test","name":"Test BOGO promo","description":"Test"},"apply_all_discount":false,"apply_exclusive":null,"stackable":true,"restrictions":{"user_id":[],"anonymous_users":true,"platforms":["web","android","ios"],"post_order":{"cancellation_allowed":true,"return_allowed":true},"uses":{"remaining":{"user":0,"total":0},"maximum":{"user":0,"total":0}},"payments":[]},"_custom_json":{},"author":{"created_by":"5","modified_by":"5"},"_schedule":{"start":"2022-01-10T18:45:36.311Z","end":"2023-01-10T18:45:36.311Z","published":true,"next_schedule":[{"start":"2022-01-10T18:45:36.311Z","end":null}],"cron":"","duration":0},"apply_priority":1,"visiblility":{"pdp":true,"coupon_list":false},"ownership":{"payable_by":"","payable_category":"seller"},"currency":"INR","mode":"promotion","post_order_action":{"action_date":null,"action_type":""},"indexed_criteria":{"item_brand":[1,2]}}}}},"responses":{"201":{"description":"Promotion Created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PromotionAdd"},"example":{"_id":"61dc8dc9adf45b2273a70a6e","application_id":"000000000000000000000001","promo_group":"product","promotion_type":"bogo","date_meta":{"modified_on":"2022-01-11T05:47:11.503000+00:00","created_on":"2022-01-10T19:49:29.917000+00:00"},"discount_rules":[{"buy_condition":"( rule#1 )","offer":{"max_offer_quantity":2},"discount_type":"bogo","item_criteria":{"item_brand":[2,14,65]}}],"buy_rules":{"rule#1":{"cart_quantity":{"greater_than_equals":5},"item_brand":[1,2,14,16,29,39,43,65,73]}},"display_meta":{"offer_text":"Test","name":"Test BOGO promo","description":"Test"},"apply_all_discount":false,"apply_exclusive":null,"stackable":true,"restrictions":{"user_id":[],"anonymous_users":true,"platforms":["web","android","ios"],"post_order":{"cancellation_allowed":true,"return_allowed":true},"uses":{"remaining":{"user":0,"total":0},"maximum":{"user":0,"total":0}},"payments":[]},"_custom_json":{},"author":{"created_by":"5","modified_by":"5"},"_schedule":{"start":"2022-01-10T18:45:36.311Z","end":"2025-01-10T18:45:36.311Z","published":true,"next_schedule":[{"start":"2022-01-10T18:45:36.311Z","end":"2025-01-10T18:45:36.311Z"}],"cron":"","duration":0},"apply_priority":1,"visiblility":{"pdp":true,"coupon_list":false},"ownership":{"payable_by":"","payable_category":"seller"},"currency":"INR","mode":"promotion","post_order_action":{"action_date":null,"action_type":""},"indexed_criteria":{"item_brand":[1,2]}}}}},"400":{"description":"Invalid promotion data or existing promotion code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationErrorResponse"},"examples":{"Promotion code exists":{"value":{"success":false,"message":"Promotion already code exist"}}}}}}},"parameters":[{"schema":{"type":"string"},"description":"Current company id","in":"path","required":true,"name":"company_id"},{"schema":{"type":"string"},"description":"Current Application _id","in":"path","required":true,"name":"application_id"}]}},"/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/promotion/{id}":{"get":{"summary":"getPromotionById | Get with single promotion details or promotion list","description":"Get single promotion details with `id` in path param","tags":["Cart"],"parameters":[{"schema":{"type":"string"},"description":"Current company id","in":"path","required":true,"name":"company_id"},{"schema":{"type":"string"},"description":"Current Application _id","in":"path","required":true,"name":"application_id"},{"name":"id","in":"path","required":true,"schema":{"type":"string","description":"Promotion mongo _id for fetching single promotion data for editing"}}],"responses":{"200":{"description":"Promotion object for sent `id`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PromotionUpdate"},"example":{"_id":"61dc8dc9adf45b2273a70a6e","application_id":"000000000000000000000001","promo_group":"product","promotion_type":"bogo","date_meta":{"modified_on":"2022-01-11T05:47:11.503000+00:00","created_on":"2022-01-10T19:49:29.917000+00:00"},"discount_rules":[{"buy_condition":"( rule#1 )","offer":{"max_offer_quantity":2},"discount_type":"bogo","item_criteria":{"item_brand":[2,14,65]}}],"buy_rules":{"rule#1":{"cart_quantity":{"greater_than_equals":5},"item_brand":[1,2,14,16,29,39,43,65,73]}},"display_meta":{"offer_text":"Test","name":"Test BOGO promo","description":"test"},"apply_all_discount":false,"apply_exclusive":null,"stackable":true,"restrictions":{"user_id":[],"anonymous_users":true,"platforms":["web","android","ios"],"post_order":{"cancellation_allowed":true,"return_allowed":true},"uses":{"remaining":{"user":0,"total":0},"maximum":{"user":0,"total":0}},"payments":[]},"_custom_json":{},"author":{"created_by":"5","modified_by":"5"},"_schedule":{"start":"2022-01-10T18:45:36.311Z","end":"2025-01-10T18:45:36.311Z","published":true,"next_schedule":[{"start":"2022-01-10T18:45:36.311Z","end":"2025-01-10T18:45:36.311Z"}],"cron":"","duration":0},"apply_priority":1,"visiblility":{"pdp":true,"coupon_list":false},"ownership":{"payable_by":"","payable_category":"seller"},"currency":"INR","mode":"promotion","post_order_action":{"action_date":null,"action_type":""},"indexed_criteria":{"item_brand":[1,2]}}}}},"404":{"description":"Promotion not found for passed `id`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationErrorResponse"},"example":{"success":false,"message":"Promotion Not found"}}}}}},"put":{"summary":"updatePromotion | Update existing promotion configuration","description":"Update promotion with id sent in `id`","tags":["Cart"],"parameters":[{"schema":{"type":"string"},"description":"Current company id","in":"path","required":true,"name":"company_id"},{"schema":{"type":"string"},"description":"Current Application _id","in":"path","required":true,"name":"application_id"},{"name":"id","in":"path","schema":{"type":"string","description":"Promotion mongo _id for fetching single promotion data for editing"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PromotionUpdate"},"example":{"_id":"61dc8dc9adf45b2273a70a6e","application_id":"000000000000000000000001","promo_group":"product","promotion_type":"bogo","date_meta":{"modified_on":"2022-01-11T05:47:11.503000+00:00","created_on":"2022-01-10T19:49:29.917000+00:00"},"discount_rules":[{"buy_condition":"( rule#1 )","offer":{"max_offer_quantity":2},"discount_type":"bogo","item_criteria":{"item_brand":[2,14,65]}}],"buy_rules":{"rule#1":{"cart_quantity":{"greater_than_equals":5},"item_brand":[1,2,14,16,29,39,43,65,73]}},"display_meta":{"offer_text":"Test","name":"Test BOGO promo","description":"Test"},"apply_all_discount":false,"apply_exclusive":null,"stackable":true,"restrictions":{"user_id":[],"anonymous_users":true,"platforms":["web","android","ios"],"post_order":{"cancellation_allowed":true,"return_allowed":true},"uses":{"remaining":{"user":0,"total":0},"maximum":{"user":0,"total":0}},"payments":[]},"_custom_json":{},"author":{"created_by":"5","modified_by":"5"},"_schedule":{"start":"2022-01-10T18:45:36.311Z","end":"2025-01-10T18:45:36.311Z","published":true,"next_schedule":[{"start":"2022-01-10T18:45:36.311Z","end":"2025-01-10T18:45:36.311Z"}],"cron":"","duration":0},"apply_priority":1,"visiblility":{"pdp":true,"coupon_list":false},"ownership":{"payable_by":"","payable_category":"seller"},"currency":"INR","mode":"promotion","post_order_action":{"action_date":null,"action_type":""},"indexed_criteria":{"item_brand":[1,2]}}}}},"responses":{"200":{"description":"Promotion updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PromotionUpdate"},"example":{"_id":"61dc8dc9adf45b2273a70a6e","application_id":"000000000000000000000001","promo_group":"product","promotion_type":"bogo","date_meta":{"modified_on":"2022-01-11T05:47:11.503000+00:00","created_on":"2022-01-10T19:49:29.917000+00:00"},"discount_rules":[{"buy_condition":"( rule#1 )","offer":{"max_offer_quantity":2},"discount_type":"bogo","item_criteria":{"item_brand":[2,14,65]}}],"buy_rules":{"rule#1":{"cart_quantity":{"greater_than_equals":5},"item_brand":[1,2,14,16,29,39,43,65,73]}},"display_meta":{"offer_text":"Test","name":"Test BOGO promo","description":"Test"},"apply_all_discount":false,"apply_exclusive":null,"stackable":true,"restrictions":{"user_id":[],"anonymous_users":true,"platforms":["web","android","ios"],"post_order":{"cancellation_allowed":true,"return_allowed":true},"uses":{"remaining":{"user":0,"total":0},"maximum":{"user":0,"total":0}},"payments":[]},"_custom_json":{},"author":{"created_by":"5","modified_by":"5"},"_schedule":{"start":"2022-01-10T18:45:36.311Z","end":"2025-01-10T18:45:36.311Z","published":true,"next_schedule":[{"start":"2022-01-10T18:45:36.311Z","end":"2025-01-10T18:45:36.311Z"}],"cron":"","duration":0},"apply_priority":1,"visiblility":{"pdp":true,"coupon_list":false},"ownership":{"payable_by":"","payable_category":"seller"},"currency":"INR","mode":"promotion","post_order_action":{"action_date":null,"action_type":""},"indexed_criteria":{"item_brand":[1,2]}}}}},"404":{"description":"Promotion not found for `id` from path params","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationErrorResponse"},"example":{"success":false,"message":"Promotion Not found"}}}}}},"patch":{"summary":"updatePromotionPartially | Update promotion publish state and schedule","description":"Update publish/unpublish and change schedule for promotion","tags":["Cart"],"parameters":[{"schema":{"type":"string"},"description":"Current company id","in":"path","required":true,"name":"company_id"},{"schema":{"type":"string"},"description":"Current Application _id","in":"path","required":true,"name":"application_id"},{"name":"id","in":"path","schema":{"type":"string","description":"Promotion mongo _id for fetching single promotion data for editing"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PromotionPartialUpdate"},"examples":{"Publish/Unpublish promotion":{"value":{"publish":true}},"Change promotion schedule":{"value":{"schedule":{"published":true,"start":"2020-01-14T10:45:03.600000+00:00","end":"2020-01-16T10:45:03+00:00"}}}}}}},"responses":{"200":{"description":"Promotion updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessMessage"},"examples":{"Publish or Unpublish promotion":{"value":{"success":true,"message":"Promotion Updated"}},"Promotion schedule updated successfully":{"value":{"success":true,"message":"Promotion schedule updated"}}}}}},"404":{"description":"Promotion not found for `id` from path params","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationErrorResponse"},"example":{"success":false,"message":"Promotion Not found"}}}}}}},"/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/promo-coupons":{"get":{"summary":"getPromosCouponConfig | Fetch all promos that are set as active","description":"Use this API to get list of all the active promos/coupons.","tags":["Cart"],"parameters":[{"schema":{"type":"string"},"description":"Current company id","in":"path","required":true,"name":"company_id"},{"schema":{"type":"string"},"description":"Current Application _id","in":"path","required":true,"name":"application_id"},{"name":"entity_type","description":"entity_type as promotion or coupon","in":"query","schema":{"type":"string","enum":["promotion","coupon"]}},{"name":"is_hidden","description":"promo-coupon config shown or not","in":"query","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success. Returns a list of all the curently active coupons/promos","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivePromosResponse"},"example":{"status":"Success","items":[{"_id":"634647aa9d4b59bf1a0c1269","entity_slug":"percentage_quantity_percentage","title":"X Percentage Value","subtitle":"Get a fixed percentage discount on the effective selling price","description":"Here, Buy items(BI) is the minimum number of items eligible for a discount Percentage Value(D) is the fixed percentage discount Maximum Discount Amount(MD) (optional) is a limit to the discount Minimum Cart Value(MCV) (optional) is the minimum price of the cart items Apply coupon on exact quantities (optional) if checked, will apply the coupon only to the specified Buy items and if unchecked, will apply the coupon to more than the specified Buy items","is_hidden":true,"entity_type":"promotion","type":"percentage","created_on":"2022-05-30 07:33:01.303000","modified_on":"2022-05-31 10:41:01.441000"}]}}}}}}},"/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/cart_configuration/{cart_meta_id}":{"put":{"summary":"updateCartMetaConfig | Update cart meta configuration","description":"Update cart meta configuration","tags":["Cart"],"parameters":[{"schema":{"type":"string"},"description":"Current company id","in":"path","required":true,"name":"company_id"},{"schema":{"type":"string"},"description":"Current Application _id","in":"path","required":true,"name":"application_id"},{"name":"cart_meta_id","in":"path","schema":{"type":"string","description":"CartMeta mongo _id for fetching single cart meta data for editing"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CartMetaConfigUpdate"},"example":{"cart":{"max_cart_items":50,"min_cart_value":0,"delivery_charges":{"enabled":false,"charges":[]},"revenue_engine_coupon":false,"gift_pricing":50,"gift_display_text":""}}}}},"responses":{"200":{"description":"Cart Meta Config Created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CartMetaConfigUpdate"},"example":{"_id":"645ba594d414eb0669e6ee14","app_id":"60792ded7826bd09330ed90d","company_id":884,"bulk_coupons":false,"delivery_charges":{"charges":[],"enabled":false},"empty_cart":false,"enabled":true,"max_cart_items":50,"min_cart_value":0,"revenue_engine_coupon":false,"gift_pricing":50,"gift_display_text":""}}}},"400":{"description":"Invalid cart meta data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationErrorResponse"},"examples":{"Promotion code exists":{"value":{"success":false,"message":"cart meta already code exist"}}}}}}}}},"/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/cart_configuration":{"get":{"summary":"fetchCartMetaConfig | Fetch cart meta configuration","description":"Fetch cart meta configuration","tags":["Cart"],"responses":{"200":{"description":"Cart Meta Config Fetched successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CartMetaConfigAdd"},"example":{"_id":"645ba594d414eb0669e6ee14","app_id":"60792ded7826bd09330ed90d","company_id":884,"bulk_coupons":false,"delivery_charges":{"charges":[],"enabled":false},"empty_cart":false,"enabled":true,"max_cart_items":50,"min_cart_value":0,"revenue_engine_coupon":false,"gift_pricing":50,"gift_display_text":""}}}},"400":{"description":"Invalid cart meta data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationErrorResponse"},"examples":{"Invalid cart meta data":{"value":{"success":false,"message":"Something went wrong. Try again later"}}}}}}},"parameters":[{"schema":{"type":"string"},"description":"Current company id","in":"path","required":true,"name":"company_id"},{"schema":{"type":"string"},"description":"Current Application _id","in":"path","required":true,"name":"application_id"}]},"post":{"summary":"createCartMetaConfig | Create new cart meta configuration","description":"Create new cart meta configuration","tags":["Cart"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CartMetaConfigAdd"},"example":{"cart":{"max_cart_items":50,"min_cart_value":0,"delivery_charges":{"enabled":false,"charges":[]},"revenue_engine_coupon":false,"gift_pricing":50,"gift_display_text":""}}}}},"responses":{"201":{"description":"Cart Meta Config Created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CartMetaConfigAdd"},"example":{"_id":"645ba594d414eb0669e6ee14","app_id":"60792ded7826bd09330ed90d","company_id":884,"bulk_coupons":false,"delivery_charges":{"charges":[],"enabled":false},"empty_cart":false,"enabled":true,"max_cart_items":50,"min_cart_value":0,"revenue_engine_coupon":false,"gift_pricing":50,"gift_display_text":""}}}},"400":{"description":"Invalid cart meta data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationErrorResponse"},"examples":{"Promotion code exists":{"value":{"success":false,"message":"cart meta already code exist"}}}}}}},"parameters":[{"schema":{"type":"string"},"description":"Current company id","in":"path","required":true,"name":"company_id"},{"schema":{"type":"string"},"description":"Current Application _id","in":"path","required":true,"name":"application_id"}]}},"/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/dummy-cart":{},"/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/price-adjustment/{id}":{"put":{"summary":"updatePriceAdjustment | Update price adjustment configuration","description":"Update price adjustment configuration","tags":["Cart"],"parameters":[{"schema":{"type":"string"},"description":"Current company id","in":"path","required":true,"name":"company_id"},{"schema":{"type":"string"},"description":"Current Application _id","in":"path","required":true,"name":"application_id"},{"name":"id","in":"path","schema":{"type":"string","description":"price adjustment id for fetching single price adjustment data for editing"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PriceAdjustmentUpdate"},"example":{"cart_id":"fa45f5cbd3764a6297bfa79d6bedf71c","is_authenticated":true,"article_ids":[{"article_id":"f322167ce70f4dca8f8ac0efdc496abe","value":100,"code":"abs120","meta":{},"quantity":2}],"type":"discount","message":"Fynd Campaign 100 Rs off","value":100,"article_level_distribution":true,"allow_refund":true,"meta":{},"collection":{"collected_by":"FYND","refund_by":"FYND"},"restrictions":{"post_order":{"cancellation_allowed":false,"return_allowed":false}}}}}},"responses":{"200":{"description":"Price Adjustment Updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PriceAdjustmentResponse"},"example":{"success":true,"data":{"id":"cc8154592ccb42c88b481ce4c21ab602","cart_id":"fa45f5cbd3764a6297bfa79d6bedf71c","is_authenticated":true,"article_ids":[{"article_id":"f322167ce70f4dca8f8ac0efdc496abe","value":100,"code":"abs120","meta":{},"quantity":2}],"type":"discount","message":"Fynd Campaign 100 Rs off","value":100,"article_level_distribution":true,"allow_refund":true,"meta":{},"collection":{"collected_by":"FYND","refund_by":"FYND"},"restrictions":{"post_order":{"cancellation_allowed":false,"return_allowed":false}}}}}}},"400":{"description":"Invalid price adjustment update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationErrorResponse"},"examples":{"Price adjustment code doesn't exist":{"value":{"success":false,"message":"Price adjustment code doesn't exist"}}}}}}}},"delete":{"summary":"removePriceAdjustment | Remove price adjustment","description":"Remove price adjustment","tags":["Cart"],"parameters":[{"schema":{"type":"string"},"description":"Current company id","in":"path","required":true,"name":"company_id"},{"schema":{"type":"string"},"description":"Current Application _id","in":"path","required":true,"name":"application_id"},{"name":"id","in":"path","schema":{"type":"string","description":"Price Adjustment  id for fetching single price adjustment data for editing"},"required":true}],"responses":{"200":{"description":"Price Adjustment data Removed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessMessage"},"example":{"success":true,"message":"Price Adjustment removed successfully"}}}},"400":{"description":"Invalid Price Adjustment data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationErrorResponse"},"examples":{"Invalid Price Adjustment code exists":{"value":{"success":false,"message":"Either Price Adjustment code doesn't exist or Price Adjustment code has been removed"}}}}}}}}},"/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/price-adjustment":{"post":{"summary":"addPriceAdjustment | Create new price adjustment","description":"Create new price adjustment","tags":["Cart"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PriceAdjustmentAdd"},"example":{"cart_id":"fa45f5cbd3764a6297bfa79d6bedf71c","is_authenticated":true,"article_ids":[{"article_id":"f322167ce70f4dca8f8ac0efdc496abe","value":100,"code":"abs120","meta":{},"quantity":2}],"type":"discount","message":"Fynd Campaign 100 Rs off","value":100,"article_level_distribution":true,"allow_refund":true,"meta":{},"collection":{"collected_by":"FYND","refund_by":"FYND"},"restrictions":{"post_order":{"cancellation_allowed":false,"return_allowed":false}}}}}},"responses":{"201":{"description":"Price Adjustment Created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PriceAdjustmentResponse"},"example":{"success":true,"data":{"id":"cc8154592ccb42c88b481ce4c21ab602","cart_id":"fa45f5cbd3764a6297bfa79d6bedf71c","is_authenticated":true,"article_ids":[{"article_id":"f322167ce70f4dca8f8ac0efdc496abe","value":100,"code":"abs120","meta":{},"quantity":2}],"type":"discount","message":"Fynd Campaign 100 Rs off","value":100,"article_level_distribution":true,"allow_refund":true,"meta":{},"collection":{"collected_by":"FYND","refund_by":"FYND"},"restrictions":{"post_order":{"cancellation_allowed":false,"return_allowed":false}}}}}}},"400":{"description":"Invalid price adjustment","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationErrorResponse"},"examples":{"Price adjustment code exists":{"value":{"success":false,"message":"Unable to create price adjustment code"}}}}}}},"parameters":[{"schema":{"type":"string"},"description":"Current company id","in":"path","required":true,"name":"company_id"},{"schema":{"type":"string"},"description":"Current Application _id","in":"path","required":true,"name":"application_id"}]}},"/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/cart/validate":{"post":{"summary":"fetchAndvalidateCartItems | Fetch Cart Details","description":"Get all the details of cart for a list of provided `cart_items`","tags":["Cart"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenapiCartDetailsRequest"},"example":{"cart_items":[{"product_id":"803140","size":"S"},{"product_id":"803140","size":"S"}]}}}},"responses":{"200":{"description":"Cart details with breakup","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenapiCartDetailsResponse"},"example":{"items":[{"quantity":1,"identifiers":{"user_id":[],"brand_id":[9]},"message":"","coupon_message":"","product":{"type":"product","uid":803140,"name":"Green Solid T-Shirt","slug":"celio-green-solid-t-shirt-803140-dd9e2c","brand":{"uid":44,"name":"celio"},"categories":[{"uid":192,"name":"T-Shirts"}],"images":[{"aspect_ratio":"16:25","url":"http://cdn4.gofynd.com/media/pictures/tagged_items/original/44_NEMIEL@GREENBRITISH/1_1548161273344.jpg","secure_url":"https://d2zv4gzhlr4ud6.cloudfront.net/media/pictures/tagged_items/original/44_NEMIEL@GREENBRITISH/1_1548161273344.jpg"}],"action":{"type":"product","url":"https://api.addsale.com/platform/content/v1/products/celio-green-solid-t-shirt-803140-dd9e2c/","query":{"product_slug":["celio-green-solid-t-shirt-803140-dd9e2c"]}}},"article":{"type":"article","uid":"25_44_A7050_NEMIEL@GREENBRITISH_S","size":"S","seller":{"uid":25,"name":"CELIO FUTURE FASHION PRIVATE LIMITED"},"store":{"uid":1486,"name":"Forum Mall"},"quantity":1,"price":{"base":{"marked":1299,"effective":649.5,"currency_code":"INR"},"converted":{"marked":1299,"effective":649.5,"currency_code":"INR"}}},"key":"803140_S","discount":"50% OFF","price":{"base":{"add_on":0,"marked":1299,"effective":649.5,"selling":649.5,"currency_code":"INR"},"converted":{"add_on":0,"marked":1299,"effective":649.5,"selling":649.5,"currency_code":"INR"}},"availability":{"sizes":["L","XL","M","S"],"other_store_quantity":0,"out_of_stock":false,"deliverable":true,"is_valid":true,"available_sizes":[{"is_available":true,"display":"L","value":"L"},{"is_available":true,"display":"XXL","value":"XXL"},{"is_available":true,"display":"XL","value":"XL"},{"is_available":true,"display":"M","value":"M"},{"is_available":true,"display":"S","value":"S"},{"is_available":false,"display":"30","value":"30"}]},"bulk_offer":{}},{"quantity":1,"identifiers":{"user_id":[],"brand_id":[9]},"message":"Out of stock. Please remove item","coupon_message":"","product":{"type":"product","uid":803140,"name":"Green Solid T-Shirt","slug":"celio-green-solid-t-shirt-803140-dd9e2c","brand":{"uid":44,"name":"celio"},"categories":[{"uid":192,"name":"T-Shirts"}],"images":[{"aspect_ratio":"16:25","url":"http://cdn4.gofynd.com/media/pictures/tagged_items/original/44_NEMIEL@GREENBRITISH/1_1548161273344.jpg","secure_url":"https://d2zv4gzhlr4ud6.cloudfront.net/media/pictures/tagged_items/original/44_NEMIEL@GREENBRITISH/1_1548161273344.jpg"}],"action":{"type":"product","url":"https://api.addsale.com/platform/content/v1/products/celio-green-solid-t-shirt-803140-dd9e2c/","query":{"product_slug":["celio-green-solid-t-shirt-803140-dd9e2c"]}}},"article":{},"key":"803140_S","discount":"","price":{"base":{"add_on":0,"marked":1299,"effective":1299,"selling":1299,"currency_code":"INR"},"converted":{"add_on":0,"marked":1299,"effective":1299,"selling":1299,"currency_code":"INR"}},"availability":{"sizes":["L","XXL","XL","M","S"],"other_store_quantity":0,"out_of_stock":true,"deliverable":false,"is_valid":false,"available_sizes":[{"is_available":true,"display":"L","value":"L"},{"is_available":true,"display":"XXL","value":"XXL"},{"is_available":true,"display":"XL","value":"XL"},{"is_available":true,"display":"M","value":"M"},{"is_available":true,"display":"S","value":"S"},{"is_available":false,"display":"30","value":"30"}]},"bulk_offer":{}}],"is_valid":false,"breakup_values":{"display":[{"display":"MRP Total","key":"mrp_total","value":2598,"currency_code":"INR"},{"display":"Discount","key":"discount","value":-649,"currency_code":"INR"},{"display":"Subtotal","key":"subtotal","value":1949,"currency_code":"INR"},{"display":"Total","key":"total","value":1949,"currency_code":"INR"}],"raw":{"cod_charge":0,"convenience_fee":0,"coupon":0,"delivery_charge":0,"discount":-649.5,"fynd_cash":0,"gst_charges":170.11,"mrp_total":2598,"subtotal":1948.5,"total":1948.5,"vog":1778.39,"you_saved":0}}}}}},"400":{"description":"Invalid Cart Items","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenApiErrorResponse"},"examples":{"Item not found on system":{"value":{"message":"Item id does not exists","error":{"invalid_item_id":["1234","2345"]}}}}}}}},"parameters":[{"schema":{"type":"string"},"description":"Current company id","in":"path","required":true,"name":"company_id"},{"schema":{"type":"string"},"description":"Current Application _id","in":"path","required":true,"name":"application_id"}]}},"/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/cart/serviceability":{"post":{"summary":"checkCartServiceability | Check Pincode Serviceability","description":"Check Pincode serviceability for cart items provided in `cart_items` and address pincode in `shipping_address`","tags":["Cart"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenApiCartServiceabilityRequest"},"example":{"shipping_address":{"name":"Test User","address":"Test adddress","area":"test","phone":999999999,"area_code":"400093","area_code_slug":"pincode","city":"Mumbai","state":"Maharastra","country":"India","email":"test@gofynd.com","address_type":"office"},"cart_items":[{"product_id":"803140","size":"S"},{"product_id":"803140","size":"S"}]}}}},"responses":{"200":{"description":"Cart details with pincode validity information at item level","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenApiCartServiceabilityResponse"},"examples":{"Valid pincode":{"value":{"items":[{"quantity":1,"identifiers":{"identifier":"5mPyy88URXuh3Lo35uaTg"},"message":"","coupon_message":"","product":{"type":"product","uid":803140,"name":"Green Solid T-Shirt","slug":"celio-green-solid-t-shirt-803140-dd9e2c","brand":{"uid":44,"name":"celio"},"categories":[{"uid":192,"name":"T-Shirts"}],"images":[{"aspect_ratio":"16:25","url":"http://cdn4.gofynd.com/media/pictures/tagged_items/original/44_NEMIEL@GREENBRITISH/1_1548161273344.jpg","secure_url":"https://d2zv4gzhlr4ud6.cloudfront.net/media/pictures/tagged_items/original/44_NEMIEL@GREENBRITISH/1_1548161273344.jpg"}],"action":{"type":"product","url":"https://api.addsale.com/platform/content/v1/products/celio-green-solid-t-shirt-803140-dd9e2c/","query":{"product_slug":["celio-green-solid-t-shirt-803140-dd9e2c"]}}},"article":{"type":"article","uid":"25_44_A7050_NEMIEL@GREENBRITISH_S","size":"S","seller":{"uid":25,"name":"CELIO FUTURE FASHION PRIVATE LIMITED"},"store":{"uid":1486,"name":"Forum Mall"},"quantity":1,"price":{"base":{"marked":1299,"effective":649.5,"currency_code":"INR"},"converted":{"marked":1299,"effective":649.5,"currency_code":"INR"}}},"key":"803140_S","discount":"50% OFF","price":{"base":{"add_on":0,"marked":1299,"effective":649.5,"selling":649.5,"currency_code":"INR"},"converted":{"add_on":0,"marked":1299,"effective":649.5,"selling":649.5,"currency_code":"INR"}},"availability":{"sizes":["L","XL","M","S"],"other_store_quantity":0,"out_of_stock":false,"deliverable":true,"is_valid":true,"delivery_promise":{"timestamp":{"min":1605306343,"max":1605468343},"formatted":{"min":"Sat, 14 Nov","max":"Mon, 16 Nov"}},"available_sizes":[{"is_available":true,"display":"L","value":"L"},{"is_available":true,"display":"XXL","value":"XXL"},{"is_available":true,"display":"XL","value":"XL"},{"is_available":true,"display":"M","value":"M"},{"is_available":true,"display":"S","value":"S"},{"is_available":false,"display":"30","value":"30"}]},"bulk_offer":{}},{"quantity":1,"identifiers":{"identifier":"5mPyy88URXuh3Lo35uaTg"},"message":"Out of stock. Please remove item","coupon_message":"","product":{"type":"product","uid":803140,"name":"Green Solid T-Shirt","slug":"celio-green-solid-t-shirt-803140-dd9e2c","brand":{"uid":44,"name":"celio"},"categories":[{"uid":192,"name":"T-Shirts"}],"images":[{"aspect_ratio":"16:25","url":"http://cdn4.gofynd.com/media/pictures/tagged_items/original/44_NEMIEL@GREENBRITISH/1_1548161273344.jpg","secure_url":"https://d2zv4gzhlr4ud6.cloudfront.net/media/pictures/tagged_items/original/44_NEMIEL@GREENBRITISH/1_1548161273344.jpg"}],"action":{"type":"product","url":"https://api.addsale.com/platform/content/v1/products/celio-green-solid-t-shirt-803140-dd9e2c/","query":{"product_slug":["celio-green-solid-t-shirt-803140-dd9e2c"]}}},"article":{},"key":"803140_S","discount":"","price":{"base":{"add_on":0,"marked":1299,"effective":1299,"selling":1299,"currency_code":"INR"},"converted":{"add_on":0,"marked":1299,"effective":1299,"selling":1299,"currency_code":"INR"}},"availability":{"sizes":["L","XXL","XL","M","S"],"other_store_quantity":0,"out_of_stock":true,"deliverable":false,"is_valid":false,"delivery_promise":{"timestamp":{"min":1605306343,"max":1605468343},"formatted":{"min":"Sat, 14 Nov","max":"Mon, 16 Nov"}},"available_sizes":[{"is_available":true,"display":"L","value":"L"},{"is_available":true,"display":"XXL","value":"XXL"},{"is_available":true,"display":"XL","value":"XL"},{"is_available":true,"display":"M","value":"M"},{"is_available":true,"display":"S","value":"S"},{"is_available":false,"display":"30","value":"30"}]},"bulk_offer":{}}],"delivery_promise":{"timestamp":{"min":1605306343,"max":1605468343},"formatted":{"min":"Sat, 14 Nov","max":"Mon, 16 Nov"}},"is_valid":true}},"Invalid pincode":{"value":{"message":"All of the items in your cart are not deliverable to 800108","is_valid":false,"items":[{"discount":"15% OFF","identifiers":{"identifier":"5mPyy88URXuh3Lo35uaTg"},"price":{"base":{"add_on":0,"marked":2195,"effective":1866,"selling":1866,"currency_code":"INR"},"converted":{"add_on":0,"marked":2195,"effective":1866,"selling":1866,"currency_code":"INR"}},"product":{"type":"product","uid":876245,"name":"Brown Sandals","slug":"red-chief-brown-sandals-876245-c92507","brand":{"uid":433,"name":""},"categories":[{"uid":176,"name":""}],"images":[{"aspect_ratio":"16:25","url":"http://cdn4.gofynd.com/media/pictures/tagged_items/original/433_RC330004/1_1564147181287.jpg","secure_url":"https://d2zv4gzhlr4ud6.cloudfront.net/media/pictures/tagged_items/original/433_RC330004/1_1564147181287.jpg"}],"action":{"type":"product","url":"https://api.addsale.com/platform/content/v1/products/red-chief-brown-sandals-876245-c92507/","query":{"product_slug":["red-chief-brown-sandals-876245-c92507"]}},"item_code":"RC330004"},"bulk_offer":{},"key":"876245_6","message":"We are not delivering to 800108","delivery_promise":{"timestamp":{"min":1646257339,"max":1646689339,"formatted":{"min":"03 Mar, Thursday","max":"08 Mar, Tuesday"}}},"coupon_message":"","availability":{"sizes":["7","6","10","8"],"other_store_quantity":21,"out_of_stock":false,"deliverable":false,"is_valid":true,"available_sizes":[{"is_available":false,"display":"9","value":"9"},{"is_available":true,"display":"10","value":"10"},{"is_available":true,"display":"6","value":"6"},{"is_available":true,"display":"7","value":"7"},{"is_available":true,"display":"8","value":"8"}]},"quantity":1,"article":{"type":"article","uid":"304_433_LGPL30402_RC330004_6","size":"6","seller":{"uid":304,"name":"LEAYAN GLOBAL PVT. LTD."},"store":{"uid":9767,"name":"Udyog Kunj, Kanpur"},"quantity":3,"price":{"base":{"marked":2195,"effective":1866,"currency_code":"INR"},"converted":{"marked":2195,"effective":1866,"currency_code":"INR"}}}},{"discount":"15% OFF","identifiers":{"identifier":"gIq0E94RSMueSdDRAk_Txg"},"price":{"base":{"add_on":0,"marked":2195,"effective":1866,"selling":1866,"currency_code":"INR"},"converted":{"add_on":0,"marked":2195,"effective":1866,"selling":1866,"currency_code":"INR"}},"product":{"type":"product","uid":876245,"name":"Brown Sandals","slug":"red-chief-brown-sandals-876245-c92507","brand":{"uid":433,"name":""},"categories":[{"uid":176,"name":""}],"images":[{"aspect_ratio":"16:25","url":"http://cdn4.gofynd.com/media/pictures/tagged_items/original/433_RC330004/1_1564147181287.jpg","secure_url":"https://d2zv4gzhlr4ud6.cloudfront.net/media/pictures/tagged_items/original/433_RC330004/1_1564147181287.jpg"}],"action":{"type":"product","url":"https://api.addsale.com/platform/content/v1/products/red-chief-brown-sandals-876245-c92507/","query":{"product_slug":["red-chief-brown-sandals-876245-c92507"]}},"item_code":"RC330004"},"bulk_offer":{},"key":"876245_6","message":"We are not delivering to 800108","coupon_message":"","availability":{"sizes":["7","6","10","8"],"other_store_quantity":21,"out_of_stock":false,"deliverable":false,"is_valid":true,"available_sizes":[{"is_available":false,"display":"9","value":"9"},{"is_available":true,"display":"10","value":"10"},{"is_available":true,"display":"6","value":"6"},{"is_available":true,"display":"7","value":"7"},{"is_available":true,"display":"8","value":"8"}]},"quantity":1,"article":{"type":"article","uid":"304_433_LGPL30402_RC330004_6","size":"6","seller":{"uid":304,"name":"LEAYAN GLOBAL PVT. LTD."},"store":{"uid":9767,"name":"Udyog Kunj, Kanpur"},"quantity":3,"price":{"base":{"marked":2195,"effective":1866,"currency_code":"INR"},"converted":{"marked":2195,"effective":1866,"currency_code":"INR"}}}}]}}}}}}},"parameters":[{"schema":{"type":"string"},"description":"Current company id","in":"path","required":true,"name":"company_id"},{"schema":{"type":"string"},"description":"Current Application _id","in":"path","required":true,"name":"application_id"}]}},"/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/cart/checkout":{"post":{"summary":"checkoutCart | Create Fynd order with cart details","description":"Generate Fynd order for cart details send with provided `cart_items`","tags":["Cart"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenApiPlatformCheckoutReq"},"example":{"billing_address":{"name":"Dummy Ann Chovey","address":"Test Lorem Ipsum","area":"Test Lorem Ipsum","phone":99999999,"area_code":"400050","area_code_slug":"pincode","email":"test@gofynd.com","address_type":"home","city":"Mumbai","state":"Maharastra","country":"India","country_code":"IND","country_iso_code":"IND","country_phone_code":"91","meta":{"data":"Lorem Ipsum"}},"shipping_address":{"name":"Dummy Ann Chovey","address":"Test Lorem Ipsum adddress","area":"Test Lorem Ipsum","phone":999999999,"area_code":"400050","area_code_slug":"pincode","email":"test@gofynd.com","address_type":"office","city":"Mumbai","state":"Maharastra","country":"India","country_code":"IND","country_iso_code":"IND","country_phone_code":"91","meta":{"data":"Lorem Ipsum"}},"cart_items":[{"product_id":1077515,"size":"OS","amount_paid":934,"cashback_applied":25,"cod_charges":50,"coupon_effective_discount":100,"delivery_charges":60,"discount":101,"price_effective":1099,"price_marked":1200,"loyalty_discount":50,"employee_discount":100,"files":[{"key":"prescription","values":["https://res.cloudinary.com/dwzm9bysq/image/upload/v1584955313/production/applications/app_000000000000000000000001/media/store/logo/lluozpswzotfrd2e4cz8.png"]}],"meta":{"group_id":"1234","primary_item":true},"extra_meta":{},"payment_methods":[{"mode":"PP","amount":123,"name":"prepaid","meta":{"order_id":"order_pg_id","payment_id":"","current_status":"started","payment_gateway":"Razorpay"}},{"mode":"COD","name":"cod","amount":123,"meta":{}},{"name":"gift_card","mode":"GFTCRD","amount":123,"meta":{"key":"value"}}]},{"product_id":876245,"size":"6","amount_paid":699,"cashback_applied":0,"cod_charges":0,"coupon_effective_discount":0,"delivery_charges":0,"discount":0,"price_effective":699,"price_marked":699,"loyalty_discount":0,"employee_discount":0,"files":[{"key":"prescription","values":["https://res.cloudinary.com/dwzm9bysq/image/upload/v1584955313/production/applications/app_000000000000000000000001/media/store/logo/lluozpswzotfrd2e4cz8.png"]}],"meta":{"group_id":"12345"},"extra_meta":{},"payment_methods":[{"mode":"PP","amount":123,"name":"prepaid","meta":{"order_id":"order_pg_id","payment_id":"","current_status":"started","payment_gateway":"Razorpay"}},{"mode":"COD","name":"cod","amount":123,"meta":{}},{"name":"gift_card","mode":"GFTCRD","amount":123,"meta":{"key":"value"}}]}],"cart_value":1633,"cashback_applied":25,"cod_charges":50,"coupon_code":"loremipsum001","coupon_value":100,"delivery_charges":60,"gstin":"","comment":"","payment_methods":[{"mode":"PP","amount":123,"name":"prepaid","meta":{"order_id":"order_pg_id","payment_id":"","current_status":"started","payment_gateway":"Razorpay"}},{"mode":"COD","name":"cod","amount":123,"meta":{}},{"name":"gift_card","mode":"GFTCRD","amount":123,"meta":{"key":"value"}}],"platform_order_id":"2006070000001","extra_meta":{}}}}},"responses":{"200":{"description":"Checkout cart and create Fynd order id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenApiCheckoutResponse"},"example":{"success":true,"order_id":"FY5E182A9D0A5E405446","message":"Order initiation completed","order_ref_id":"5d64e3500bcad8693a821c0d"}}}},"400":{"description":"Invalid Cart Items or Invalid Calculation. Invalid cart calculation will trigger if difference of values is greater than ₹1.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenApiErrorResponse"},"examples":{"Invalid calculation":{"value":{"success":false,"message":"Values at cart and items are mismatched","errors":{"cashback_applied":"cashback_applied mismatched by 10.0 in cart","cod_charges":"cod_charges mismatched by 20.0 in cart","coupon_effective_discount":"coupon_effective_discount mismatched by 20.0 in cart","delivery_charges":"delivery_charges mismatched by 20.0 in cart","amount_paid":"amount_paid mismatched by 12582.0 in cart"}}}}}}}},"parameters":[{"schema":{"type":"string"},"description":"Current company id","in":"path","required":true,"name":"company_id"},{"schema":{"type":"string"},"description":"Current Application _id","in":"path","required":true,"name":"application_id"}]}},"/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/abandoned/carts":{"get":{"summary":"getAbandonedCart | Get with abandoned cart list","description":"Get abandoned cart list with pagination","tags":["Cart"],"parameters":[{"schema":{"type":"string"},"description":"Current company id","in":"path","required":true,"name":"company_id"},{"schema":{"type":"string"},"description":"Current Application _id","in":"path","required":true,"name":"application_id"},{"name":"page_no","in":"query","schema":{"type":"integer","default":0,"description":"current page no as per pagination"}},{"name":"page_size","in":"query","schema":{"type":"integer","default":10,"description":"Coupon max records fetched in single request"}},{"name":"from_date","in":"query","schema":{"type":"string","description":"Cart which are created on or after from_date"}},{"name":"to_date","in":"query","schema":{"type":"string","description":"Cart which are created on or before to_date"}},{"name":"anonymous_cart","in":"query","schema":{"type":"boolean","description":"Filter by `anonymous_cart`"}},{"name":"last_id","in":"query","schema":{"type":"string","description":"pagination is done based on the last_object_id"}},{"name":"sort_on","in":"query","schema":{"type":"string","description":"on which column to sort on i.e created_on or last_modified"}}],"responses":{"200":{"description":"Abandoned Cart List for sent page_size and page_no","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AbandonedCartResponse"},"examples":{"Abandoned Cart list for sent filter and page size":{"value":{"message":"Cart fetched successfully !!","success":true,"result":{},"items":[{"_id":"62bbe2c4b79692d559ac1f16","uid":19986,"user_id":"600693a01faf8695d70a15df","is_default":true,"app_id":"5d64e3500bcad8693a821c0d","articles":[{"service_item_meta":{"product_group_tags":null,"products":null},"parent_item_identifiers":{"identifier":null,"parent_item_size":null,"parent_item_id":null},"item_id":7500426,"item_size":"SET1","article_id":"5f37d9b71cb7c10001b90ee2","quantity":2,"price_marked":1000,"price_effective":1,"currency_code":"INR","store_id":10183,"company_id":61,"article_assignment":{"level":"multi-companies","strategy":"optimal"},"brand_uid":85,"l3_categories":[466],"discount":99.9,"coupon":{"amount":0,"currency_code":"INR","article_count":0},"referral_credits":{"amount":0,"currency_code":"FC"},"cashback":{"amount":0,"currency_code":"FC"},"bulk_coupon":{"margin":0,"discount":0,"code":null},"promotion":[{"promo_id":"62bbf355beda57df173122fa","amount":1,"article_quantity":2,"mrp_promotion":false,"promotion_type":"amount","discount_rules":[{"type":"amount","value":125}]}],"identifiers":{"identifier":"pEF2t4GGTKaieox5rsRibw"},"meta":{},"extra_meta":{},"payment_methods":[]}],"cart_value":1,"discount":0,"delivery_charges":{"amount":1,"currency_code":"INR"},"coupon":{"amount":0,"currency_code":"INR","code":null,"type":"cart","uid":"","id":null},"promotion":{"amount":2,"currency_code":"INR","mode":"promotion","promotions":[{"id":"62bbf355beda57df173122fa","mrp_promo":false,"promo_group":"product"}]},"fynd_credits":{"amount":0,"currency_code":"FC","auto_applied":true},"cod_charges":{"amount":0,"currency_code":"INR"},"cashback":{"amount":0,"currency_code":"FC","uid":""},"payments":{},"is_archive":false,"created_on":"2022-06-28 14:25:15.578000","last_modified":"2022-06-29 13:52:03.313000","expire_at":"2023-06-24 13:52:03.313000","fc_index_map":[0,0],"checkout_mode":"self","meta":{"shipping_address_id":"62b161cb3ad0eed3e48ec6a9","billing_address_id":"62b161cb3ad0eed3e48ec6a9"},"comment":"","bulk_coupon_discount":0,"pick_up_customer_details":{},"is_active":true,"shipments":[],"payment_methods":[],"buy_now":false}],"page":{"type":"number","has_next":false,"item_total":28,"size":20,"page":2,"current":2,"last_id":"62d4ff76d6aec8db897de407"}}}}}}}}}},"/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/abandoned/cart/detail":{"get":{"summary":"getAbandonedCartDetails | Fetch all items added to the cart","description":"Use this API to get details of all the items added to a cart.","tags":["Cart"],"parameters":[{"schema":{"type":"string"},"description":"Current company id","in":"path","required":true,"name":"company_id"},{"schema":{"type":"string"},"description":"Current Application _id","in":"path","required":true,"name":"application_id"},{"in":"query","name":"id","schema":{"type":"string","description":"The unique identifier of the cart"}},{"in":"query","name":"i","schema":{"type":"boolean","description":"This is a boolean value. Select `true` to retrieve all the items added in the cart."}},{"in":"query","name":"b","schema":{"type":"boolean","description":"This is a boolean value. Select `true` to retrieve the price breakup of cart items."}},{"in":"query","name":"c","schema":{"type":"boolean","description":"This is a boolean value. Select `true` to retrieve the cod charges in breakup of cart items."}}],"responses":{"200":{"description":"Success. Returns a Cart object. Check the example shown below or refer `CartDetailResponse` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CartDetailResponse"},"example":{"items":[{"bulk_offer":{},"discount":"67% OFF","identifiers":{"identifier":"5mPyy88URXuh3Lo35uaTg"},"article":{"type":"article","uid":"604_902_SSTC60401_636BLUE_1","size":"1","seller":{"uid":604,"name":"SHRI SHANTINATH TRADING COMPANY"},"store":{"uid":4579,"name":"Gandhi Nagar"},"quantity":108,"price":{"base":{"marked":2999,"effective":999,"currency_code":"INR"},"converted":{"marked":2999,"effective":999,"currency_code":"INR"}}},"coupon_message":"","key":"707569_1","availability":{"sizes":["1","8","7","2","9","5","3","6"],"other_store_quantity":107,"out_of_stock":false,"deliverable":true,"is_valid":true},"product":{"type":"product","uid":707569,"name":"Blue and Gold Printed Ethnic Set","slug":"aj-dezines-blue-and-gold-printed-ethnic-set-707569-bff01a","brand":{"uid":902,"name":""},"categories":[{"uid":525,"name":""}],"images":[{"aspect_ratio":"16:25","url":"http://cdn4.gofynd.com/media/pictures/tagged_items/original/902_636BLUE/1_1540301094877.jpg","secure_url":"https://d2zv4gzhlr4ud6.cloudfront.net/media/pictures/tagged_items/original/902_636BLUE/1_1540301094877.jpg"}],"action":{"type":"product","url":"https://api.addsale.com/v1/products/aj-dezines-blue-and-gold-printed-ethnic-set-707569-bff01a/","query":{"product_slug":["aj-dezines-blue-and-gold-printed-ethnic-set-707569-bff01a"]}}},"price":{"base":{"add_on":999,"marked":2999,"effective":999,"selling":999,"currency_code":"INR"},"converted":{"add_on":999,"marked":2999,"effective":999,"selling":999,"currency_code":"INR"}},"message":"","quantity":1}],"buy_now":false,"cart_id":54,"uid":"54","breakup_values":{"raw":{"cod_charge":0,"convenience_fee":0,"coupon":0,"delivery_charge":0,"discount":-2000,"fynd_cash":0,"gst_charges":47.57,"mrp_total":2999,"subtotal":999,"total":999,"vog":951.43,"you_saved":0},"coupon":{"type":"cash","code":"","uid":"21755","value":0,"is_applied":false,"message":"Sorry! Invalid Coupon"},"display":[{"display":"MRP Total","key":"mrp_total","value":2999,"currency_code":"INR"},{"display":"Discount","key":"discount","value":-2000,"currency_code":"INR"},{"display":"Subtotal","key":"subtotal","value":999,"currency_code":"INR"},{"display":"Total","key":"total","value":999,"currency_code":"INR"}],"loyalty_points":{"total":0,"applicable":0,"is_applied":false,"description":"Your cashback, referrals, and refund amount get credited to Fynd Cash which can be redeemed while placing an order."}},"delivery_charge_info":"","coupon_text":"View all offers","gstin":"","checkout_mode":"self","restrict_checkout":false,"is_valid":true,"last_modified":"2022-06-28"}}}}}}},"/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/abandoned/carts/{cart_id}":{"post":{"summary":"addItems | Add items to abandoned cart","description":"Use this API to add items to the abandoned cart.","tags":["Cart"],"parameters":[{"schema":{"type":"string"},"description":"Current company id","in":"path","required":true,"name":"company_id"},{"schema":{"type":"string"},"description":"Current Application _id","in":"path","required":true,"name":"application_id"},{"schema":{"type":"string"},"description":"Current Cart _id","in":"path","required":true,"name":"cart_id"},{"in":"query","name":"b","schema":{"type":"boolean","description":"This is a boolean value. Select `true` to retrieve the price breakup of cart items."}}],"requestBody":{"description":"Specify the item details as shown below. Refer `AddCartRequest` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddCartRequest"},"example":{"items":[{"item_id":778937,"item_size":"OS","quantity":1,"article_assignment":{"level":"multi-companies","strategy":"optimal"},"seller_id":686,"store_id":5059,"extra_meta":{},"_custom_json":{}}]}}}},"responses":{"200":{"description":"Success. Returns a cart object as shown below. Refer `AddCartDetailResponse` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddCartDetailResponse"},"examples":{"Product has been added to your cart":{"value":{"message":"Product has been added to your cart","success":true,"cart":{"breakup_values":{"display":[{"display":"MRP Total","key":"mrp_total","value":17486,"currency_code":"INR"},{"display":"Discount","key":"discount","value":-3540,"currency_code":"INR"},{"display":"Subtotal","key":"subtotal","value":13946,"currency_code":"INR"},{"display":"Total","key":"total","value":13946,"currency_code":"INR"}],"raw":{"cod_charge":0,"convenience_fee":0,"coupon":0,"delivery_charge":0,"discount":-3540,"fynd_cash":0,"gst_charges":1529.96,"mrp_total":17486,"subtotal":13946,"total":13946,"vog":12416.04,"you_saved":0},"loyalty_points":{"total":0,"applicable":0,"is_applied":false,"description":"Your cashback, referrals, and refund amount get credited to Fynd Cash which can be redeemed while placing an order."},"coupon":{"type":"cash","code":"","uid":"25_44_A7050_NEMIEL@GREENBRITISH_S","value":0,"is_applied":false,"message":"Sorry! Invalid Coupon"}},"items":[{"key":"751083_10","identifiers":{"identifier":"5mPyy88URXuh3Lo35uaTg"},"parent_item_identifiers":{"identifier":"ZASFF","parent_item_id":7501190,"parent_item_size":"OS"},"article":{"type":"article","uid":"612_9_SE61201_19100302_10","size":"10","seller":{"uid":612,"name":"SSR ENTERPRISE"},"store":{"uid":4431,"name":"Motilal Nagar 1, Goregaon"},"quantity":4,"price":{"base":{"marked":3999,"effective":2399,"currency_code":"INR"},"converted":{"marked":3999,"effective":2399,"currency_code":"INR"}}},"price":{"base":{"add_on":4798,"marked":7998,"effective":4798,"selling":4798,"currency_code":"INR"},"converted":{"add_on":4798,"marked":7998,"effective":4798,"selling":4798,"currency_code":"INR"}},"availability":{"sizes":["10"],"other_store_quantity":2,"out_of_stock":false,"deliverable":true,"is_valid":true},"product":{"type":"product","uid":751083,"name":"Carson 2","slug":"puma-carson-2-751083-6ad98d","brand":{"uid":9,"name":"Puma"},"categories":[{"uid":165,"name":"Outdoor Sports Shoes"}],"images":[{"aspect_ratio":"16:25","url":"http://cdn4.gofynd.com/media/pictures/tagged_items/original/9_19100302/1_1542807042296.jpg","secure_url":"https://d2zv4gzhlr4ud6.cloudfront.net/media/pictures/tagged_items/original/9_19100302/1_1542807042296.jpg"}],"action":{"type":"product","url":"https://api.addsale.com/platform/content/v1/products/puma-carson-2-751083-6ad98d/","query":{"product_slug":["puma-carson-2-751083-6ad98d"]}}},"coupon_message":"","quantity":2,"message":"","bulk_offer":{},"discount":"41% OFF"},{"key":"246228_","identifiers":{"identifier":"5mPyy88URXuh3Lo35uaTg"},"article":{"type":"article","uid":"46_235_TM62_M11029ONDSXNS_S","size":"S","seller":{"uid":46,"name":"RELIANCE BRANDS LIMITED"},"store":{"uid":4550,"name":"VR Mall"},"quantity":1,"price":{"base":{"marked":4490,"effective":4490,"currency_code":"INR"},"converted":{"marked":4490,"effective":4490,"currency_code":"INR"}}},"price":{"base":{"add_on":4490,"marked":4490,"effective":4490,"selling":4490,"currency_code":"INR"},"converted":{"add_on":4490,"marked":4490,"effective":4490,"selling":4490,"currency_code":"INR"}},"availability":{"sizes":["L","M","S","XL","XXL"],"other_store_quantity":0,"out_of_stock":false,"deliverable":true,"is_valid":true},"product":{"type":"product","uid":246228,"name":"Blue Solid T-Shirt","slug":"superdry-blue-solid-t-shirt-2","brand":{"uid":235,"name":"Superdry"},"categories":[{"uid":192,"name":"T-Shirts"}],"images":[{"aspect_ratio":"16:25","url":"http://cdn4.gofynd.com/media/pictures/tagged_items/original/235_M11029ONDSXNS/1.jpg","secure_url":"https://d2zv4gzhlr4ud6.cloudfront.net/media/pictures/tagged_items/original/235_M11029ONDSXNS/1.jpg"}],"action":{"type":"product","url":"https://api.addsale.com/platform/content/v1/products/superdry-blue-solid-t-shirt-2/","query":{"product_slug":["superdry-blue-solid-t-shirt-2"]}}},"coupon_message":"","quantity":1,"message":"","bulk_offer":{},"discount":""},{"key":"443175_s","identifiers":{"identifier":"gIq0E94RSMueSdDRAk_Txg"},"article":{"type":"article","uid":"162_207_1271_LJ03LBLUDN88_S","size":"S","seller":{"uid":162,"name":"GO FASHION INDIA PRIVATE LIMITED"},"store":{"uid":5784,"name":"Vega City mall"},"quantity":3,"price":{"base":{"marked":1599,"effective":1599,"currency_code":"INR"},"converted":{"marked":1599,"effective":1599,"currency_code":"INR"}}},"price":{"base":{"add_on":1599,"marked":1599,"effective":1599,"selling":1599,"currency_code":"INR"},"converted":{"add_on":1599,"marked":1599,"effective":1599,"selling":1599,"currency_code":"INR"}},"availability":{"sizes":["XL","M","L","S"],"other_store_quantity":8,"out_of_stock":false,"deliverable":true,"is_valid":true},"product":{"type":"product","uid":443175,"name":"Light Blue Denim Jeggings","slug":"go-colors-light-blue-denim-jeggings-443175-3c688c","brand":{"uid":207,"name":"Go Colors"},"categories":[{"uid":267,"name":"Jeggings"}],"images":[{"aspect_ratio":"16:25","url":"http://cdn4.gofynd.com/media/pictures/tagged_items/original/207_LJ03LBLUDN88/1_1512382513548.jpg","secure_url":"https://d2zv4gzhlr4ud6.cloudfront.net/media/pictures/tagged_items/original/207_LJ03LBLUDN88/1_1512382513548.jpg"}],"action":{"type":"product","url":"https://api.addsale.com/platform/content/v1/products/go-colors-light-blue-denim-jeggings-443175-3c688c/","query":{"product_slug":["go-colors-light-blue-denim-jeggings-443175-3c688c"]}}},"coupon_message":"","quantity":1,"message":"","bulk_offer":{},"discount":""},{"key":"778937_OS","identifiers":{"identifier":"gIq0E94RSMueSdDRAk_Txg"},"article":{"type":"article","uid":"686_963_IC68601_PWUPC01977_OS","size":"OS","seller":{"uid":686,"name":"INDUS CORPORATION"},"store":{"uid":5059,"name":"Vidyaranyapura Main Road"},"quantity":3,"price":{"base":{"marked":3399,"effective":3059,"currency_code":"INR"},"converted":{"marked":3399,"effective":3059,"currency_code":"INR"}}},"price":{"base":{"add_on":3059,"marked":3399,"effective":3059,"selling":3059,"currency_code":"INR"},"converted":{"add_on":3059,"marked":3399,"effective":3059,"selling":3059,"currency_code":"INR"}},"availability":{"sizes":["OS"],"other_store_quantity":2,"out_of_stock":false,"deliverable":true,"is_valid":true},"product":{"type":"product","uid":778937,"name":"Colourful Carnival Bouncer","slug":"fisher-price-colourful-carnival-bouncer-778937-fafa1f","brand":{"uid":963,"name":"Fisher-Price"},"categories":[{"uid":576,"name":"Cradles"}],"images":[{"aspect_ratio":"16:25","url":"http://cdn4.gofynd.com/media/pictures/tagged_items/original/963_PWUPC01977/1_1545308400588.jpg","secure_url":"https://d2zv4gzhlr4ud6.cloudfront.net/media/pictures/tagged_items/original/963_PWUPC01977/1_1545308400588.jpg"}],"action":{"type":"product","url":"https://api.addsale.com/platform/content/v1/products/fisher-price-colourful-carnival-bouncer-778937-fafa1f/","query":{"product_slug":["fisher-price-colourful-carnival-bouncer-778937-fafa1f"]}}},"coupon_message":"","quantity":1,"message":"","bulk_offer":{},"discount":"11% OFF"}],"delivery_charge_info":"","coupon_text":"View all offers","buy_now":false,"cart_id":7927,"uid":"7927","gstin":"","checkout_mode":"self","last_modified":"2023-03-03","restrict_checkout":false,"is_valid":true},"result":{}}},"Sorry, item is out of stock":{"value":{"message":"Sorry, item is out of stock","success":false,"cart":{"breakup_values":{"raw":{"cod_charge":0,"convenience_fee":0,"coupon":0,"delivery_charge":0,"discount":-202000,"fynd_cash":0,"gst_charges":4804.71,"mrp_total":302899,"subtotal":100899,"total":100899,"vog":96094.29,"you_saved":0},"coupon":{"type":"cash","code":"","uid":"","value":0,"is_applied":false,"message":"Sorry! Invalid Coupon"},"display":[{"display":"MRP Total","key":"mrp_total","value":302899,"currency_code":"INR"},{"display":"Discount","key":"discount","value":-202000,"currency_code":"INR"},{"display":"Subtotal","key":"subtotal","value":100899,"currency_code":"INR"},{"display":"Total","key":"total","value":100899,"currency_code":"INR"}],"loyalty_points":{"total":0,"applicable":0,"is_applied":false,"description":"Your cashback, referrals, and refund amount get credited to Fynd Cash which can be redeemed while placing an order."}},"items":[{"bulk_offer":{},"identifiers":{"identifier":"gIq0E94RSMueSdDRAk_Txg"},"discount":"67% OFF","parent_item_identifiers":{"identifier":"ZASFF","parent_item_id":7501190,"parent_item_size":"OS"},"article":{"type":"article","uid":"604_902_SSTC60401_636BLUE_1","size":"1","seller":{"uid":604,"name":"SHRI SHANTINATH TRADING COMPANY"},"store":{"uid":4579,"name":"Gandhi Nagar"},"quantity":108,"price":{"base":{"marked":2999,"effective":999,"currency_code":"INR"},"converted":{"marked":2999,"effective":999,"currency_code":"INR"}}},"coupon_message":"","key":"707569_1","availability":{"sizes":["1","8","7","2","9","5","3","6"],"other_store_quantity":7,"out_of_stock":false,"deliverable":true,"is_valid":true},"product":{"type":"product","uid":707569,"name":"Blue and Gold Printed Ethnic Set","slug":"aj-dezines-blue-and-gold-printed-ethnic-set-707569-bff01a","brand":{"uid":902,"name":""},"categories":[{"uid":525,"name":""}],"images":[{"aspect_ratio":"16:25","url":"http://cdn4.gofynd.com/media/pictures/tagged_items/original/902_636BLUE/1_1540301094877.jpg","secure_url":"https://d2zv4gzhlr4ud6.cloudfront.net/media/pictures/tagged_items/original/902_636BLUE/1_1540301094877.jpg"}],"action":{"type":"product","url":"https://api.addsale.com/v1/products/aj-dezines-blue-and-gold-printed-ethnic-set-707569-bff01a/","query":{"product_slug":["aj-dezines-blue-and-gold-printed-ethnic-set-707569-bff01a"]}}},"price":{"base":{"add_on":100899,"marked":302899,"effective":100899,"selling":100899,"currency_code":"INR"},"converted":{"add_on":100899,"marked":302899,"effective":100899,"selling":100899,"currency_code":"INR"}},"message":"","quantity":101}],"delivery_charge_info":"","coupon_text":"View all offers","buy_now":false,"cart_id":54,"uid":"54","gstin":"","checkout_mode":"self","restrict_checkout":false,"is_valid":false,"last_modified":"2023-03-03"},"result":{}}}}}}}}},"put":{"summary":"updateCart | Update items in the abandoned cart","description":"Use this API to update items added to the cart with the help of a request object containing attributes like item_quantity and item_size. These attributes will be fetched from the following APIs operation Operation for current api call.update_item for update items. remove_item for removing items. item_id \"/platform/content/v1/products/\" \"/platform/content/v1/products/:slug/sizes/\" quantity item quantity (must be greater than or equal to 1) article_id \"/content​/v1​/products​/:identifier​/sizes​/price​/\"  item position in the cart (must be greater than or equal to 0)","tags":["Cart"],"parameters":[{"schema":{"type":"string"},"description":"Current company id","in":"path","required":true,"name":"company_id"},{"schema":{"type":"string"},"description":"Current Application _id","in":"path","required":true,"name":"application_id"},{"schema":{"type":"string"},"description":"Current Cart _id","in":"path","required":true,"name":"cart_id"},{"in":"query","name":"b","schema":{"type":"boolean","description":"This is a boolean value. Select `true` to retrieve the price breakup of cart items."}}],"requestBody":{"description":"Specify the item details and operation as shown below. Refer `UpdateCartRequest` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCartRequest"},"example":{"operation":"update_item","items":[{"item_id":778937,"identifiers":{"identifier":"gIq0E94RSMueSdDRAk_Txg"},"item_size":"OS","quantity":2,"article_id":"778937_OS","item_index":3,"extra_meta":{},"_custom_json":{}}]}}}},"responses":{"200":{"description":"Success. Updates and returns a cart object as shown below. Refer `UpdateCartDetailResponse` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCartDetailResponse"},"examples":{"Nothing updated":{"value":{"cart":{"breakup_values":{"raw":{"cod_charge":0,"convenience_fee":0,"coupon":0,"delivery_charge":0,"discount":-202000,"fynd_cash":0,"gst_charges":4804.71,"mrp_total":302899,"subtotal":100899,"total":100899,"vog":96094.29,"you_saved":0},"coupon":{"type":"cash","code":"","uid":"","value":0,"is_applied":false,"message":"Sorry! Invalid Coupon"},"display":[{"display":"MRP Total","key":"mrp_total","value":302899,"currency_code":"INR"},{"display":"Discount","key":"discount","value":-202000,"currency_code":"INR"},{"display":"Subtotal","key":"subtotal","value":100899,"currency_code":"INR"},{"display":"Total","key":"total","value":100899,"currency_code":"INR"}],"loyalty_points":{"total":0,"applicable":0,"is_applied":false,"description":"Your cashback, referrals, and refund amount get credited to Fynd Cash which can be redeemed while placing an order."}},"items":[{"bulk_offer":{},"identifiers":{"identifier":"gIq0E94RSMueSdDRAk_Txg"},"discount":"67% OFF","parent_item_identifiers":{"identifier":"ZASFF","parent_item_id":7501190,"parent_item_size":"OS"},"article":{"type":"article","uid":"604_902_SSTC60401_636BLUE_1","size":"1","seller":{"uid":604,"name":"SHRI SHANTINATH TRADING COMPANY"},"store":{"uid":4579,"name":"Gandhi Nagar"},"quantity":108,"price":{"base":{"marked":2999,"effective":999,"currency_code":"INR"},"converted":{"marked":2999,"effective":999,"currency_code":"INR"}}},"coupon_message":"","key":"707569_1","availability":{"sizes":["1","8","7","2","9","5","3","6"],"other_store_quantity":7,"out_of_stock":false,"deliverable":true,"is_valid":true},"product":{"type":"product","uid":707569,"name":"Blue and Gold Printed Ethnic Set","slug":"aj-dezines-blue-and-gold-printed-ethnic-set-707569-bff01a","brand":{"uid":902,"name":""},"categories":[{"uid":525,"name":""}],"images":[{"aspect_ratio":"16:25","url":"http://cdn4.gofynd.com/media/pictures/tagged_items/original/902_636BLUE/1_1540301094877.jpg","secure_url":"https://d2zv4gzhlr4ud6.cloudfront.net/media/pictures/tagged_items/original/902_636BLUE/1_1540301094877.jpg"}],"action":{"type":"product","url":"https://api.addsale.com/v1/products/aj-dezines-blue-and-gold-printed-ethnic-set-707569-bff01a/","query":{"product_slug":["aj-dezines-blue-and-gold-printed-ethnic-set-707569-bff01a"]}}},"price":{"base":{"add_on":100899,"marked":302899,"effective":100899,"selling":100899,"currency_code":"INR"},"converted":{"add_on":100899,"marked":302899,"effective":100899,"selling":100899,"currency_code":"INR"}},"message":"","quantity":101}],"delivery_charge_info":"","coupon_text":"View all offers","buy_now":false,"cart_id":54,"uid":"54","gstin":"","checkout_mode":"self","restrict_checkout":false,"is_valid":true,"last_modified":"2023-03-03"},"result":{"707569_90":{"success":true,"message":"Nothing updated"}},"message":"Nothing updated","success":true}},"Item updated in the cart":{"value":{"cart":{"breakup_values":{"raw":{"sub_total":8000,"subtotal":8000,"coupon":0,"promotion":-100,"delivery_charge":100,"you_saved":0,"fynd_cash":0,"cod_charge":0,"total":8000,"gst_charges":0,"vog":0,"convenience_fee":0,"mrp_total":20010,"discount":-12010},"coupon":{"type":"cash","code":"","uid":"","value":0,"is_applied":false,"message":"Sorry! Invalid coupon"},"loyalty_points":{"total":0,"applicable":0,"is_applied":false,"description":"Your cashback, reward points, and refund amount get credited to Fynd Cash which can be redeemed while placing an order.","message":"Reward point not applicable with Coupon"},"display":[{"display":"MRP Total","key":"mrp_total","original":20010,"attr":"mrp_total","value":20010,"currency_code":"INR","currency_symbol":"₹","message":[]},{"display":"Discount","key":"discount","original":-12010,"attr":"discount","value":-12010,"currency_code":"INR","currency_symbol":"₹","message":[]},{"display":"Subtotal","key":"subtotal","original":8000,"attr":"subtotal","value":8000,"currency_code":"INR","currency_symbol":"₹","message":[]},{"display":"Promotion","key":"promotion","original":-100,"attr":"promotion","value":-100,"currency_code":"INR","currency_symbol":"₹","message":[]},{"display":"Delivery Charge","key":"delivery_charge","original":100,"attr":"delivery_charge","value":100,"currency_code":"INR","currency_symbol":"₹","message":["Delivery charges applicable ₹100.00 on order upto ₹10,000.00","Free delivery on order above ₹10,000.00"]},{"display":"Total","key":"total","original":8000,"attr":"total","value":8000,"currency_code":"INR","currency_symbol":"₹","message":[]}]},"items":[{"parent_item_identifiers":{"identifier":null,"parent_item_size":null,"parent_item_id":null},"article":{"type":"article","uid":"618c1a6874b93908c98f6d18","size":"XL","product_group_tags":["tag1"],"seller":{"uid":61,"name":"FUCHSIA VINE DESIGNS PRIVATE LIMITED"},"store":{"uid":11491,"name":"Store46"},"quantity":200,"price":{"base":{"marked":2001,"effective":800,"selling":800,"currency_code":"INR","currency_symbol":"₹"},"converted":{"marked":2001,"effective":800,"selling":800,"currency_code":"INR","currency_symbol":"INR"}},"extra_meta":{}},"product":{"type":"product","uid":75252592,"name":"Nike Yellow Top","slug":"nike-black-top","brand":{"uid":18,"name":"Nike"},"categories":[{"uid":258,"name":"Blouson Top"}],"attributes":{"hsn_code":"62040000","short_description":"test description1","essential":"No","item_code":"1304678617","gender":"Women","currency":"INR","media":[{"url":"https://hdn-1.addsale.com/addsale/products/pictures/item/free/original/oy168nSHP-Nike-Black-Top.jpeg","type":"image"}],"marketer-address":"Tops Range","marketer-name":"Bandra(W), Link Road","brand_name":"Nike"},"images":[{"aspect_ratio":"16:25","url":"https://hdn-1.addsale.com/addsale/products/pictures/item/free/original/oy168nSHP-Nike-Black-Top.jpeg","secure_url":"https://hdn-1.addsale.com/addsale/products/pictures/item/free/original/oy168nSHP-Nike-Black-Top.jpeg"}],"action":{"type":"product","url":"https://api.fyndx0.de/platform/content/v1/products/nike-black-top/","query":{"product_slug":["nike-black-top"]}},"item_code":"1304678617","_custom_json":{}},"message":"","price_per_unit":{"base":{"marked":2001,"effective":800,"selling_price":800,"currency_code":"INR","currency_symbol":"₹"},"converted":{"marked":2001,"effective":800,"selling_price":800,"currency_code":"INR","currency_symbol":"₹"}},"promo_meta":{},"bulk_offer":{},"price":{"base":{"add_on":8000,"marked":20010,"effective":8000,"selling":8000,"currency_code":"INR","currency_symbol":"₹"},"converted":{"add_on":8000,"marked":20010,"effective":8000,"selling":8000,"currency_code":"INR","currency_symbol":"₹"}},"is_set":false,"identifiers":{"identifier":"SfOmcAtTR4ut4pI_eVU6FQ"},"discount":"60% OFF","moq":{},"availability":{"sizes":["S","XL","L"],"other_store_quantity":984,"out_of_stock":false,"deliverable":true,"is_valid":true,"available_sizes":[{"is_available":true,"display":"S","value":"S"},{"is_available":true,"display":"XL","value":"XL"},{"is_available":false,"display":"CLL","value":"CLL"},{"is_available":true,"display":"L","value":"L"},{"is_available":false,"display":"XLL","value":"XLL"},{"is_available":false,"display":"XLLL","value":"XLLL"}]},"quantity":10,"promotions_applied":[{"promo_id":"62da8b75e951ea5e67b1454b","amount":10,"article_quantity":10,"mrp_promotion":false,"promotion_type":"shipping_price","offer_text":"Free shipping 22/07/2"}],"key":"75252592_XL","delivery_promise":{},"coupon_message":""}],"cart_id":22251,"id":"62d4ff76d6aec8db897de407","uid":"22251","buy_now":false,"gstin":"","comment":"","checkout_mode":"self","restrict_checkout":false,"is_valid":true,"currency":{"code":"INR","symbol":"₹"},"last_modified":"2023-03-03"},"message":"Quantity of item updated","success":true}}}}}}}}},"/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/coupon_options":{"get":{"x-private":true,"summary":"getCouponOptionValues | Get coupon options enums with display values","description":"Get coupon enum values for fields in valid coupon object. Used for front end to create, update and filter coupon lists via fields","tags":["Cart"],"responses":{"200":{"description":"Coupon options enums","content":{"application/json":{"schema":{"type":"object","properties":{"types":{"type":"array","items":{"type":"string"}},"scopes":{"type":"array","items":{"type":"string"}},"applicable_on":{"type":"array","items":{"type":"string"}},"value_types":{"type":"array","items":{"type":"string"}},"calculate_on":{"type":"array","items":{"type":"string"}},"payable_category":{"type":"array","items":{"type":"string"}},"txn_mode":{"type":"array","items":{"type":"string"}},"payable_by":{"type":"array","items":{"type":"string"}}}},"example":{"types":["Absolute"],"scopes":["Categories"],"applicable_on":["Amount"],"value_types":["Absolute"],"calculate_on":["Mrp"],"payable_category":["Fynd"],"txn_mode":["Fynd Cash"],"payable_by":["Fynd Marketing"]}}}}},"parameters":[{"schema":{"type":"string"},"description":"Current company id","in":"path","required":true,"name":"company_id"},{"schema":{"type":"string"},"description":"Current Application _id","in":"path","required":true,"name":"application_id"}]}},"/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/coupon_code_exists":{"get":{"x-private":true,"summary":"getCouponCodeExists | Check if coupon is already created with coupon code","description":"Check if sent coupon code is already existing coupon code. As coupon code is to be unique.","tags":["Cart"],"parameters":[{"schema":{"type":"string"},"description":"Current company id","in":"path","required":true,"name":"company_id"},{"schema":{"type":"string"},"description":"Current Application _id","in":"path","required":true,"name":"application_id"},{"name":"code","in":"query","schema":{"type":"string","description":"Coupon code"}}],"responses":{"200":{"description":"Valid response with existing coupon code count","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"count":{"type":"integer"}}},"examples":{"Coupon code exists":{"value":{"success":true,"count":1}},"Coupon code is new":{"value":{"success":true,"count":0}}}}}},"400":{"description":"Missing required param","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}},"examples":{"Missing coupon code param in request body":{"value":{"success":true,"message":"code is required query param"}}}}}}}}},"/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/promotion_code_exists":{"get":{"x-private":true,"summary":"getPromotionCodeExists | Check if promotion is already created with promotion code","description":"Check if sent promotion code is already existing promotion code. As promotion code is to be unique.","tags":["Cart"],"parameters":[{"schema":{"type":"string"},"description":"Current company id","in":"path","required":true,"name":"company_id"},{"schema":{"type":"string"},"description":"Current Application _id","in":"path","required":true,"name":"application_id"},{"name":"code","in":"query","schema":{"type":"string","description":"Promotion code"}}],"responses":{"200":{"description":"Valid response with existing promotion code count","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"count":{"type":"integer"}}},"examples":{"Promotion code exists":{"value":{"success":true,"count":1}},"Promotion code is new":{"value":{"success":true,"count":0}}}}}},"400":{"description":"Missing required param","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}},"examples":{"Missing promotion code param in request body":{"value":{"success":true,"message":"code is required query param"}}}}}}}}},"/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/checkout/over-ride":{"post":{"summary":"overrideCart | Create Fynd order with overriding cart details","description":"Generate Fynd order while overriding cart details sent with provided `cart_items`","tags":["Cart"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OverrideCheckoutReq"},"example":{"billing_address":{"name":"Dummy Ann Chovey","address":"Test Lorem Ipsum","area":"Test Lorem Ipsum","phone":99999999,"area_code":"400050","area_code_slug":"pincode","email":"test@gofynd.com","address_type":"home","city":"Mumbai","state":"Maharastra","country":"India","country_code":"IND","meta":{"data":"Lorem Ipsum"}},"shipping_address":{"name":"Dummy Ann Chovey","address":"Test Lorem Ipsum adddress","area":"Test Lorem Ipsum","phone":99999999,"area_code":"400050","area_code_slug":"pincode","email":"test@gofynd.com","address_type":"office","city":"Mumbai","state":"Maharastra","country":"India","country_code":"IND","meta":{"data":"Lorem Ipsum"}},"cart_id":"63007e85f7df71d5a89758cf","cart_items":[{"item_id":7502730,"size":"OS","quantity":1,"promo_list":[{"rwrd_tndr":"","promo_desc":"New price peritem 90","promo_id":"31792","promo_amount":"100","item_list":[]},{"rwrd_tndr":"","promo_desc":"Level Promotion","promo_id":"119440","parent_promo_id":"1243523-1","promo_amount":"50","item_list":[]},{"rwrd_tndr":"","promo_desc":"Bill Value 500","promo_id":"120665","parent_promo_id":"1243523-1","promo_amount":"50","item_list":[]}],"discount":200,"amount_paid":200,"price_effective":200,"price_marked":400,"seller_identifier":"62524316","extra_meta":{}}],"merchant_code":"JIOPP","aggregator":"Jio","payment_mode":"JIOPP","payment_identifier":"JIOPP","ordering_store_id":3484,"order_type":"PickAtStore","currency_code":"INR"}}}},"responses":{"200":{"description":"Checkout cart and create Fynd order id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OverrideCheckoutResponse"},"example":{"success":"true","cart":{"success":true,"delivery_charges":0,"store_code":"","order_id":"FY630DDF8601EF037743","cod_message":"COD available","delivery_slots":[{"date":"Fri, 09 Nov","delivery_slot":[{"delivery_slot_timing":"By 9:00 PM","default":true,"delivery_slot_id":1}]}],"user_type":"FYND Store user","cod_available":true,"cod_charges":0,"store_emp_list":[],"delivery_charge_order_value":1500,"breakup_values":{"loyalty_points":{"total":0,"applicable":0,"is_applied":false,"description":"Your cashback, reward points, and refund amount get credited to Fynd Cash which can be redeemed while placing an order.","message":"No Fynd Cash Applied"},"coupon":{"type":"cash","code":"","uid":"","value":0,"is_applied":false,"message":"Coupon not applicable with Reward point"},"display":[{"display":"MRP Total","key":"mrp_total","original":400,"attr":"mrp_total","value":400,"currency_code":"INR","currency_symbol":"₹","message":[]},{"display":"Discount","key":"discount","original":-200,"attr":"discount","value":-200,"currency_code":"INR","currency_symbol":"₹","message":[]},{"display":"Subtotal","key":"subtotal","original":200,"attr":"subtotal","value":200,"currency_code":"INR","currency_symbol":"₹","message":[]},{"display":"Total","key":"total","original":200,"attr":"total","value":200,"currency_code":"INR","currency_symbol":"₹","message":[]}],"raw":{"sub_total":200,"subtotal":200,"coupon":0,"promotion":0,"delivery_charge":0,"you_saved":0,"fynd_cash":0,"cod_charge":0,"total":200,"gst_charges":9.52,"vog":190.48,"convenience_fee":0,"mrp_total":400,"discount":-200}},"items":[{"message":"","quantity":1,"is_set":false,"delivery_promise":{"timestamp":{"min":1646257339,"max":1646689339},"formatted":{"min":"03 Mar, Thursday","max":"08 Mar, Tuesday"}},"identifiers":{"identifier":"5mPyy88URXuh3Lo35uaTg"},"moq":{"maximum":4,"minimum":1},"coupon_message":"","product":{"type":"product","uid":7502730,"name":"SLIM FIT JEANS","slug":"slim-fit-jeans1","brand":{"uid":29,"name":"lacoste"},"categories":[{"uid":3602,"name":"Dresses"}],"attributes":{"net-quantity":"17","occasion":"Beach Wear","gender":"Men","pattern":"Animal","brand-size":"UK46","style-type":"A-line Dresses","season-year":"2018","secondary-color":"Black","jiomart-allowed-size":"Free Size","fabric":"Chambray","wash-care":"Hand Wash Cold Separately","size-group":"Regular","brand-color":"Black","color-shade":"Bright","multi-brick":"Ethnic Bottoms","product-name":"Bodycon Dress","multi-segment":"Men","primary-color":"Navy","multi-vertical":"Western Wear","component-count":"100","manufactured-by":"RIL","year-of-packaging":"2017","product-code-x-catalog-option-color":"1","technique":"Sanganeri","waist-in-inches":"30","chest-size-in-inches":"12","shoulder-size-in-inches":"12","sleeve-length":"Half","neckline":"Collar","brand_name":"lacoste"},"images":[{"aspect_ratio":"16:25","url":"https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/original/LYa1_YA3_-console.png","secure_url":"https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/original/LYa1_YA3_-console.png"}],"action":{"type":"product","url":"https://api.fyndx0.de/platform/content/v1/products/slim-fit-jeans1/","query":{"product_slug":["slim-fit-jeans1"]}},"item_code":"JEANS1232","_custom_json":{}},"key":"7502730_OS","price":{"base":{"add_on":100,"marked":400,"effective":200,"selling":200,"currency_code":"INR","currency_symbol":"₹"},"converted":{"add_on":100,"marked":400,"effective":200,"selling":200,"currency_code":"INR","currency_symbol":"₹"}},"price_per_unit":{"base":{"marked":400,"effective":200,"selling_price":200,"currency_code":"INR","currency_symbol":"₹"},"converted":{"marked":400,"effective":200,"selling_price":200,"currency_code":"INR","currency_symbol":"₹"}},"article":{"type":"article","uid":"62e3ca42a2348dd4cb4cd693","size":"OS","seller":{"uid":1527,"name":"SPEED-A-WAY PVT. LTD."},"store":{"uid":3484,"name":"Location 1"},"quantity":19,"price":{"base":{"marked":400,"effective":200,"selling":200,"currency_code":"INR","currency_symbol":"₹"},"converted":{"marked":400,"effective":200,"selling":200,"currency_code":"INR","currency_symbol":"INR"}},"extra_meta":{}},"bulk_offer":{},"discount":"50% OFF","promotions_applied":[],"availability":{"sizes":["OS"],"other_store_quantity":1,"out_of_stock":false,"deliverable":true,"is_valid":true,"available_sizes":[{"is_available":true,"display":"OS","value":"OS"}]},"promo_meta":{}}],"delivery_charge_info":"","notification":{},"message":"","delivery_promise":{"timestamp":{"min":1646257339,"max":1646689339},"formatted":{"min":"03 Mar, Thursday","max":"08 Mar, Tuesday"}},"coupon_text":"View all offers","cart_id":21755,"id":"63007e85f7df71d5a89758cf","uid":"21755","gstin":"","comment":"","checkout_mode":"self","payment_selection_lock":{"enabled":true,"default_options":"JIOPP","payment_identifier":"JIOPP"},"restrict_checkout":false,"is_valid":true,"currency":{"code":"INR","symbol":"₹"},"last_modified":"2023-03-03T00:00:00.000Z"},"message":"","data":{"transactionRefNumber":"FY630DDF8601EF037743","base64_html":"PGh0bWw+PGhlYWQ+PG1ldGEgbmFtZT0ndmlld3BvcnQnIGNvbnRlbnQ9J3dpZHRoPWRldmljZS13aWR0aCwgaW5pdGlhbC1zY2FsZT0xICwgbWF4aW11bS1zY2FsZT0xLCB1c2VyLXNjYWxhYmxlPW5vJz48c2NyaXB0IHR5cGU9J3RleHQvamF2YXNjcmlwdCc+ZnVuY3Rpb24gZm9ybVN1Ym1pdCgpe2RvY3VtZW50LmdldEVsZW1lbnRCeUlkKCdwYXltZW50Jykuc3VibWl0KCk7fTwvc2NyaXB0PjwvaGVhZD48Ym9keSBvbmxvYWQ9J2phdmFzY3JpcHQ6Zm9ybVN1Ym1pdCgpOyc+PGZvcm0gbmFtZT0ncGF5bWVudCcgaWQ9J3BheW1lbnQnIG1ldGhvZD0nUE9TVCcgYWN0aW9uPSdodHRwczovL3J0c3Mtc2l0Lmppb2Nvbm5lY3QuY29tL2ppb3BheXBnL3YxL3BheW1lbnQtb3B0aW9ucyc+PGltZyBzcmM9J2h0dHBzOi8vcnRzcy1zaXQuamlvY29ubmVjdC5jb20vdXBsb2FkL215amlvY29yZXN0YXRpY2ZpbGVzL2ltYWdlcy9sb2FkZXIuZ2lmJyB3aWR0aD0nMjUlJyBoZWlnaHQ9J2F1dG8nIHN0eWxlPSdkaXNwbGF5OiBibG9jazsgbWFyZ2luLXRvcDogMTIwcHg7bWFyZ2luLWxlZnQ6IGF1dG87IG1hcmdpbi1yaWdodDogYXV0bzsgbWFyZ2luLWJvdHRvbToxMHB4OycvPjxkaXYgc3R5bGU9J3RleHQtYWxpZ246IGNlbnRlcic+PHAgc3R5bGU9J2Rpc3BsYXk6IGlubGluZS1ibG9jazt2ZXJ0aWNhbC1hbGlnbjogbWlkZGxlO2ZvbnQtc2l6ZToxNnB4Jz5SZWRpcmVjdGluZyB0byBwYXltZW50IGdhdGV3YXkuIFBsZWFzZSBkbyBub3QgY2xpY2sgb24gcmVmcmVzaCBvciBiYWNrIGJ1dHRvbi4gPC9wPjwvZGl2PjxpbnB1dCB0eXBlPSdoaWRkZW4nIG5hbWU9J3BhcmFtMScgdmFsdWU9J2Q5OTBlYWFlZDI3ODRmNWNiMDVmMjI0M2Y2Y2IzNDNjJy8+PGlucHV0IHR5cGU9J3N1Ym1pdCcgdmFsdWU9Jycgc3R5bGU9J2Rpc3BsYXk6IG5vbmU7Jy8+PC9mb3JtPjwvYm9keT48L2h0bWw+","render_url":"https://api.xxxx0.de/platform/payment/v2/external/payments/html/render","payment_confirm":"https://api.xxxx0.de/service/application/payment/v1.0/payment/confirm/"},"callback_url":"https://jio.xxxx0.de/cart/order-status","payment_confirm_url":"https://api.xxxx0.de/service/application/payment/v1.0/payment/confirm/","order_id":"FY630DDF8601EF037743","app_intercept_url":"https://jio.xxxx0.de/cart/order-status"}}}}},"parameters":[{"schema":{"type":"string"},"description":"Current company id","in":"path","required":true,"name":"company_id"},{"schema":{"type":"string"},"description":"Current Application _id","in":"path","required":true,"name":"application_id"}]}},"/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/share-cart":{"post":{"summary":"getCartShareLink | Generate token for sharing the cart","description":"Use this API to generate a shared cart snapshot and return a shortlink token. The link can be shared with other users for getting the same items in their cart.","tags":["Cart"],"requestBody":{"description":"Pass object to generate share cart snapshot Cart id for sharing cart. meta Staff, or dering store and other store related data meta data to merge","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetShareCartLinkRequest"},"examples":{"Get share token":{"value":{"id":"<cart_id>","meta":{"selected_staff":"5d0e058878c5444245dc686c","ordering_store":656}}}}}}},"responses":{"200":{"description":"Returns a URL to share and a token as shown below.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetShareCartLinkResponse"},"examples":{"Token Generated":{"value":{"token":"ZweG1XyX","share_url":"https://uniket-testing.addsale.link/shared-cart/ZweG1XyX"}}}}}}},"parameters":[{"schema":{"type":"string"},"description":"Current company id","in":"path","required":true,"name":"company_id"},{"schema":{"type":"string"},"description":"Current Application _id","in":"path","required":true,"name":"application_id"}]}},"/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/share-cart/{token}":{"get":{"summary":"getCartSharedItems | Get details of a shared cart","description":"Use this API to get the shared cart details as per the token generated using the share-cart API.","tags":["Cart"],"parameters":[{"schema":{"type":"string"},"description":"Current company id","in":"path","required":true,"name":"company_id"},{"schema":{"type":"string"},"description":"Current Application _id","in":"path","required":true,"name":"application_id"},{"name":"token","description":"Token of the shared short link","schema":{"type":"string"},"in":"path","required":true}],"responses":{"200":{"description":"Success. Returns a Cart object as per the valid token. Refer `SharedCartResponse` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SharedCartResponse"},"example":{"cart":{"shared_cart_details":{"token":"BQ9jySQ9","user":{"user_id":"23109086","is_anonymous":false},"meta":{"selected_staff":"","ordering_store":null},"selected_staff":"","ordering_store":null,"source":{},"created_on":"2019-12-18T14:00:07.165000"},"items":[{"key":"791651_6","identifiers":{"identifier":"5mPyy88URXuh3Lo35uaTg"},"discount":"","bulk_offer":{},"coupon_message":"","article":{"type":"article","uid":"304_1054_9036_R1005753_6","size":"6","seller":{"uid":304,"name":"LEAYAN GLOBAL PVT. LTD."},"store":{"uid":5322,"name":"Vaisali Nagar"},"quantity":1,"price":{"base":{"marked":2095,"effective":2095,"currency_code":"INR"},"converted":{"marked":2095,"effective":2095,"currency_code":"INR"}}},"product":{"type":"product","uid":791651,"name":"Black Running Shoes","slug":"furo-black-running-shoes-791651-f8bcc3","brand":{"uid":1054,"name":"Furo"},"categories":[{"uid":160,"name":"Running Shoes"}],"images":[{"aspect_ratio":"16:25","url":"http://cdn4.gofynd.com/media/pictures/tagged_items/original/1054_R1005753/1_1546490507364.jpg","secure_url":"https://d2zv4gzhlr4ud6.cloudfront.net/media/pictures/tagged_items/original/1054_R1005753/1_1546490507364.jpg"}],"action":{"type":"product","url":"https://api.addsale.com/platform/content/v1/products/furo-black-running-shoes-791651-f8bcc3/","query":{"product_slug":["furo-black-running-shoes-791651-f8bcc3"]}}},"message":"","quantity":1,"availability":{"sizes":["7","8","9","10","6"],"other_store_quantity":12,"out_of_stock":false,"deliverable":true,"is_valid":true},"price":{"base":{"add_on":2095,"marked":2095,"effective":2095,"selling":2095,"currency_code":"INR"},"converted":{"add_on":2095,"marked":2095,"effective":2095,"selling":2095,"currency_code":"INR"}}},{"key":"791651_7","identifiers":{"identifier":"5mPyy88URXuh3Lo35uaTg"},"discount":"","bulk_offer":{},"coupon_message":"","article":{"type":"article","uid":"304_1054_9036_R1005753_7","size":"7","seller":{"uid":304,"name":"LEAYAN GLOBAL PVT. LTD."},"store":{"uid":5322,"name":"Vaisali Nagar"},"quantity":2,"price":{"base":{"marked":2095,"effective":2095,"currency_code":"INR"},"converted":{"marked":2095,"effective":2095,"currency_code":"INR"}}},"product":{"type":"product","uid":791651,"name":"Black Running Shoes","slug":"furo-black-running-shoes-791651-f8bcc3","brand":{"uid":1054,"name":"Furo"},"categories":[{"uid":160,"name":"Running Shoes"}],"images":[{"aspect_ratio":"16:25","url":"http://cdn4.gofynd.com/media/pictures/tagged_items/original/1054_R1005753/1_1546490507364.jpg","secure_url":"https://d2zv4gzhlr4ud6.cloudfront.net/media/pictures/tagged_items/original/1054_R1005753/1_1546490507364.jpg"}],"action":{"type":"product","url":"https://api.addsale.com/platform/content/v1/products/furo-black-running-shoes-791651-f8bcc3/","query":{"product_slug":["furo-black-running-shoes-791651-f8bcc3"]}}},"message":"","quantity":2,"availability":{"sizes":["7","8","9","10","6"],"other_store_quantity":7,"out_of_stock":false,"deliverable":true,"is_valid":true},"price":{"base":{"add_on":4190,"marked":4190,"effective":4190,"selling":4190,"currency_code":"INR"},"converted":{"add_on":4190,"marked":4190,"effective":4190,"selling":4190,"currency_code":"INR"}}}],"cart_id":13055,"uid":"13055","breakup_values":{"raw":{"cod_charge":0,"convenience_fee":0,"coupon":0,"delivery_charge":0,"discount":0,"fynd_cash":0,"gst_charges":958.73,"mrp_total":6285,"subtotal":6285,"total":6285,"vog":5326.27,"you_saved":0},"loyalty_points":{"total":0,"applicable":0,"is_applied":false,"description":"Your cashback, referrals, and refund amount get credited to Fynd Cash which can be redeemed while placing an order."},"coupon":{"type":"cash","code":"","uid":"","value":0,"is_applied":false,"message":"Sorry! Invalid coupon"},"display":[{"display":"MRP Total","key":"mrp_total","value":6285,"currency_code":"INR"},{"display":"Subtotal","key":"subtotal","value":6285,"currency_code":"INR"},{"display":"Total","key":"total","value":6285,"currency_code":"INR"}]},"delivery_charge_info":"","coupon_text":"View all offers","gstin":"","comment":"","checkout_mode":"self","payment_selection_lock":{"enabled":false,"default_options":"COD","payment_identifier":"JIOPP"},"restrict_checkout":false,"is_valid":true,"last_modified":"2023-03-03"},"error":""}}}},"404":{"description":"No cart found for the token sent","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SharedCartResponse"},"example":{"cart":{},"error":"Invalid or Expired token"}}}}}}},"/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/share-cart/{token}/{action}":{"post":{"summary":"updateCartWithSharedItems | Merge or replace existing cart","description":"Use this API to merge the shared cart with existing cart, or replace the existing cart with the shared cart. The `action` parameter is used to indicate the operation Merge or Replace.","tags":["Cart"],"parameters":[{"schema":{"type":"string"},"description":"Current company id","in":"path","required":true,"name":"company_id"},{"schema":{"type":"string"},"description":"Current Application _id","in":"path","required":true,"name":"application_id"},{"name":"token","description":"Token of the shared short link","schema":{"type":"string"},"in":"path","required":true},{"name":"action","description":"Operation to perform on the existing cart merge or replace.","schema":{"type":"string","enum":["merge","replace"]},"in":"path","required":true},{"name":"cart_id","in":"query","schema":{"type":"string","description":"The unique identifier of the cart"}}],"responses":{"200":{"description":"Success. Returns a merged or replaced cart as per the valid token. Refer `SharedCartResponse` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SharedCartResponse"},"examples":{"Cart Merged/Replaced":{"value":{"cart":{"shared_cart_details":{"token":"BQ9jySQ9","user":{"user_id":"23109086","is_anonymous":false},"meta":{"selected_staff":"","ordering_store":null},"selected_staff":"","ordering_store":null,"source":{},"created_on":"2019-12-18T14:00:07.165000"},"items":[{"key":"791651_6","identifiers":{"identifier":"5mPyy88URXuh3Lo35uaTg"},"discount":"","bulk_offer":{},"coupon_message":"","article":{"type":"article","uid":"304_1054_9036_R1005753_6","size":"6","seller":{"uid":304,"name":"LEAYAN GLOBAL PVT. LTD."},"store":{"uid":5322,"name":"Vaisali Nagar"},"quantity":1,"price":{"base":{"marked":2095,"effective":2095,"currency_code":"INR"},"converted":{"marked":2095,"effective":2095,"currency_code":"INR"}}},"product":{"type":"product","uid":791651,"name":"Black Running Shoes","slug":"furo-black-running-shoes-791651-f8bcc3","brand":{"uid":1054,"name":"Furo"},"categories":[{"uid":160,"name":"Running Shoes"}],"images":[{"aspect_ratio":"16:25","url":"http://cdn4.gofynd.com/media/pictures/tagged_items/original/1054_R1005753/1_1546490507364.jpg","secure_url":"https://d2zv4gzhlr4ud6.cloudfront.net/media/pictures/tagged_items/original/1054_R1005753/1_1546490507364.jpg"}],"action":{"type":"product","url":"https://api.addsale.com/platform/content/v1/products/furo-black-running-shoes-791651-f8bcc3/","query":{"product_slug":["furo-black-running-shoes-791651-f8bcc3"]}}},"message":"","quantity":1,"availability":{"sizes":["7","8","9","10","6"],"other_store_quantity":12,"out_of_stock":false,"deliverable":true,"is_valid":true},"price":{"base":{"add_on":2095,"marked":2095,"effective":2095,"selling":2095,"currency_code":"INR"},"converted":{"add_on":2095,"marked":2095,"effective":2095,"selling":2095,"currency_code":"INR"}}},{"key":"791651_7","identifiers":{"identifier":"5mPyy88URXuh3Lo35uaTg"},"discount":"","bulk_offer":{},"coupon_message":"","article":{"type":"article","uid":"304_1054_9036_R1005753_7","size":"7","seller":{"uid":304,"name":"LEAYAN GLOBAL PVT. LTD."},"store":{"uid":5322,"name":"Vaisali Nagar"},"quantity":2,"price":{"base":{"marked":2095,"effective":2095,"currency_code":"INR"},"converted":{"marked":2095,"effective":2095,"currency_code":"INR"}}},"product":{"type":"product","uid":791651,"name":"Black Running Shoes","slug":"furo-black-running-shoes-791651-f8bcc3","brand":{"uid":1054,"name":"Furo"},"categories":[{"uid":160,"name":"Running Shoes"}],"images":[{"aspect_ratio":"16:25","url":"http://cdn4.gofynd.com/media/pictures/tagged_items/original/1054_R1005753/1_1546490507364.jpg","secure_url":"https://d2zv4gzhlr4ud6.cloudfront.net/media/pictures/tagged_items/original/1054_R1005753/1_1546490507364.jpg"}],"action":{"type":"product","url":"https://api.addsale.com/platform/content/v1/products/furo-black-running-shoes-791651-f8bcc3/","query":{"product_slug":["furo-black-running-shoes-791651-f8bcc3"]}}},"message":"","quantity":2,"availability":{"sizes":["7","8","9","10","6"],"other_store_quantity":7,"out_of_stock":false,"deliverable":true,"is_valid":true},"price":{"base":{"add_on":4190,"marked":4190,"effective":4190,"selling":4190,"currency_code":"INR"},"converted":{"add_on":4190,"marked":4190,"effective":4190,"selling":4190,"currency_code":"INR"}}}],"cart_id":13055,"uid":"13055","breakup_values":{"raw":{"cod_charge":0,"convenience_fee":0,"coupon":0,"delivery_charge":0,"discount":0,"fynd_cash":0,"gst_charges":958.73,"mrp_total":6285,"subtotal":6285,"total":6285,"vog":5326.27,"you_saved":0},"loyalty_points":{"total":0,"applicable":0,"is_applied":false,"description":"Your cashback, referrals, and refund amount get credited to Fynd Cash which can be redeemed while placing an order."},"coupon":{"type":"cash","code":"","uid":"","value":0,"is_applied":false,"message":"Sorry! Invalid coupon"},"display":[{"display":"MRP Total","key":"mrp_total","value":6285,"currency_code":"INR"},{"display":"Subtotal","key":"subtotal","value":6285,"currency_code":"INR"},{"display":"Total","key":"total","value":6285,"currency_code":"INR"}]},"delivery_charge_info":"","coupon_text":"View all offers","gstin":"","comment":"","checkout_mode":"self","payment_selection_lock":{"enabled":false,"default_options":"COD","payment_identifier":"JIOPP"},"restrict_checkout":false,"is_valid":true,"last_modified":"2023-03-03"}}}}}}}}}},"/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/cart-list":{"get":{"summary":"getCartList | Get cart list for store os user","description":"Get all carts for the store os user which is created for customer","tags":["Cart"],"parameters":[{"schema":{"type":"string"},"description":"Current company id","in":"path","required":true,"name":"company_id"},{"schema":{"type":"string"},"description":"Current Application _id","in":"path","required":true,"name":"application_id"},{"name":"from_date","in":"query","schema":{"type":"string","description":"Cart which are created on or after from_date. Supports ISO date format."}},{"name":"to_date","in":"query","schema":{"type":"string","description":"Cart which are created on or before to_date. Supports ISO date format."}},{"name":"filter_on","in":"query","schema":{"type":"string","description":"on which column to sort on i.e created_on or last_modified"}}],"responses":{"200":{"description":"Platform user cart list","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MultiCartResponse"},"examples":{"Cart list for pos platform":{"value":{"data":[{"pick_up_customer_details":{"mobile":7777996559,"email":"test_pickup_customer@gmail.com"},"created_on":"1675780233","cart_value":1999,"cart_id":"63e213d45e4206d94485935f","item_counts":1,"user_id":"63d0bfa35b92b61cf50cfe29"},{"pick_up_customer_details":{},"created_on":"1675779508","cart_value":5997,"cart_id":"63e210d03437dfb6c731062a","item_counts":3,"user_id":"63693036ef136d40c32c0ac8"}],"success":true}}}}}}}}},"/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/update-user":{"put":{"summary":"updateCartUser | Update user id for store os customer","description":"Update user id for store os customer after creating customer","tags":["Cart"],"parameters":[{"schema":{"type":"string"},"description":"Current company id","in":"path","required":true,"name":"company_id"},{"schema":{"type":"string"},"description":"Current Application _id","in":"path","required":true,"name":"application_id"},{"name":"id","in":"query","schema":{"type":"string","description":"cart id"}}],"requestBody":{"description":"Customer id to map with cart.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUserCartMapping"},"example":{"user_id":"123456778"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserCartMappingResponse"},"examples":{"Update and map cart user":{"value":{"message":"User verified successfully","success":true,"cart":{"breakup_values":{"display":[{"display":"MRP Total","key":"mrp_total","original":5997,"attr":"mrp_total","value":5997,"currency_code":"INR","currency_symbol":"₹","message":[]},{"display":"Subtotal","key":"subtotal","original":5997,"attr":"subtotal","value":5997,"currency_code":"INR","currency_symbol":"₹","message":[]},{"display":"Total","key":"total","original":5997,"attr":"total","value":5997,"currency_code":"INR","currency_symbol":"₹","message":[]}],"loyalty_points":{"total":0,"applicable":0,"is_applied":false,"description":"Your cashback, reward points, and refund amount get credited to Fynd Cash which can be redeemed while placing an order.","message":"No Fynd Cash Applied"},"coupon":{"type":"cash","code":"","uid":"","value":0,"is_applied":false,"message":"Sorry! Invalid coupon"},"raw":{"sub_total":5997,"subtotal":5997,"coupon":0,"promotion":0,"delivery_charge":0,"you_saved":0,"fynd_cash":0,"cod_charge":0,"total":5997,"gst_charges":0,"vog":0,"convenience_fee":0,"mrp_total":5997,"discount":0}},"items":[{"quantity":3,"discount":"","bulk_offer":{},"is_set":false,"key":"803158_M","price_per_unit":{"base":{"marked":1999,"effective":1999,"selling_price":1999,"currency_code":"INR","currency_symbol":"₹"},"converted":{"marked":1999,"effective":1999,"selling_price":1999,"currency_code":"INR","currency_symbol":"₹"}},"promotions_applied":[],"message":"","identifiers":{"identifier":"gIq0E94RSMueSdDRAk_Txg"},"delivery_promise":null,"price":{"base":{"add_on":5997,"marked":5997,"effective":5997,"selling":5997,"currency_code":"INR","currency_symbol":"₹"},"converted":{"add_on":5997,"marked":5997,"effective":5997,"selling":5997,"currency_code":"INR","currency_symbol":"₹"}},"product":{"type":"product","uid":803158,"name":"Pink Solid Casual Shirt","slug":"pink-solid-casual-shirt-vpvlt-00h3rv","brand":{"uid":44,"name":""},"categories":[{"uid":133,"name":"Casual Shirts"}],"attributes":{"item_code":"NAPINPOINT@PRUNE","color":"Pink","gender":"Men","occasion":"Casual","season":"SS19","material":"100% Cotton","pattern":"Solid","product_fit":"Slim","sleeve_length":"Long","neck_type":"Classic Collar","care_instructions":"Machine Wash","primary_color":"Pink","primary-material":"Cotton","currency":"INR","media":[{"url":"https://hdn-1.fynd.com/media/pictures/tagged_items/original/44_NAPINPOINT@PRUNE/1_1548161273342.jpg","type":"image"},{"url":"https://hdn-1.fynd.com/media/pictures/tagged_items/original/44_NAPINPOINT@PRUNE/2_1548161273342.jpg","type":"image"},{"url":"https://hdn-1.fynd.com/media/pictures/tagged_items/original/44_NAPINPOINT@PRUNE/3_1548161273342.jpg","type":"image"},{"url":"https://hdn-1.fynd.com/media/pictures/tagged_items/original/44_NAPINPOINT@PRUNE/4_1548161273342.jpg","type":"image"},{"url":"https://hdn-1.fynd.com/media/pictures/tagged_items/original/44_NAPINPOINT@PRUNE/5_1548161273342.jpg","type":"image"}],"name":"Pink Solid Casual Shirt","brand_name":"celio","primary_color_hex":"FA7DC9"},"images":[{"aspect_ratio":"16:25","url":"https://hdn-1.fynd.com/media/pictures/tagged_items/original/44_NAPINPOINT@PRUNE/1_1548161273342.jpg","secure_url":"https://hdn-1.fynd.com/media/pictures/tagged_items/original/44_NAPINPOINT@PRUNE/1_1548161273342.jpg"},{"aspect_ratio":"16:25","url":"https://hdn-1.fynd.com/media/pictures/tagged_items/original/44_NAPINPOINT@PRUNE/2_1548161273342.jpg","secure_url":"https://hdn-1.fynd.com/media/pictures/tagged_items/original/44_NAPINPOINT@PRUNE/2_1548161273342.jpg"},{"aspect_ratio":"16:25","url":"https://hdn-1.fynd.com/media/pictures/tagged_items/original/44_NAPINPOINT@PRUNE/3_1548161273342.jpg","secure_url":"https://hdn-1.fynd.com/media/pictures/tagged_items/original/44_NAPINPOINT@PRUNE/3_1548161273342.jpg"},{"aspect_ratio":"16:25","url":"https://hdn-1.fynd.com/media/pictures/tagged_items/original/44_NAPINPOINT@PRUNE/4_1548161273342.jpg","secure_url":"https://hdn-1.fynd.com/media/pictures/tagged_items/original/44_NAPINPOINT@PRUNE/4_1548161273342.jpg"},{"aspect_ratio":"16:25","url":"https://hdn-1.fynd.com/media/pictures/tagged_items/original/44_NAPINPOINT@PRUNE/5_1548161273342.jpg","secure_url":"https://hdn-1.fynd.com/media/pictures/tagged_items/original/44_NAPINPOINT@PRUNE/5_1548161273342.jpg"}],"action":{"type":"product","url":"https://api.fyndx1.de/platform/content/v1/products/pink-solid-casual-shirt-vpvlt-00h3rv/","query":{"product_slug":["pink-solid-casual-shirt-vpvlt-00h3rv"]}},"item_code":"NAPINPOINT@PRUNE","_custom_json":{}},"coupon_message":"","parent_item_identifiers":{"identifier":null,"parent_item_size":null,"parent_item_id":null},"availability":{"sizes":["M","XL","XXL"],"other_store_quantity":0,"out_of_stock":false,"deliverable":true,"is_valid":true,"available_sizes":[{"is_available":true,"display":"XL","value":"XL"},{"is_available":true,"display":"XXL","value":"XXL"},{"is_available":true,"display":"M","value":"M"},{"is_available":false,"display":"L","value":"L"},{"is_available":false,"display":"S","value":"S"}]},"promo_meta":{},"article":{"type":"article","uid":"5e6344616272810001dd0269","size":"M","product_group_tags":null,"seller":{"uid":743,"name":"SUN LIFE STYLES"},"store":{"uid":9957,"name":"JAYANAGAR, Karnataka"},"quantity":3,"price":{"base":{"marked":1999,"effective":1999,"selling":1999,"currency_code":"INR","currency_symbol":"₹"},"converted":{"marked":1999,"effective":1999,"selling":1999,"currency_code":"INR","currency_symbol":"INR"}},"extra_meta":{}},"moq":{}}],"cart_id":436470,"id":"63e210d03437dfb6c731062a","uid":"436470","buy_now":false,"gstin":"","comment":"","checkout_mode":"self","restrict_checkout":false,"is_valid":true,"currency":{"code":"INR","symbol":"₹"},"last_modified":"2023-03-03T00:00:00.000Z"},"user":{"uid":"63693036ef136d40c32c0ac8","_id":"63693036ef136d40c32c0ac8","first_name":"Neel","last_name":"Gajjar","email":"neelgajjar@gofynd.com","mobile":"7096263966","gender":"male","created_at":"1667838020","modified_on":"1668514790","external_id":""}}}}}}}}}},"/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/detail":{"get":{"summary":"getCart | Fetch all items added to the customer cart using cart id","description":"Use this API to get details of all the items added to a cart.","tags":["Cart"],"parameters":[{"schema":{"type":"string"},"description":"Current company id","in":"path","required":true,"name":"company_id"},{"schema":{"type":"string"},"description":"Current Application _id","in":"path","required":true,"name":"application_id"},{"in":"query","name":"id","schema":{"type":"string","description":"The unique identifier of the cart"}},{"in":"query","name":"user_id","schema":{"type":"string","description":"Option to fetch cart for the provided user_id."}},{"in":"query","name":"i","schema":{"type":"boolean","description":"This is a boolean value. Select `true` to retrieve all the items added in the cart."}},{"in":"query","name":"b","schema":{"type":"boolean","description":"This is a boolean value. Select `true` to retrieve the price breakup of cart items."}},{"in":"query","name":"assign_card_id","schema":{"type":"integer","description":"Token of user's debit or credit card"}},{"in":"query","name":"buy_now","schema":{"type":"boolean","description":"This is a boolen value. Select `true` to set/initialize buy now cart"}}],"responses":{"200":{"description":"Success. Returns a Cart object. Check the example shown below or refer `CartDetailResponse` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CartDetailResponse"},"example":{"items":[{"bulk_offer":{},"identifiers":{"identifier":"5mPyy88URXuh3Lo35uaTg"},"discount":"67% OFF","article":{"type":"article","tags":[],"uid":"604_902_SSTC60401_636BLUE_1","size":"1","seller":{"uid":604,"name":"SHRI SHANTINATH TRADING COMPANY"},"store":{"uid":4579,"name":"Gandhi Nagar"},"quantity":108,"price":{"base":{"marked":2999,"effective":999,"currency_code":"INR"},"converted":{"marked":2999,"effective":999,"currency_code":"INR"}}},"coupon_message":"","key":"707569_1","availability":{"sizes":["1","8","7","2","9","5","3","6"],"other_store_quantity":107,"out_of_stock":false,"deliverable":true,"is_valid":true},"product":{"type":"product","uid":707569,"name":"Blue and Gold Printed Ethnic Set","slug":"aj-dezines-blue-and-gold-printed-ethnic-set-707569-bff01a","brand":{"uid":902,"name":""},"categories":[{"uid":525,"name":""}],"images":[{"aspect_ratio":"16:25","url":"http://cdn4.gofynd.com/media/pictures/tagged_items/original/902_636BLUE/1_1540301094877.jpg","secure_url":"https://d2zv4gzhlr4ud6.cloudfront.net/media/pictures/tagged_items/original/902_636BLUE/1_1540301094877.jpg"}],"action":{"type":"product","url":"https://api.addsale.com/v1/products/aj-dezines-blue-and-gold-printed-ethnic-set-707569-bff01a/","query":{"product_slug":["aj-dezines-blue-and-gold-printed-ethnic-set-707569-bff01a"]}}},"price":{"base":{"add_on":999,"marked":2999,"effective":999,"selling":999,"currency_code":"INR"},"converted":{"add_on":999,"marked":2999,"effective":999,"selling":999,"currency_code":"INR"}},"message":"","quantity":1}],"buy_now":false,"cart_id":54,"uid":"54","breakup_values":{"raw":{"cod_charge":0,"convenience_fee":0,"coupon":0,"delivery_charge":0,"discount":-2000,"fynd_cash":0,"gst_charges":47.57,"mrp_total":2999,"subtotal":999,"total":999,"vog":951.43,"you_saved":0},"coupon":{"type":"cash","code":"","uid":"304_1054_9036_R1005753_6","value":0,"is_applied":false,"message":"Sorry! Invalid Coupon"},"display":[{"display":"MRP Total","key":"mrp_total","value":2999,"currency_code":"INR"},{"display":"Discount","key":"discount","value":-2000,"currency_code":"INR"},{"display":"Subtotal","key":"subtotal","value":999,"currency_code":"INR"},{"display":"Total","key":"total","value":999,"currency_code":"INR"}],"loyalty_points":{"total":0,"applicable":0,"is_applied":false,"description":"Your cashback, referrals, and refund amount get credited to Fynd Cash which can be redeemed while placing an order."}},"delivery_charge_info":"","coupon_text":"View all offers","gstin":"","checkout_mode":"self","restrict_checkout":false,"is_valid":true,"last_modified":"2023-03-03"}}}},"400":{"description":"Invalid User error","content":{"application/json":{"schema":{"type":"object","properties":{"is_valid":{"type":"boolean"},"message":{"type":"string"}}},"examples":{"Invalid User Id":{"value":{"is_valid":false,"message":"Please enter a valid application user id."}}}}}}}},"post":{"summary":"platformAddItems | Add items to cart","description":"Use this API to add items to the cart.","tags":["Cart"],"parameters":[{"schema":{"type":"string"},"description":"Current company id","in":"path","required":true,"name":"company_id"},{"schema":{"type":"string"},"description":"Current Application _id","in":"path","required":true,"name":"application_id"},{"in":"query","name":"i","schema":{"type":"boolean","description":"This is a boolean value. Select `true` to retrieve all the items added in the cart."}},{"in":"query","name":"b","schema":{"type":"boolean","description":"This is a boolean value. Select `true` to retrieve the price breakup of cart items."}},{"in":"query","name":"buy_now","schema":{"type":"boolean","description":"This is a boolen value. Select `true` to set/initialize buy now cart"}},{"in":"query","name":"id","schema":{"type":"string","description":"The unique identifier of the cart"}}],"requestBody":{"description":"Specify the item details as shown below. Refer `PlatformAddCartRequest` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformAddCartRequest"},"example":{"items":[{"item_id":778937,"item_size":"OS","quantity":1,"article_assignment":{"level":"multi-companies","strategy":"optimal"},"seller_id":686,"store_id":5059,"extra_meta":{}}],"new_cart":true,"user_id":"8b526f521bb14a2593a8b9e3ce8c76b3"}}}},"responses":{"200":{"description":"Success. Returns a cart object as shown below. Refer `AddCartDetailResponse` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddCartDetailResponse"},"examples":{"Product has been added to your cart":{"value":{"message":"Product has been added to your cart","success":true,"cart":{"breakup_values":{"display":[{"display":"MRP Total","key":"mrp_total","value":17486,"currency_code":"INR"},{"display":"Discount","key":"discount","value":-3540,"currency_code":"INR"},{"display":"Subtotal","key":"subtotal","value":13946,"currency_code":"INR"},{"display":"Total","key":"total","value":13946,"currency_code":"INR"}],"raw":{"cod_charge":0,"convenience_fee":0,"coupon":0,"delivery_charge":0,"discount":-3540,"fynd_cash":0,"gst_charges":1529.96,"mrp_total":17486,"subtotal":13946,"total":13946,"vog":12416.04,"you_saved":0},"loyalty_points":{"total":0,"applicable":0,"is_applied":false,"description":"Your cashback, referrals, and refund amount get credited to Fynd Cash which can be redeemed while placing an order."},"coupon":{"type":"cash","code":"","uid":"","value":0,"is_applied":false,"message":"Sorry! Invalid Coupon"}},"items":[{"key":"751083_10","identifiers":{"identifier":"5mPyy88URXuh3Lo35uaTg"},"parent_item_identifiers":{"identifier":"ZASFF","parent_item_id":7501190,"parent_item_size":"OS"},"article":{"type":"article","uid":"612_9_SE61201_19100302_10","size":"10","seller":{"uid":612,"name":"SSR ENTERPRISE"},"store":{"uid":4431,"name":"Motilal Nagar 1, Goregaon"},"quantity":4,"price":{"base":{"marked":3999,"effective":2399,"currency_code":"INR"},"converted":{"marked":3999,"effective":2399,"currency_code":"INR"}}},"price":{"base":{"add_on":4798,"marked":7998,"effective":4798,"selling":4798,"currency_code":"INR"},"converted":{"add_on":4798,"marked":7998,"effective":4798,"selling":4798,"currency_code":"INR"}},"availability":{"sizes":["10"],"other_store_quantity":2,"out_of_stock":false,"deliverable":true,"is_valid":true},"product":{"type":"product","uid":751083,"name":"Carson 2","slug":"puma-carson-2-751083-6ad98d","brand":{"uid":9,"name":"Puma"},"categories":[{"uid":165,"name":"Outdoor Sports Shoes"}],"images":[{"aspect_ratio":"16:25","url":"http://cdn4.gofynd.com/media/pictures/tagged_items/original/9_19100302/1_1542807042296.jpg","secure_url":"https://d2zv4gzhlr4ud6.cloudfront.net/media/pictures/tagged_items/original/9_19100302/1_1542807042296.jpg"}],"action":{"type":"product","url":"https://api.addsale.com/platform/content/v1/products/puma-carson-2-751083-6ad98d/","query":{"product_slug":["puma-carson-2-751083-6ad98d"]}}},"coupon_message":"","quantity":2,"message":"","bulk_offer":{},"discount":"41% OFF"},{"key":"246228_S","identifiers":{"identifier":"5mPyy88URXuh3Lo35uaTg"},"article":{"type":"article","uid":"46_235_TM62_M11029ONDSXNS_S","size":"S","seller":{"uid":46,"name":"RELIANCE BRANDS LIMITED"},"store":{"uid":4550,"name":"VR Mall"},"quantity":1,"price":{"base":{"marked":4490,"effective":4490,"currency_code":"INR"},"converted":{"marked":4490,"effective":4490,"currency_code":"INR"}}},"price":{"base":{"add_on":4490,"marked":4490,"effective":4490,"selling":4490,"currency_code":"INR"},"converted":{"add_on":4490,"marked":4490,"effective":4490,"selling":4490,"currency_code":"INR"}},"availability":{"sizes":["L","M","S","XL","XXL"],"other_store_quantity":0,"out_of_stock":false,"deliverable":true,"is_valid":true},"product":{"type":"product","uid":246228,"name":"Blue Solid T-Shirt","slug":"superdry-blue-solid-t-shirt-2","brand":{"uid":235,"name":"Superdry"},"categories":[{"uid":192,"name":"T-Shirts"}],"images":[{"aspect_ratio":"16:25","url":"http://cdn4.gofynd.com/media/pictures/tagged_items/original/235_M11029ONDSXNS/1.jpg","secure_url":"https://d2zv4gzhlr4ud6.cloudfront.net/media/pictures/tagged_items/original/235_M11029ONDSXNS/1.jpg"}],"action":{"type":"product","url":"https://api.addsale.com/platform/content/v1/products/superdry-blue-solid-t-shirt-2/","query":{"product_slug":["superdry-blue-solid-t-shirt-2"]}}},"coupon_message":"","quantity":1,"message":"","bulk_offer":{},"discount":""},{"key":"443175_S","identifiers":{"identifier":"5mPyy88URXuh3Lo35uaTg"},"article":{"type":"article","uid":"162_207_1271_LJ03LBLUDN88_S","size":"S","seller":{"uid":162,"name":"GO FASHION INDIA PRIVATE LIMITED"},"store":{"uid":5784,"name":"Vega City mall"},"quantity":3,"price":{"base":{"marked":1599,"effective":1599,"currency_code":"INR"},"converted":{"marked":1599,"effective":1599,"currency_code":"INR"}}},"price":{"base":{"add_on":1599,"marked":1599,"effective":1599,"selling":1599,"currency_code":"INR"},"converted":{"add_on":1599,"marked":1599,"effective":1599,"selling":1599,"currency_code":"INR"}},"availability":{"sizes":["XL","M","L","S"],"other_store_quantity":8,"out_of_stock":false,"deliverable":true,"is_valid":true},"product":{"type":"product","uid":443175,"name":"Light Blue Denim Jeggings","slug":"go-colors-light-blue-denim-jeggings-443175-3c688c","brand":{"uid":207,"name":"Go Colors"},"categories":[{"uid":267,"name":"Jeggings"}],"images":[{"aspect_ratio":"16:25","url":"http://cdn4.gofynd.com/media/pictures/tagged_items/original/207_LJ03LBLUDN88/1_1512382513548.jpg","secure_url":"https://d2zv4gzhlr4ud6.cloudfront.net/media/pictures/tagged_items/original/207_LJ03LBLUDN88/1_1512382513548.jpg"}],"action":{"type":"product","url":"https://api.addsale.com/platform/content/v1/products/go-colors-light-blue-denim-jeggings-443175-3c688c/","query":{"product_slug":["go-colors-light-blue-denim-jeggings-443175-3c688c"]}}},"coupon_message":"","quantity":1,"message":"","bulk_offer":{},"discount":""},{"key":"778937_OS","identifiers":{"identifier":"5mPyy88URXuh3Lo35uaTg"},"article":{"type":"article","uid":"686_963_IC68601_PWUPC01977_OS","size":"OS","seller":{"uid":686,"name":"INDUS CORPORATION"},"store":{"uid":5059,"name":"Vidyaranyapura Main Road"},"quantity":3,"price":{"base":{"marked":3399,"effective":3059,"currency_code":"INR"},"converted":{"marked":3399,"effective":3059,"currency_code":"INR"}}},"price":{"base":{"add_on":3059,"marked":3399,"effective":3059,"selling":3059,"currency_code":"INR"},"converted":{"add_on":3059,"marked":3399,"effective":3059,"selling":3059,"currency_code":"INR"}},"availability":{"sizes":["OS"],"other_store_quantity":2,"out_of_stock":false,"deliverable":true,"is_valid":true},"product":{"type":"product","uid":778937,"name":"Colourful Carnival Bouncer","slug":"fisher-price-colourful-carnival-bouncer-778937-fafa1f","brand":{"uid":963,"name":"Fisher-Price"},"categories":[{"uid":576,"name":"Cradles"}],"images":[{"aspect_ratio":"16:25","url":"http://cdn4.gofynd.com/media/pictures/tagged_items/original/963_PWUPC01977/1_1545308400588.jpg","secure_url":"https://d2zv4gzhlr4ud6.cloudfront.net/media/pictures/tagged_items/original/963_PWUPC01977/1_1545308400588.jpg"}],"action":{"type":"product","url":"https://api.addsale.com/platform/content/v1/products/fisher-price-colourful-carnival-bouncer-778937-fafa1f/","query":{"product_slug":["fisher-price-colourful-carnival-bouncer-778937-fafa1f"]}}},"coupon_message":"","quantity":1,"message":"","bulk_offer":{},"discount":"11% OFF"}],"delivery_charge_info":"","coupon_text":"View all offers","buy_now":false,"cart_id":7927,"uid":"7927","gstin":"","checkout_mode":"self","last_modified":"2023-03-03T00:00:00.000Z","restrict_checkout":false,"is_valid":true},"result":{}}},"Sorry, item is out of stock":{"value":{"message":"Sorry, item is out of stock","success":false,"cart":{"breakup_values":{"raw":{"cod_charge":0,"convenience_fee":0,"coupon":0,"delivery_charge":0,"discount":-202000,"fynd_cash":0,"gst_charges":4804.71,"mrp_total":302899,"subtotal":100899,"total":100899,"vog":96094.29,"you_saved":0},"coupon":{"type":"cash","code":"","uid":"","value":0,"is_applied":false,"message":"Sorry! Invalid Coupon"},"display":[{"display":"MRP Total","key":"mrp_total","value":302899,"currency_code":"INR"},{"display":"Discount","key":"discount","value":-202000,"currency_code":"INR"},{"display":"Subtotal","key":"subtotal","value":100899,"currency_code":"INR"},{"display":"Total","key":"total","value":100899,"currency_code":"INR"}],"loyalty_points":{"total":0,"applicable":0,"is_applied":false,"description":"Your cashback, referrals, and refund amount get credited to Fynd Cash which can be redeemed while placing an order."}},"items":[{"bulk_offer":{},"identifiers":{"identifier":"5mPyy88URXuh3Lo35uaTg"},"discount":"67% OFF","parent_item_identifiers":{"identifier":"ZASFF","parent_item_id":7501190,"parent_item_size":"OS"},"article":{"type":"article","uid":"604_902_SSTC60401_636BLUE_1","size":"1","seller":{"uid":604,"name":"SHRI SHANTINATH TRADING COMPANY"},"store":{"uid":4579,"name":"Gandhi Nagar"},"quantity":108,"price":{"base":{"marked":2999,"effective":999,"currency_code":"INR"},"converted":{"marked":2999,"effective":999,"currency_code":"INR"}}},"coupon_message":"","key":"707569_1","availability":{"sizes":["1","8","7","2","9","5","3","6"],"other_store_quantity":7,"out_of_stock":false,"deliverable":true,"is_valid":true},"product":{"type":"product","uid":707569,"name":"Blue and Gold Printed Ethnic Set","slug":"aj-dezines-blue-and-gold-printed-ethnic-set-707569-bff01a","brand":{"uid":902,"name":""},"categories":[{"uid":525,"name":""}],"images":[{"aspect_ratio":"16:25","url":"http://cdn4.gofynd.com/media/pictures/tagged_items/original/902_636BLUE/1_1540301094877.jpg","secure_url":"https://d2zv4gzhlr4ud6.cloudfront.net/media/pictures/tagged_items/original/902_636BLUE/1_1540301094877.jpg"}],"action":{"type":"product","url":"https://api.addsale.com/v1/products/aj-dezines-blue-and-gold-printed-ethnic-set-707569-bff01a/","query":{"product_slug":["aj-dezines-blue-and-gold-printed-ethnic-set-707569-bff01a"]}}},"price":{"base":{"add_on":100899,"marked":302899,"effective":100899,"selling":100899,"currency_code":"INR"},"converted":{"add_on":100899,"marked":302899,"effective":100899,"selling":100899,"currency_code":"INR"}},"message":"","quantity":101}],"delivery_charge_info":"","coupon_text":"View all offers","buy_now":false,"cart_id":54,"uid":"54","gstin":"","checkout_mode":"self","restrict_checkout":false,"is_valid":false,"last_modified":"2023-03-03T00:00:00.000Z"},"result":{}}}}}}}}},"put":{"summary":"platformUpdateCart | Update items in the customer 's cart using cart id","description":"Use this API to update items added to the cart with the help of a request object containing attributes like item_quantity and item_size. These attributes will be fetched from the following APIs operation Operation for current api call. update_item for update items. remove_item for removing items.item_id \"/platform/content/v1/products/\" item_size \"/platform/content/v1/products/:slug/sizes/\" quantity  item quantity (must be greater than or equal to 1) article_id \"/content​/v1​/products​/:identifier​/sizes​/price​/\" item_index item position in the cart (must be greater than or equal to 0)","tags":["Cart"],"parameters":[{"schema":{"type":"string"},"description":"Current company id","in":"path","required":true,"name":"company_id"},{"schema":{"type":"string"},"description":"Current Application _id","in":"path","required":true,"name":"application_id"},{"in":"query","name":"id","schema":{"type":"string","description":"The unique identifier of the cart"}},{"in":"query","name":"i","schema":{"type":"boolean","description":"This is a boolean value. Select `true` to retrieve all the items added in the cart."}},{"in":"query","name":"b","schema":{"type":"boolean","description":"This is a boolean value. Select `true` to retrieve the price breakup of cart items."}},{"in":"query","name":"buy_now","schema":{"type":"boolean","description":"This is a boolen value. Select `true` to set/initialize buy now cart"}}],"requestBody":{"description":"Specify the item details and operation as shown below. Refer `PlatformUpdateCartRequest` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformUpdateCartRequest"},"example":{"user_id":"8b526f521bb14a2593a8b9e3ce8c76b3","operation":"update_item","items":[{"item_id":778937,"identifiers":{"identifier":"5mPyy88URXuh3Lo35uaTg"},"item_size":"OS","quantity":2,"article_id":"778937_OS","item_index":3,"extra_meta":{}}]}}}},"responses":{"200":{"description":"Success. Updates and returns a cart object as shown below. Refer `UpdateCartDetailResponse` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCartDetailResponse"},"examples":{"Nothing updated":{"value":{"cart":{"breakup_values":{"raw":{"cod_charge":0,"convenience_fee":0,"coupon":0,"delivery_charge":0,"discount":-202000,"fynd_cash":0,"gst_charges":4804.71,"mrp_total":302899,"subtotal":100899,"total":100899,"vog":96094.29,"you_saved":0},"coupon":{"type":"cash","code":"","uid":"","value":0,"is_applied":false,"message":"Sorry! Invalid Coupon"},"display":[{"display":"MRP Total","key":"mrp_total","value":302899,"currency_code":"INR"},{"display":"Discount","key":"discount","value":-202000,"currency_code":"INR"},{"display":"Subtotal","key":"subtotal","value":100899,"currency_code":"INR"},{"display":"Total","key":"total","value":100899,"currency_code":"INR"}],"loyalty_points":{"total":0,"applicable":0,"is_applied":false,"description":"Your cashback, referrals, and refund amount get credited to Fynd Cash which can be redeemed while placing an order."}},"items":[{"bulk_offer":{},"identifiers":{"identifier":"5mPyy88URXuh3Lo35uaTg"},"discount":"67% OFF","parent_item_identifiers":{"identifier":"ZASFF","parent_item_id":7501190,"parent_item_size":"OS"},"article":{"type":"article","uid":"604_902_SSTC60401_636BLUE_1","size":"1","seller":{"uid":604,"name":"SHRI SHANTINATH TRADING COMPANY"},"store":{"uid":4579,"name":"Gandhi Nagar"},"quantity":108,"price":{"base":{"marked":2999,"effective":999,"currency_code":"INR"},"converted":{"marked":2999,"effective":999,"currency_code":"INR"}}},"coupon_message":"","key":"707569_1","availability":{"sizes":["1","8","7","2","9","5","3","6"],"other_store_quantity":7,"out_of_stock":false,"deliverable":true,"is_valid":true},"product":{"type":"product","uid":707569,"name":"Blue and Gold Printed Ethnic Set","slug":"aj-dezines-blue-and-gold-printed-ethnic-set-707569-bff01a","brand":{"uid":902,"name":""},"categories":[{"uid":525,"name":""}],"images":[{"aspect_ratio":"16:25","url":"http://cdn4.gofynd.com/media/pictures/tagged_items/original/902_636BLUE/1_1540301094877.jpg","secure_url":"https://d2zv4gzhlr4ud6.cloudfront.net/media/pictures/tagged_items/original/902_636BLUE/1_1540301094877.jpg"}],"action":{"type":"product","url":"https://api.addsale.com/v1/products/aj-dezines-blue-and-gold-printed-ethnic-set-707569-bff01a/","query":{"product_slug":["aj-dezines-blue-and-gold-printed-ethnic-set-707569-bff01a"]}}},"price":{"base":{"add_on":100899,"marked":302899,"effective":100899,"selling":100899,"currency_code":"INR"},"converted":{"add_on":100899,"marked":302899,"effective":100899,"selling":100899,"currency_code":"INR"}},"message":"","quantity":101}],"delivery_charge_info":"","coupon_text":"View all offers","buy_now":false,"cart_id":54,"uid":"54","gstin":"","checkout_mode":"self","restrict_checkout":false,"is_valid":true,"last_modified":"2023-03-03T00:00:00.000Z"},"result":{"707569_90":{"success":true,"message":"Nothing updated"}},"message":"Nothing updated","success":true}},"Item updated in the cart":{"value":{"cart":{"breakup_values":{"coupon":{"type":"cash","code":"","uid":"","value":0,"is_applied":false,"message":"Sorry! Invalid Coupon"},"loyalty_points":{"total":0,"applicable":0,"is_applied":false,"description":"Your cashback, referrals, and refund amount get credited to Fynd Cash which can be redeemed while placing an order."},"raw":{"cod_charge":0,"convenience_fee":0,"coupon":0,"delivery_charge":0,"discount":0,"fynd_cash":0,"gst_charges":838.83,"mrp_total":5499,"subtotal":5499,"total":5499,"vog":4660.17,"you_saved":0},"display":[{"display":"MRP Total","key":"mrp_total","value":5499,"currency_code":"INR"},{"display":"Subtotal","key":"subtotal","value":5499,"currency_code":"INR"},{"display":"Total","key":"total","value":5499,"currency_code":"INR"}]},"items":[{"key":"437414_7","identifiers":{"identifier":"5mPyy88URXuh3Lo35uaTg"},"message":"","bulk_offer":{},"price":{"base":{"add_on":5499,"marked":5499,"effective":5499,"selling":5499,"currency_code":"INR"},"converted":{"add_on":5499,"marked":5499,"effective":5499,"selling":5499,"currency_code":"INR"}},"quantity":1,"discount":"","product":{"type":"product","uid":437414,"name":"Suede Classic","slug":"puma-suede-classic-437414-6e6bbf","brand":{"uid":9,"name":"Puma"},"categories":[{"uid":165,"name":"Outdoor Sports Shoes"}],"images":[{"aspect_ratio":"16:25","url":"http://cdn4.gofynd.com/media/pictures/tagged_items/original/9_35656851/1_1511171811830.jpg","secure_url":"https://d2zv4gzhlr4ud6.cloudfront.net/media/pictures/tagged_items/original/9_35656851/1_1511171811830.jpg"}],"action":{"type":"product","url":"https://api.addsale.com/platform/content/v1/products/puma-suede-classic-437414-6e6bbf/","query":{"product_slug":["puma-suede-classic-437414-6e6bbf"]}}},"parent_item_identifiers":{"identifier":"ZASFF","parent_item_id":7501190,"parent_item_size":"OS"},"article":{"type":"article","uid":"507_9_96099_35656851_7","size":"7","seller":{"uid":507,"name":"PUMA SPORTS INDIA PVT LTD"},"store":{"uid":3632,"name":"Colaba Causway"},"quantity":5,"price":{"base":{"marked":5499,"effective":5499,"currency_code":"INR"},"converted":{"marked":5499,"effective":5499,"currency_code":"INR"}}},"coupon_message":"","availability":{"sizes":["10","11","6","9","7","8"],"other_store_quantity":22,"out_of_stock":false,"deliverable":true,"is_valid":true}}],"delivery_charge_info":"","coupon_text":"View all offers","buy_now":false,"cart_id":12426,"uid":"12426","gstin":"","checkout_mode":"self","last_modified":"2023-02-02T00:00:00.000Z","restrict_checkout":false,"is_valid":true},"result":{"437414_7":{"success":true,"message":"Quantity of item updated"}},"message":"Quantity of item updated","success":true}}}}}}}}},"/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/cart_archive":{"put":{"summary":"deleteCart | Delete cart once user made successful checkout","description":"Use this API to delete the cart.","tags":["Cart"],"parameters":[{"schema":{"type":"string"},"description":"Current company id","in":"path","required":true,"name":"company_id"},{"schema":{"type":"string"},"description":"Current Application _id","in":"path","required":true,"name":"application_id"},{"name":"id","in":"query","description":"The unique identifier of the cart.","schema":{"type":"string"}}],"requestBody":{"description":"Specify cart id list to archive/delete carts. Refer `DeleteCartRequest` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCartRequest"},"example":{"cart_id_list":["6136e0f9c9ac7b00075b57db","617a87cc976a9a6cbef12c34"]}}}},"responses":{"200":{"description":"Success. Returns whether the cart has been deleted or not.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCartDetailResponse"},"example":{"success":true,"message":"cart archived"}}}}}}},"/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/basic":{"get":{"summary":"getItemCount | Count items in the customer's cart","description":"Use this API to get the total number of items present in cart.","tags":["Cart"],"parameters":[{"schema":{"type":"string"},"description":"Current company id","in":"path","required":true,"name":"company_id"},{"schema":{"type":"string"},"description":"Current Application _id","in":"path","required":true,"name":"application_id"},{"name":"id","in":"query","description":"The unique identifier of the cart.","schema":{"type":"string"}},{"in":"query","name":"buy_now","schema":{"type":"boolean","description":"Boolean value to get buy_now cart."}}],"responses":{"200":{"description":"Success. Returns the total count of items in a user's cart.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CartItemCountResponse"},"example":{"user_cart_items_count":0}}}}}}},"/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/platform-pos-coupon":{"get":{"summary":"getAppCoupons | Fetch Coupon","description":"Use this API to get a list of available coupons along with their details.","tags":["Cart"],"parameters":[{"schema":{"type":"string"},"description":"Current company id","in":"path","required":true,"name":"company_id"},{"schema":{"type":"string"},"description":"Current Application _id","in":"path","required":true,"name":"application_id"},{"in":"query","name":"id","schema":{"type":"string","description":"The unique identifier of the cart."}},{"in":"query","name":"buy_now","schema":{"type":"boolean","description":"This is boolean to get buy_now cart"}},{"in":"query","name":"slug","schema":{"type":"string","description":"Product slug to fetch the available coupons"}},{"in":"query","name":"store_id","schema":{"type":"string","description":"Store id"}}],"responses":{"200":{"description":"Success. Returns a coupon object which has a list of all the eligible coupons. Refer `GetCouponResponse` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCouponResponse"},"example":{"available_coupon_list":[{"coupon_value":500,"minimum_cart_value":0,"coupon_code":"RAJA500","title":"RAJA500 | Fynd coupon","sub_title":"NA","message":"TEST500","max_discount_value":500,"uid":17921,"is_applicable":true,"is_applied":false,"expires_on":"28 Aug, 19"},{"coupon_value":2250,"minimum_cart_value":0,"coupon_code":"PRISMC22250111","title":"celio 2 time coupn to kalim hsp","sub_title":"celio 2 time coupn to kalim hsp","message":"celio 2 time coupn to kalim hsp","max_discount_value":2250,"uid":17743,"is_applicable":true,"is_applied":false,"expires_on":"24 Jan, 20"}],"page":{"current":1,"total":0,"has_previous":false,"has_next":false,"total_item_count":0}}}}}}},"post":{"summary":"applyCoupon | Apply Coupon for platform pos user","description":"Use this API to apply coupons on items in the cart.","tags":["Cart"],"parameters":[{"schema":{"type":"string"},"description":"Current company id","in":"path","required":true,"name":"company_id"},{"schema":{"type":"string"},"description":"Current Application _id","in":"path","required":true,"name":"application_id"},{"in":"query","name":"i","schema":{"type":"boolean","description":"This is a boolean value. Select `true` to retrieve all the items added in the cart."}},{"in":"query","name":"b","schema":{"type":"boolean","description":"This is a boolean value. Select `true` to retrieve the price breakup of cart items."}},{"in":"query","name":"p","schema":{"type":"boolean","description":"This is a boolean value. Select `true` for getting a payment option in response."}},{"in":"query","name":"id","schema":{"type":"string","description":"The unique identifier of the cart"}},{"in":"query","name":"buy_now","schema":{"type":"boolean","description":"This is boolean to get buy_now cart"}}],"requestBody":{"description":"Pass coupon code in the request body as shown below.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplyCouponRequest"},"example":{"coupon_code":"armr499"}}}},"responses":{"201":{"description":"Success. Returns coupons applied to the cart along with item details and price breakup. Refer `CartDetailResponse` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CartDetailResponse"},"example":{"breakup_values":{"raw":{"cod_charge":0,"convenience_fee":0,"coupon":-2250,"delivery_charge":0,"discount":-7240.2163,"fynd_cash":0,"gst_charges":2139.08,"mrp_total":26983,"subtotal":19742.7837,"total":17492.7837,"vog":15353.7,"you_saved":0},"coupon":{"type":"cash","code":"PRISMC22250111","uid":"17743","value":2250,"is_applied":true,"message":"coupn applied"},"loyalty_points":{"total":0,"applicable":0,"is_applied":false,"description":"Your cashback, referrals, and refund amount get credited to Fynd Cash which can be redeemed while placing an order."},"display":[{"display":"MRP Total","key":"mrp_total","value":26983,"currency_code":"INR"},{"display":"Discount","key":"discount","value":-7240,"currency_code":"INR"},{"display":"Subtotal","key":"subtotal","value":19743,"currency_code":"INR"},{"display":"Coupon","key":"coupon","value":-2250,"currency_code":"INR"},{"display":"Total","key":"total","value":17493,"currency_code":"INR"}]},"items":[{"identifiers":{},"availability":{"identifiers":{"identifier":"5mPyy88URXuh3Lo35uaTg"},"sizes":["10"],"other_store_quantity":0,"out_of_stock":false,"deliverable":true,"is_valid":true},"product":{"type":"product","uid":751083,"name":"Carson 2","slug":"puma-carson-2-751083-6ad98d","brand":{"uid":9,"name":"Puma"},"categories":[{"uid":165,"name":"Outdoor Sports Shoes"}],"images":[{"aspect_ratio":"16:25","url":"http://cdn4.gofynd.com/media/pictures/tagged_items/original/9_19100302/1_1542807042296.jpg","secure_url":"https://d2zv4gzhlr4ud6.cloudfront.net/media/pictures/tagged_items/original/9_19100302/1_1542807042296.jpg"}],"action":{"type":"product","url":"https://api.addsale.com/platform/content/v1/products/puma-carson-2-751083-6ad98d/","query":{"product_slug":["puma-carson-2-751083-6ad98d"]}}},"quantity":4,"discount":"41% OFF","price":{"base":{"add_on":9596,"marked":15996,"effective":9596,"selling":9596,"currency_code":"INR"},"converted":{"add_on":9596,"marked":15996,"effective":9596,"selling":9596,"currency_code":"INR"}},"message":"","bulk_offer":{},"key":"751083_10","coupon_message":"","article":{"type":"article","uid":"612_9_SE61201_19100302_10","size":"10","seller":{"uid":612,"name":"SSR ENTERPRISE"},"store":{"uid":4431,"name":"Motilal Nagar 1, Goregaon"},"quantity":4,"price":{"base":{"marked":3999,"effective":2399,"currency_code":"INR"},"converted":{"marked":3999,"effective":2399,"currency_code":"INR"}}}},{"identifiers":{},"availability":{"sizes":["L","M","S","XL","XXL"],"other_store_quantity":0,"out_of_stock":false,"deliverable":true,"is_valid":true},"product":{"type":"product","uid":246228,"name":"Blue Solid T-Shirt","slug":"superdry-blue-solid-t-shirt-2","brand":{"uid":235,"name":"Superdry"},"categories":[{"uid":192,"name":"T-Shirts"}],"images":[{"aspect_ratio":"16:25","url":"http://cdn4.gofynd.com/media/pictures/tagged_items/original/235_M11029ONDSXNS/1.jpg","secure_url":"https://d2zv4gzhlr4ud6.cloudfront.net/media/pictures/tagged_items/original/235_M11029ONDSXNS/1.jpg"}],"action":{"type":"product","url":"https://api.addsale.com/platform/content/v1/products/superdry-blue-solid-t-shirt-2/","query":{"product_slug":["superdry-blue-solid-t-shirt-2"]}}},"quantity":1,"discount":"","price":{"base":{"add_on":4490,"marked":4490,"effective":4490,"selling":4490,"currency_code":"INR"},"converted":{"add_on":4490,"marked":4490,"effective":4490,"selling":4490,"currency_code":"INR"}},"message":"","bulk_offer":{},"key":"246228_S","coupon_message":"","article":{"type":"article","uid":"46_235_TM62_M11029ONDSXNS_S","size":"S","seller":{"uid":46,"name":"RELIANCE BRANDS LIMITED"},"store":{"uid":4550,"name":"VR Mall"},"quantity":1,"price":{"base":{"marked":4490,"effective":4490,"currency_code":"INR"},"converted":{"marked":4490,"effective":4490,"currency_code":"INR"}}}},{"identifiers":{},"availability":{"sizes":["XL","M","L","S"],"other_store_quantity":8,"out_of_stock":false,"deliverable":true,"is_valid":true},"product":{"type":"product","uid":443175,"name":"Light Blue Denim Jeggings","slug":"go-colors-light-blue-denim-jeggings-443175-3c688c","brand":{"uid":207,"name":"Go Colors"},"categories":[{"uid":267,"name":"Jeggings"}],"images":[{"aspect_ratio":"16:25","url":"http://cdn4.gofynd.com/media/pictures/tagged_items/original/207_LJ03LBLUDN88/1_1512382513548.jpg","secure_url":"https://d2zv4gzhlr4ud6.cloudfront.net/media/pictures/tagged_items/original/207_LJ03LBLUDN88/1_1512382513548.jpg"}],"action":{"type":"product","url":"https://api.addsale.com/platform/content/v1/products/go-colors-light-blue-denim-jeggings-443175-3c688c/","query":{"product_slug":["go-colors-light-blue-denim-jeggings-443175-3c688c"]}}},"quantity":1,"discount":"","price":{"base":{"add_on":1599,"marked":1599,"effective":1599,"selling":1599,"currency_code":"INR"},"converted":{"add_on":1599,"marked":1599,"effective":1599,"selling":1599,"currency_code":"INR"}},"message":"","bulk_offer":{},"key":"443175_S","coupon_message":"","article":{"type":"article","uid":"162_207_1271_LJ03LBLUDN88_S","size":"S","seller":{"uid":162,"name":"GO FASHION INDIA PRIVATE LIMITED"},"store":{"uid":5784,"name":"Vega City mall"},"quantity":3,"price":{"base":{"marked":1599,"effective":1599,"currency_code":"INR"},"converted":{"marked":1599,"effective":1599,"currency_code":"INR"}}}},{"identifiers":{},"availability":{"sizes":["OS"],"other_store_quantity":12,"out_of_stock":false,"deliverable":true,"is_valid":true},"product":{"type":"product","uid":842716,"name":"Blue Backpack","slug":"istorm-blue-backpack-842716-951b5a","brand":{"uid":1177,"name":"iStorm"},"categories":[{"uid":198,"name":"Backpacks"}],"images":[{"aspect_ratio":"16:25","url":"http://cdn4.gofynd.com/media/pictures/tagged_items/original/1177_IS483/1_1551353288247.jpg","secure_url":"https://d2zv4gzhlr4ud6.cloudfront.net/media/pictures/tagged_items/original/1177_IS483/1_1551353288247.jpg"}],"action":{"type":"product","url":"https://api.addsale.com/platform/content/v1/products/istorm-blue-backpack-842716-951b5a/","query":{"product_slug":["istorm-blue-backpack-842716-951b5a"]}}},"quantity":1,"discount":"34% OFF","price":{"base":{"add_on":998.7837,"marked":1499,"effective":998.7837,"selling":998.7837,"currency_code":"INR"},"converted":{"add_on":998.7837,"marked":1499,"effective":998.7837,"selling":998.7837,"currency_code":"INR"}},"message":"","bulk_offer":{},"key":"842716_OS","coupon_message":"","article":{"type":"article","uid":"638_1177_CRSL63802_IS483_OS","size":"OS","seller":{"uid":638,"name":"COUNFREEDISE RETAIL SERVICES LTD"},"store":{"uid":4630,"name":"Bhiwandi"},"quantity":4,"price":{"base":{"marked":1499,"effective":998.7837,"currency_code":"INR"},"converted":{"marked":1499,"effective":998.7837,"currency_code":"INR"}}}},{"identifiers":{},"availability":{"sizes":["OS"],"other_store_quantity":2,"out_of_stock":false,"deliverable":true,"is_valid":true},"product":{"type":"product","uid":778937,"name":"Colourful Carnival Bouncer","slug":"fisher-price-colourful-carnival-bouncer-778937-fafa1f","brand":{"uid":963,"name":"Fisher-Price"},"categories":[{"uid":576,"name":"Cradles"}],"images":[{"aspect_ratio":"16:25","url":"http://cdn4.gofynd.com/media/pictures/tagged_items/original/963_PWUPC01977/1_1545308400588.jpg","secure_url":"https://d2zv4gzhlr4ud6.cloudfront.net/media/pictures/tagged_items/original/963_PWUPC01977/1_1545308400588.jpg"}],"action":{"type":"product","url":"https://api.addsale.com/platform/content/v1/products/fisher-price-colourful-carnival-bouncer-778937-fafa1f/","query":{"product_slug":["fisher-price-colourful-carnival-bouncer-778937-fafa1f"]}}},"quantity":1,"discount":"11% OFF","price":{"base":{"add_on":3059,"marked":3399,"effective":3059,"selling":3059,"currency_code":"INR"},"converted":{"add_on":3059,"marked":3399,"effective":3059,"selling":3059,"currency_code":"INR"}},"message":"","bulk_offer":{},"key":"778937_OS","coupon_message":"","article":{"type":"article","uid":"686_963_IC68601_PWUPC01977_OS","size":"OS","seller":{"uid":686,"name":"INDUS CORPORATION"},"store":{"uid":5059,"name":"Vidyaranyapura Main Road"},"quantity":3,"price":{"base":{"marked":3399,"effective":3059,"currency_code":"INR"},"converted":{"marked":3399,"effective":3059,"currency_code":"INR"}}}}],"delivery_charge_info":"","coupon_text":"View all offers","buy_now":false,"cart_id":7927,"uid":"7927","gstin":"","checkout_mode":"self","last_modified":"2023-03-03T00:00:00.000Z","restrict_checkout":false,"is_valid":true}}}}}},"delete":{"summary":"removeCoupon | Remove Applied Coupon for platform pos user","description":"Remove Coupon applied on the cart by passing uid in request body.","tags":["Cart"],"parameters":[{"schema":{"type":"string"},"description":"Current company id","in":"path","required":true,"name":"company_id"},{"schema":{"type":"string"},"description":"Current Application _id","in":"path","required":true,"name":"application_id"},{"in":"query","name":"uid","schema":{"type":"string","description":"The unique identifier of the cart"}},{"in":"query","name":"buy_now","schema":{"type":"boolean","description":"This is boolean to get buy_now cart"}}],"responses":{"200":{"description":"Success. Returns coupons removed from the cart along with item details and price breakup. Refer `CartDetailResponse` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CartDetailResponse"},"example":{"breakup_values":{"raw":{"cod_charge":0,"convenience_fee":0,"coupon":0,"delivery_charge":0,"discount":0,"fynd_cash":0,"gst_charges":342.75,"mrp_total":3199,"subtotal":3199,"total":3199,"vog":2856.25,"you_saved":0},"coupon":{"type":"cash","code":"prismc22250111","uid":"17743","value":0,"is_applied":false,"message":"Coupon successfully removed"},"display":[{"display":"MRP Total","key":"mrp_total","value":3199,"currency_code":"INR"},{"display":"Subtotal","key":"subtotal","value":3199,"currency_code":"INR"},{"display":"Total","key":"total","value":3199,"currency_code":"INR"}],"loyalty_points":{"total":0,"applicable":0,"is_applied":false,"description":"Your cashback, referrals, and refund amount get credited to Fynd Cash which can be redeemed while placing an order."}},"items":[{"message":"","identifiers":{"identifier":"5mPyy88URXuh3Lo35uaTg"},"availability":{"sizes":["M","S","L","XXL","XL"],"other_store_quantity":10,"out_of_stock":false,"deliverable":true,"is_valid":true},"bulk_offer":{},"key":"857596_S","quantity":1,"price":{"base":{"add_on":3199,"marked":3199,"effective":3199,"selling":3199,"currency_code":"INR"},"converted":{"add_on":3199,"marked":3199,"effective":3199,"selling":3199,"currency_code":"INR"}},"discount":"","coupon_message":"","product":{"type":"product","uid":857596,"name":"Pink Solid Hoodie","slug":"883-police-pink-solid-hoodie-857596-111bdc","brand":{"uid":610,"name":"883 Police"},"categories":[{"uid":144,"name":"Hoodies"}],"images":[{"aspect_ratio":"16:25","url":"http://cdn4.gofynd.com/media/pictures/tagged_items/original/610_LETTER19APINK/1_1553062658148.jpg","secure_url":"https://d2zv4gzhlr4ud6.cloudfront.net/media/pictures/tagged_items/original/610_LETTER19APINK/1_1553062658148.jpg"}],"action":{"type":"product","url":"https://api.addsale.com/platform/content/v1/products/883-police-pink-solid-hoodie-857596-111bdc/","query":{"product_slug":["883-police-pink-solid-hoodie-857596-111bdc"]}}},"article":{"type":"article","uid":"381_610_IGPL01_LETTER19APINK_S","size":"S","seller":{"uid":381,"name":"INTERSOURCE GARMENTS PVT LTD"},"store":{"uid":3009,"name":"Kormangala"},"quantity":11,"price":{"base":{"marked":3199,"effective":3199,"currency_code":"INR"},"converted":{"marked":3199,"effective":3199,"currency_code":"INR"}}}}],"delivery_charge_info":"","coupon_text":"View all offers","buy_now":false,"cart_id":7477,"uid":"7477","gstin":"","checkout_mode":"self","last_modified":"2023-02-02T00:00:00.000Z","restrict_checkout":false,"is_valid":true}}}}}}},"/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/address":{"get":{"summary":"getAddresses | Fetch address","description":"Use this API to get all the addresses associated with an account. If successful, returns a Address resource in the response body specified in GetAddressesResponse.attibutes listed below are optional uid address_id  mobile_no checkout_mode tags default","tags":["Cart"],"parameters":[{"schema":{"type":"string"},"description":"Current company id","in":"path","required":true,"name":"company_id"},{"schema":{"type":"string"},"description":"Current Application _id","in":"path","required":true,"name":"application_id"},{"name":"cart_id","in":"query","schema":{"type":"string","description":"The unique identifier of the cart"}},{"in":"query","name":"buy_now","schema":{"type":"boolean","description":"This is boolean to get buy_now cart"}},{"in":"query","name":"mobile_no","schema":{"type":"string","description":"10-digit mobile number"}},{"in":"query","name":"checkout_mode","schema":{"type":"string","description":"Option to checkout for `self` or for `others`. By default, it is `self`."}},{"in":"query","name":"tags","schema":{"type":"string","description":"Tag given to an address, e.g. work, home, office, shop."}},{"in":"query","name":"is_default","schema":{"type":"boolean","description":"This is a boolean value. Select `true` to fetch the default address."}},{"in":"query","name":"user_id","schema":{"type":"string","description":"Option to fetch address for the provided user_id."}}],"responses":{"200":{"description":"Success. Returns an Address object containing a list of address saved in the account. Refer `GetAddressesResponse` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformGetAddressesResponse"},"examples":{"example1":{"summary":"Address for India","value":{"address":[{"landmark":"","area_code":"8b526f521bb14a2593a8b9e3ce8c76b3","id":"8b526f521bb14a2593a8b9e3ce8c76b3","state":"Maharashtra","meta":{},"user_id":"8b526f521bb14a2593a8b9e3ce8c76b3","created_by_user_id":"8b526f521bb14a2593a8b9e3ce8c76b3","country_code":"+91","state_code":"MH","country_phone_code":"91","country_iso_code":"IN","phone":"9915347757","geo_location":{},"country":"India","is_default_address":true,"is_active":true,"city":"Mumbai","pincode":400093,"checkout_mode":"self","address_type":"home","tags":[],"area":"Sector 127","name":"abc","email":"ankur@gofynd1.com","address":"Megatron2","_custom_json":{}}]}},"example2":{"summary":"Address for Dubai","value":{"address":[{"landmark":"","area_code":"","id":"651c0b882dbd5f702f711677","state":"","meta":{},"user_id":"8b526f521bb14a2593a8b9e3ce8c76b3","created_by_user_id":"8b526f521bb14a2593a8b9e3ce8c76b3","country_code":"+971","country_phone_code":"+971","country_iso_code":"AE","phone":"551234567","geo_location":{},"country":"United Arab Emirates","is_default_address":true,"is_active":true,"city":"Sharjah","sector":"Al Fisht","checkout_mode":"self","address_type":"home","tags":[],"area":"Dubai Park","name":"Shaikh Ahmed","email":"example@gmail.com","address":"B-62","_custom_json":{}}]}}}}}},"400":{"description":"Invalid User error","content":{"application/json":{"schema":{"type":"object","properties":{"is_valid":{"type":"boolean"},"message":{"type":"string"}}},"examples":{"Invalid User Id":{"value":{"is_valid":false,"message":"Please enter a valid application user id."}}}}}}}},"post":{"summary":"addAddress | Add address to an account","description":"Use this API to add an address to an account.","tags":["Cart"],"requestBody":{"description":"Add address details in the request body as shown below or refer `PlatformAddress` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformAddress"},"example":{"user_id":"8b526f521bb14a2593a8b9e3ce8c76b3","checkout_mode":"other","is_default_address":true,"landmark":"","area":"Sector 127","phone":"9915347757","pincode":400093,"state_code":"MH","email":"ankur@gofynd1.com","address_type":"home","name":"abc","address":"Megatron2","store_name":"store123"}}}},"responses":{"200":{"description":"Success. Returns the address ID, a flag whether the address is set as default, and a success message. Refer `SaveAddressResponse` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaveAddressResponse"},"example":{"id":"mongo_object_id","is_default_address":true,"success":true}}}},"400":{"description":"Invalid User error","content":{"application/json":{"schema":{"type":"object","properties":{"is_valid":{"type":"boolean"},"message":{"type":"string"}}},"examples":{"Invalid User Id":{"value":{"is_valid":false,"message":"Please enter a valid application user id."}}}}}}},"parameters":[{"schema":{"type":"string"},"description":"Current company id","in":"path","required":true,"name":"company_id"},{"schema":{"type":"string"},"description":"Current Application _id","in":"path","required":true,"name":"application_id"}]}},"/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/address/{id}":{"get":{"summary":"getAddressById | Fetch a single address by its ID","description":"Use this API to get an addresses using its ID. If successful, returns a Address resource in the response body specified in `PlatformAddress`. Attibutes listed below are optional mobile_no checkout_mode tags default","tags":["Cart"],"parameters":[{"schema":{"type":"string"},"description":"Current company id","in":"path","required":true,"name":"company_id"},{"schema":{"type":"string"},"description":"Current Application _id","in":"path","required":true,"name":"application_id"},{"name":"id","in":"path","schema":{"type":"string","description":"ID allotted to the selected address"},"required":true},{"name":"cart_id","in":"query","schema":{"type":"string","description":"The unique identifier of the cart"}},{"in":"query","name":"buy_now","schema":{"type":"boolean","description":"This is boolean to get buy_now cart"}},{"in":"query","name":"mobile_no","schema":{"type":"string","description":"10-digit mobile number"}},{"in":"query","name":"checkout_mode","schema":{"type":"string","description":"Option to checkout for self or for others"}},{"in":"query","name":"tags","schema":{"type":"string","description":"Tag given to an address, e.g. work, home, office, shop."}},{"in":"query","name":"is_default","schema":{"type":"boolean","description":"This is a boolean value. Select `true` to fetch the default address."}},{"in":"query","name":"user_id","schema":{"type":"string","description":"Option to fetch address for the provided user_id."}}],"responses":{"200":{"description":"Success. Returns an PlatformAddress object containing a list of address saved in the account. Refer `PlatformAddress` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformAddress"},"example":{"landmark":"","area_code":"410218","state":"Maharashtra","meta":{},"user_id":"8b526f521bb14a2593a8b9e3ce8c76b3","created_by_user_id":"8b526f521bb14a2593a8b9e3ce8c76b3","country_code":"IND","state_code":"MH","phone":"9915347757","geo_location":{},"country":"India","is_default_address":true,"is_active":true,"city":"Mumbai","pincode":400093,"checkout_mode":"self","address_type":"home","uid":1145,"tags":[],"area":"Sector 127","name":"abc","address_id":1145,"email":"ankur@gofynd1.com","address":"Megatron2","store_name":"store123"}}}},"400":{"description":"Invalid User error","content":{"application/json":{"schema":{"type":"object","properties":{"is_valid":{"type":"boolean"},"message":{"type":"string"}}},"examples":{"Invalid User Id":{"value":{"is_valid":false,"message":"Please enter a valid application user id."}}}}}}}},"put":{"summary":"updateAddress | Update address added to an account","description":"Use this API to update an existing address in the account. Request object should contain attributes mentioned in Address can be updated. These attributes are:is_default_address landmark area pincode email address_type name address_id address","tags":["Cart"],"parameters":[{"schema":{"type":"string"},"description":"Current company id","in":"path","required":true,"name":"company_id"},{"schema":{"type":"string"},"description":"Current Application _id","in":"path","required":true,"name":"application_id"},{"name":"id","description":"ID allotted to the selected address","schema":{"type":"string"},"in":"path","required":true}],"requestBody":{"description":"Add address details in the request body as shown below or refer `PlatformAddress` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformAddress"},"example":{"user_id":"8b526f521bb14a2593a8b9e3ce8c76b3","is_default_address":true,"checkout_mode":"other","landmark":"","area":"Sector 128","phone":"9915347759","pincode":400072,"state_code":"MH","email":"regrowth@gofynd.com","address_type":"home","name":"abc","address_id":1145,"address":"Megatron3","store_name":"store123"}}}},"responses":{"201":{"description":"Success. Returns the address ID and a message indicating a successful address updation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAddressResponse"},"example":{"is_updated":true,"id":"<mongo_object_id>","is_default_address":true,"success":true}}}},"400":{"description":"Invalid User error","content":{"application/json":{"schema":{"type":"object","properties":{"is_valid":{"type":"boolean"},"message":{"type":"string"}}},"examples":{"Invalid User Id":{"value":{"is_valid":false,"message":"Please enter a valid application user id."}}}}}}}},"delete":{"summary":"removeAddress | Remove address associated with an account","description":"Use this API to delete an address by its ID. This will returns an object that will indicate whether the address was deleted successfully or not.","tags":["Cart"],"parameters":[{"schema":{"type":"string"},"description":"Current company id","in":"path","required":true,"name":"company_id"},{"schema":{"type":"string"},"description":"Current Application _id","in":"path","required":true,"name":"application_id"},{"name":"id","description":"ID allotted to the selected address","schema":{"type":"string"},"in":"path","required":true},{"name":"user_id","description":"Option to delete address for the provided user_id.","in":"query","schema":{"type":"string"}}],"responses":{"201":{"description":"Returns a Status object indicating the success or failure of address deletion.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteAddressResponse"},"example":{"id":"<mongo_object_id>","is_deleted":true}}}},"400":{"description":"Invalid User error","content":{"application/json":{"schema":{"type":"object","properties":{"is_valid":{"type":"boolean"},"message":{"type":"string"}}},"examples":{"Invalid User Id":{"value":{"is_valid":false,"message":"Please enter a valid application user id."}}}}}}}}},"/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/select-address":{"post":{"summary":"selectAddress | Select an address from available addresses","description":"Select Address from all addresses associated with the account in order to ship the cart items to that address, otherwise default address will be selected implicitly. See `PlatformSelectCartAddressRequest` in schema of request body for the list of attributes needed to select Address from account. On successful request, this API returns a Cart object. Below address attributes are required. address_id billing_address_id uid","tags":["Cart"],"parameters":[{"schema":{"type":"string"},"description":"Current company id","in":"path","required":true,"name":"company_id"},{"schema":{"type":"string"},"description":"Current Application _id","in":"path","required":true,"name":"application_id"},{"in":"query","name":"cart_id","schema":{"type":"string","description":"The unique identifier of the cart"}},{"in":"query","name":"buy_now","schema":{"type":"boolean","description":"This is boolean to get buy_now cart"}},{"in":"query","name":"i","schema":{"type":"boolean","description":"This is a boolean value. Select `true` to retrieve all the items added in the cart."}},{"in":"query","name":"b","schema":{"type":"boolean","description":"This is a boolean value. Select `true` to retrieve the price breakup of cart items."}}],"requestBody":{"description":"Pass address details in the request body as shown below or refer `PlatformSelectCartAddressRequest` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformSelectCartAddressRequest"},"example":{"id":"mongo_object_id","billing_address_id":"mongo_object_id","cart_id":"mongo_cart_object_id"}}}},"responses":{"201":{"description":"Success. Returns a Cart object as shown below. Refer `CartDetailResponse` for more details.  .","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CartDetailResponse"},"example":{"is_valid":true,"buy_now":false,"breakup_values":{"raw":{"cod_charge":0,"convenience_fee":0,"coupon":-2250,"delivery_charge":0,"discount":0,"fynd_cash":0,"gst_charges":315.86,"mrp_total":5198,"subtotal":5198,"total":2948,"vog":2632.15,"you_saved":0},"display":[{"display":"MRP Total","key":"mrp_total","value":5198,"currency_code":"INR"},{"display":"Subtotal","key":"subtotal","value":5198,"currency_code":"INR"},{"display":"Coupon","key":"coupon","value":-2250,"currency_code":"INR"},{"display":"Total","key":"total","value":2948,"currency_code":"INR"}],"coupon":{"type":"cash","code":"PRISMC22250111","uid":"17743","value":2250,"is_applied":true,"message":"coupn applied"},"loyalty_points":{"total":0,"applicable":0,"is_applied":false,"description":"Your cashback, referrals, and refund amount get credited to Fynd Cash which can be redeemed while placing an order."}},"items":[{"message":"","identifiers":{"identifier":"5mPyy88URXuh3Lo35uaTg"},"quantity":1,"availability":{"sizes":["M","S","L","XXL","XL"],"other_store_quantity":10,"out_of_stock":false,"deliverable":true,"is_valid":true},"coupon_message":"PRISMC22250111 coupon applied","price":{"base":{"add_on":3199,"marked":3199,"effective":3199,"selling":3199,"currency_code":"INR"},"converted":{"add_on":3199,"marked":3199,"effective":3199,"selling":3199,"currency_code":"INR"}},"bulk_offer":{},"article":{"type":"article","uid":"381_610_IGPL01_LETTER19APINK_S","size":"S","seller":{"uid":381,"name":"INTERSOURCE GARMENTS PVT LTD"},"store":{"uid":3009,"name":"Kormangala"},"quantity":11,"price":{"base":{"marked":3199,"effective":3199,"currency_code":"INR"},"converted":{"marked":3199,"effective":3199,"currency_code":"INR"}}},"product":{"type":"product","uid":857596,"name":"Pink Solid Hoodie","slug":"883-police-pink-solid-hoodie-857596-111bdc","brand":{"uid":610,"name":"883 Police"},"categories":[{"uid":144,"name":"Hoodies"}],"images":[{"aspect_ratio":"16:25","url":"http://cdn4.gofynd.com/media/pictures/tagged_items/original/610_LETTER19APINK/1_1553062658148.jpg","secure_url":"https://d2zv4gzhlr4ud6.cloudfront.net/media/pictures/tagged_items/original/610_LETTER19APINK/1_1553062658148.jpg"}],"action":{"type":"product","url":"https://api.addsale.com/platform/content/v1/products/883-police-pink-solid-hoodie-857596-111bdc/","query":{"product_slug":["883-police-pink-solid-hoodie-857596-111bdc"]}}},"key":"857596_S","discount":""},{"message":"","identifiers":{"identifier":"5mPyy88URXuh3Lo35uaTg"},"quantity":1,"availability":{"sizes":["L","XL","XXL"],"other_store_quantity":1,"out_of_stock":false,"deliverable":true,"is_valid":true},"coupon_message":"PRISMC22250111 coupon applied","price":{"base":{"add_on":1999,"marked":1999,"effective":1999,"selling":1999,"currency_code":"INR"},"converted":{"add_on":1999,"marked":1999,"effective":1999,"selling":1999,"currency_code":"INR"}},"bulk_offer":{},"article":{"type":"article","uid":"381_610_IGPL01_SPIRAL19ANAVY_L","size":"L","seller":{"uid":381,"name":"INTERSOURCE GARMENTS PVT LTD"},"store":{"uid":3009,"name":"Kormangala"},"quantity":2,"price":{"base":{"marked":1999,"effective":1999,"currency_code":"INR"},"converted":{"marked":1999,"effective":1999,"currency_code":"INR"}}},"product":{"type":"product","uid":820312,"name":"Navy Blue Melange Shorts","slug":"883-police-navy-blue-melange-shorts-820312-4943a8","brand":{"uid":610,"name":"883 Police"},"categories":[{"uid":193,"name":"Shorts"}],"images":[{"aspect_ratio":"16:25","url":"http://cdn4.gofynd.com/media/pictures/tagged_items/original/610_SPIRAL19ANAVY/1_1549105947281.jpg","secure_url":"https://d2zv4gzhlr4ud6.cloudfront.net/media/pictures/tagged_items/original/610_SPIRAL19ANAVY/1_1549105947281.jpg"}],"action":{"type":"product","url":"https://api.addsale.com/platform/content/v1/products/883-police-navy-blue-melange-shorts-820312-4943a8/","query":{"product_slug":["883-police-navy-blue-melange-shorts-820312-4943a8"]}}},"key":"820312_L","discount":""}],"delivery_charge_info":"","coupon_text":"View all offers","uid":"7477","gstin":"","checkout_mode":"self","last_modified":"2023-02-02T00:00:00.000Z","restrict_checkout":false}}}},"400":{"description":"User, Address or PIN code error","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string"},"message":{"type":"string"}}},"examples":{"Address Not Found":{"value":{"status":"ERROR","message":"ADDRESS_NOT_FOUND"}},"Pincode Not Serviciable":{"value":{"status":"ERROR","message":"PINCODE_NOT_SERVICIABLE"}},"Invalid User Id":{"value":{"status":"ERROR","message":"Please enter a valid application user id."}}}}}}}}},"/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/shipment":{"get":{"summary":"getShipments | Get delivery date and options before checkout","description":"Use this API to get shipment details, expected delivery date, items and price breakup of the shipment.","tags":["Cart"],"parameters":[{"schema":{"type":"string"},"description":"Current company id","in":"path","required":true,"name":"company_id"},{"schema":{"type":"string"},"description":"Current Application _id","in":"path","required":true,"name":"application_id"},{"in":"query","name":"pick_at_store_uid","required":false,"schema":{"type":"integer","description":"ID of the store from where the order will be picked up by the customer, assuming the order_type is `PickAtStore`. This may or may not be the same as the ID of the ordering store."}},{"in":"query","name":"ordering_store_id","required":false,"schema":{"type":"integer","description":"ID of the store where the customer is ordering from."}},{"name":"i","description":"This is a boolean value. Select `true` to retrieve all the items added in the cart.","in":"query","schema":{"type":"boolean"}},{"name":"p","description":"This is a boolean value. Select `true` for getting a payment option in response.","in":"query","schema":{"type":"boolean"}},{"name":"id","description":"The unique identifier of the cart","in":"query","schema":{"type":"string"}},{"name":"address_id","description":"ID allotted to the selected address","in":"query","schema":{"type":"string"}},{"name":"area_code","description":"The PIN Code of the destination address, e.g. 400059","in":"query","schema":{"type":"string"}},{"name":"order_type","description":"The order type of shipment HomeDelivery - If the customer wants the order home-delivered PickAtStore - If the customer wants the handover of an order at the store itself.","in":"query","schema":{"type":"string","enum":["HomeDelivery","PickAtStore"]}}],"responses":{"200":{"description":"Success. Returns delivery promise along with shipment details and price breakup. Refer `PlatformCartShipmentsResponse` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformCartShipmentsResponse"},"examples":{"Shipment Generated":{"value":{"items":[],"cart_id":7501,"uid":"7501","success":true,"error_message":"Note: Your order delivery will be delayed by 7-10 Days","payment_options":{"payment_option":[{"name":"COD","display_name":"Cash on Delivery","display_priority":1,"payment_mode_id":11,"logo":"https://d2co8r51m5ca2d.cloudfront.net/payments_assets/cod.png","logo_url":{"small":"https://d2co8r51m5ca2d.cloudfront.net/payments_assets/cod.png","large":"https://d2co8r51m5ca2d.cloudfront.net/payments_assets/cod.png"},"list":[]},{"name":"CARD","display_priority":2,"payment_mode_id":2,"display_name":"Card","list":[]},{"name":"NB","display_priority":3,"payment_mode_id":3,"display_name":"Net Banking","list":[{"aggregator_name":"Razorpay","bank_name":"ICICI Bank","bank_code":"ICIC","url":"https://d2co8r51m5ca2d.cloudfront.net/payments_assets/NB_ICICI.png","logo_url":{"small":"https://d2co8r51m5ca2d.cloudfront.net/payments_assets/NB_ICICI.png","large":"https://d2co8r51m5ca2d.cloudfront.net/payments_assets/NB_ICICI.png"},"merchant_code":"NB_ICICI","display_priority":1}]},{"name":"WL","display_priority":4,"payment_mode_id":4,"display_name":"Wallet","list":[{"wallet_name":"Paytm","wallet_code":"paytm","wallet_id":4,"merchant_code":"PAYTM","logo_url":{"small":"https://d2co8r51m5ca2d.cloudfront.net/payments_assets/paytm_logo_small.png","large":"https://d2co8r51m5ca2d.cloudfront.net/payments_assets/paytm_logo_large.png"},"aggregator_name":"Juspay","display_priority":1}]},{"name":"UPI","display_priority":9,"payment_mode_id":6,"display_name":"UPI","list":[{"aggregator_name":"UPI_Razorpay","name":"UPI","display_name":"BHIM UPI","code":"UPI","logo_url":{"small":"https://d2co8r51m5ca2d.cloudfront.net/payments_assets/upi_100x78.png","large":"https://d2co8r51m5ca2d.cloudfront.net/payments_assets/upi_150x100.png"},"merchant_code":"UPI","timeout":240,"retry_count":0,"fynd_vpa":"shopsense.rzp@hdfcbank","intent_flow":true,"intent_app_error_list":["com.csam.icici.bank.imobile","in.org.npci.upiapp","com.whatsapp"]}]},{"name":"PL","display_priority":11,"payment_mode_id":1,"display_name":"Pay Later","list":[{"aggregator_name":"Simpl","name":"Simpl","code":"simpl","merchant_code":"SIMPL","logo":"https://d2co8r51m5ca2d.cloudfront.net/payments_assets/simpl_logo.png","logo_url":{"small":"https://d2co8r51m5ca2d.cloudfront.net/payments_assets/simpl_logo.png","large":"https://d2co8r51m5ca2d.cloudfront.net/payments_assets/simpl_logo.png"}}]}],"payment_flows":{"Simpl":{"data":{"gateway":{"route":"simpl","entity":"sdk","is_customer_validation_required":true,"cust_validation_url":"https://api.addsale.com/gringotts/api/v1/validate-customer/","sdk":{"config":{"redirect":false,"callback_url":null,"action_url":"https://api.addsale.com/avis/api/v1/payments/charge-gringotts-transaction/"},"data":{"user_phone":"8452996729","user_email":"paymentsdummy@gofynd.com"}},"return_url":null}},"api_link":"","payment_flow":"sdk"},"Juspay":{"data":{},"api_link":"https://sandbox.juspay.in/txns","payment_flow":"api"},"Razorpay":{"data":{},"api_link":"","payment_flow":"sdk"},"UPI_Razorpay":{"data":{},"api_link":"https://api.addsale.com/gringotts/api/v1/external/payment-initialisation/","payment_flow":"api"},"Fynd":{"data":{},"api_link":"","payment_flow":"api"}},"default":{}},"user_type":"Store User","cod_charges":0,"order_id":null,"cod_available":true,"cod_message":"No additional COD charges applicable","delivery_charges":0,"delivery_charge_order_value":0,"delivery_slots":[{"date":"Sat, 24 Aug","delivery_slot":[{"delivery_slot_timing":"By 9:00 PM","default":true,"delivery_slot_id":1}]}],"store_code":"","store_emps":[],"breakup_values":{"loyalty_points":{"total":0,"applicable":0,"is_applied":false,"description":"Your cashback, referrals, and refund amount get credited to Fynd Cash which can be redeemed while placing an order."},"coupon":{"type":"cash","code":"","uid":"304_1054_9036_R1005753_7","value":0,"is_applied":false,"message":"Sorry! Invalid Coupon"},"raw":{"cod_charge":0,"convenience_fee":0,"coupon":0,"delivery_charge":0,"discount":0,"fynd_cash":0,"gst_charges":214.18,"mrp_total":1999,"subtotal":1999,"total":1999,"vog":1784.82,"you_saved":0},"display":[{"display":"MRP Total","key":"mrp_total","value":1999,"currency_code":"INR"},{"display":"Subtotal","key":"subtotal","value":1999,"currency_code":"INR"},{"display":"Total","key":"total","value":1999,"currency_code":"INR"}]},"shipments":[{"fulfillment_id":3009,"shipment_type":"single_shipment","fulfillment_type":"store","dp_id":"29","dp_options":{"4":{"f_priority":4,"r_priority":5,"is_cod":true,"is_prepaid":true,"is_reverse":true},"7":{"f_priority":3,"r_priority":4,"is_cod":true,"is_prepaid":true,"is_reverse":true},"29":{"f_priority":1,"r_priority":2,"is_cod":true,"is_prepaid":true,"is_reverse":true}},"promise":{"timestamp":{"min":1566678108,"max":1567023708},"formatted":{"min":"Aug 24","max":"Aug 28"},"iso":{"min":"2019-08-25T00:35:08.000Z","max":"2019-08-29T07:55:08.000Z"}},"box_type":"Small Courier bag","shipments":1,"items":[{"quantity":1,"identifiers":{"identifier":"5mPyy88URXuh3Lo35uaTg"},"product":{"type":"product","uid":820312,"name":"Navy Blue Melange Shorts","slug":"883-police-navy-blue-melange-shorts-820312-4943a8","brand":{"uid":610,"name":"883 Police"},"categories":[{"uid":193,"name":"Shorts"}],"images":[{"aspect_ratio":"16:25","url":"http://cdn4.gofynd.com/media/pictures/tagged_items/original/610_SPIRAL19ANAVY/1_1549105947281.jpg","secure_url":"https://d2zv4gzhlr4ud6.cloudfront.net/media/pictures/tagged_items/original/610_SPIRAL19ANAVY/1_1549105947281.jpg"}],"action":{"type":"product","url":"https://api.addsale.com/platform/content/v1/products/883-police-navy-blue-melange-shorts-820312-4943a8/","query":{"product_slug":["883-police-navy-blue-melange-shorts-820312-4943a8"]}}},"discount":"","bulk_offer":{},"key":"820312_L","price":{"base":{"add_on":1999,"marked":1999,"effective":1999,"selling":1999,"currency_code":"INR"},"converted":{"add_on":1999,"marked":1999,"effective":1999,"selling":1999,"currency_code":"INR"}},"article":{"type":"article","tags":[],"uid":"381_610_IGPL01_SPIRAL19ANAVY_L","size":"L","seller":{"uid":381,"name":"INTERSOURCE GARMENTS PVT LTD"},"store":{"uid":3009,"name":"Kormangala"},"quantity":2,"price":{"base":{"marked":1999,"effective":1999,"currency_code":"INR"},"converted":{"marked":1999,"effective":1999,"currency_code":"INR"}}},"availability":{"sizes":["L","XL","XXL"],"other_store_quantity":1,"out_of_stock":false,"deliverable":true,"is_valid":true},"coupon_message":"","message":""}]}],"delivery_charge_info":"","coupon_text":"View all offers","gstin":"","checkout_mode":"self","last_modified":"2023-03-03","restrict_checkout":false,"is_valid":true}},"Shipment Generation Failed":{"value":{"items":[],"cart_id":7501,"uid":"7501","success":true,"error_message":"Note: Your order delivery will be delayed by 7-10 Days","payment_options":{"payment_option":[{"name":"COD","display_name":"Cash on Delivery","display_priority":1,"payment_mode_id":11,"logo":"https://d2co8r51m5ca2d.cloudfront.net/payments_assets/cod.png","logo_url":{"small":"https://d2co8r51m5ca2d.cloudfront.net/payments_assets/cod.png","large":"https://d2co8r51m5ca2d.cloudfront.net/payments_assets/cod.png"},"list":[]},{"name":"CARD","display_priority":2,"payment_mode_id":2,"display_name":"Card","list":[]},{"name":"NB","display_priority":3,"payment_mode_id":3,"display_name":"Net Banking","list":[{"aggregator_name":"Razorpay","bank_name":"ICICI Bank","bank_code":"ICIC","url":"https://d2co8r51m5ca2d.cloudfront.net/payments_assets/NB_ICICI.png","logo_url":{"small":"https://d2co8r51m5ca2d.cloudfront.net/payments_assets/NB_ICICI.png","large":"https://d2co8r51m5ca2d.cloudfront.net/payments_assets/NB_ICICI.png"},"merchant_code":"NB_ICICI","display_priority":1}]},{"name":"WL","display_priority":4,"payment_mode_id":4,"display_name":"Wallet","list":[{"wallet_name":"Paytm","wallet_code":"paytm","wallet_id":4,"merchant_code":"PAYTM","logo_url":{"small":"https://d2co8r51m5ca2d.cloudfront.net/payments_assets/paytm_logo_small.png","large":"https://d2co8r51m5ca2d.cloudfront.net/payments_assets/paytm_logo_large.png"},"aggregator_name":"Juspay","display_priority":1}]},{"name":"UPI","display_priority":9,"payment_mode_id":6,"display_name":"UPI","list":[{"aggregator_name":"UPI_Razorpay","name":"UPI","display_name":"BHIM UPI","code":"UPI","logo_url":{"small":"https://d2co8r51m5ca2d.cloudfront.net/payments_assets/upi_100x78.png","large":"https://d2co8r51m5ca2d.cloudfront.net/payments_assets/upi_150x100.png"},"merchant_code":"UPI","timeout":240,"retry_count":0,"fynd_vpa":"shopsense.rzp@hdfcbank","intent_flow":true,"intent_app_error_list":["com.csam.icici.bank.imobile","in.org.npci.upiapp","com.whatsapp"]}]},{"name":"PL","display_priority":11,"payment_mode_id":1,"display_name":"Pay Later","list":[{"aggregator_name":"Simpl","name":"Simpl","code":"simpl","merchant_code":"SIMPL","logo":"https://d2co8r51m5ca2d.cloudfront.net/payments_assets/simpl_logo.png","logo_url":{"small":"https://d2co8r51m5ca2d.cloudfront.net/payments_assets/simpl_logo.png","large":"https://d2co8r51m5ca2d.cloudfront.net/payments_assets/simpl_logo.png"}}]}],"payment_flows":{"Simpl":{"data":{"gateway":{"route":"simpl","entity":"sdk","is_customer_validation_required":true,"cust_validation_url":"https://api.addsale.com/gringotts/api/v1/validate-customer/","sdk":{"config":{"redirect":false,"callback_url":null,"action_url":"https://api.addsale.com/avis/api/v1/payments/charge-gringotts-transaction/"},"data":{"user_phone":"8452996729","user_email":"paymentsdummy@gofynd.com"}},"return_url":null}},"api_link":"","payment_flow":"sdk"},"Juspay":{"data":{},"api_link":"https://sandbox.juspay.in/txns","payment_flow":"api"},"Razorpay":{"data":{},"api_link":"","payment_flow":"sdk"},"UPI_Razorpay":{"data":{},"api_link":"https://api.addsale.com/gringotts/api/v1/external/payment-initialisation/","payment_flow":"api"},"Fynd":{"data":{},"api_link":"","payment_flow":"api"}},"default":{}},"user_type":"Store User","cod_charges":0,"order_id":null,"cod_available":true,"cod_message":"No additional COD charges applicable","delivery_charges":0,"delivery_charge_order_value":0,"delivery_slots":[{"date":"Sat, 24 Aug","delivery_slot":[{"delivery_slot_timing":"By 9:00 PM","default":true,"delivery_slot_id":1}]}],"store_code":"","store_emps":[],"breakup_values":{"loyalty_points":{"total":0,"applicable":0,"is_applied":false,"description":"Your cashback, referrals, and refund amount get credited to Fynd Cash which can be redeemed while placing an order."},"coupon":{"type":"cash","code":"","uid":"304_1054_9036_R1005753_7","value":0,"is_applied":false,"message":"Sorry! Invalid Coupon"},"raw":{"cod_charge":0,"convenience_fee":0,"coupon":0,"delivery_charge":0,"discount":0,"fynd_cash":0,"gst_charges":214.18,"mrp_total":1999,"subtotal":1999,"total":1999,"vog":1784.82,"you_saved":0},"display":[{"display":"MRP Total","key":"mrp_total","value":1999,"currency_code":"INR"},{"display":"Subtotal","key":"subtotal","value":1999,"currency_code":"INR"},{"display":"Total","key":"total","value":1999,"currency_code":"INR"}]},"shipments":[],"message":"Shipments could not be generated. Please Try again after some time.","delivery_charge_info":"","coupon_text":"View all offers","gstin":"","checkout_mode":"self","last_modified":"2023-03-03","restrict_checkout":false,"is_valid":false}}}}}},"500":{"description":"Unhandled API error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}},"example":{"message":"oops! something went wrong."}}}}}},"put":{"summary":"updateShipments | Update shipment delivery type and quantity before checkout","description":"Use this API to update the delivery type and quantity as per customer's preference for either store pick-up or home-delivery.","tags":["Cart"],"parameters":[{"schema":{"type":"string"},"description":"Current company id","in":"path","required":true,"name":"company_id"},{"schema":{"type":"string"},"description":"Current Application _id","in":"path","required":true,"name":"application_id"},{"name":"i","description":"This is a boolean value. Select `true` to retrieve all the items added in the cart.","in":"query","schema":{"type":"boolean"}},{"name":"p","description":"This is a boolean value. Select `true` for getting a payment option in response.","in":"query","schema":{"type":"boolean"}},{"name":"id","description":"The unique identifier of the cart","in":"query","schema":{"type":"string"}},{"name":"address_id","description":"ID allotted to an address","in":"query","schema":{"type":"string"}},{"name":"area_code","description":"The PIN Code of the destination address, e.g. 400059","in":"query","schema":{"type":"string"}},{"name":"order_type","description":"The order type of shipment HomeDelivery - If the customer wants the order home-delivered PickAtStore - If the customer wants the handover of an order at the store itself.","in":"query","schema":{"type":"string"}}],"requestBody":{"description":"Pass quantity, article uid, shipment type of all items, in the request body as shown below.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCartShipmentRequest"},"example":{"shipments":[{"quantity":2,"article_uid":"5f8192fe40c13b0001876aff","shipment_type":"PickAtStore"},{"quantity":2,"article_uid":"5f8192fe40c13b00018768c2","shipment_type":"HomeDelivery"}]}}}},"responses":{"200":{"description":"Success. Returns delivery promise along with shipment details and price breakup. Refer `PlatformCartShipmentsResponse` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformCartShipmentsResponse"},"examples":{"Shipment Generated":{"value":{"items":[],"cart_id":7501,"uid":"7501","success":true,"error_message":"Note: Your order delivery will be delayed by 7-10 Days","payment_options":{"payment_option":[{"name":"COD","display_name":"Cash on Delivery","display_priority":1,"payment_mode_id":11,"logo":"https://d2co8r51m5ca2d.cloudfront.net/payments_assets/cod.png","logo_url":{"small":"https://d2co8r51m5ca2d.cloudfront.net/payments_assets/cod.png","large":"https://d2co8r51m5ca2d.cloudfront.net/payments_assets/cod.png"},"list":[]},{"name":"CARD","display_priority":2,"payment_mode_id":2,"display_name":"Card","list":[]},{"name":"NB","display_priority":3,"payment_mode_id":3,"display_name":"Net Banking","list":[{"aggregator_name":"Razorpay","bank_name":"ICICI Bank","bank_code":"ICIC","url":"https://d2co8r51m5ca2d.cloudfront.net/payments_assets/NB_ICICI.png","logo_url":{"small":"https://d2co8r51m5ca2d.cloudfront.net/payments_assets/NB_ICICI.png","large":"https://d2co8r51m5ca2d.cloudfront.net/payments_assets/NB_ICICI.png"},"merchant_code":"NB_ICICI","display_priority":1}]},{"name":"WL","display_priority":4,"payment_mode_id":4,"display_name":"Wallet","list":[{"wallet_name":"Paytm","wallet_code":"paytm","wallet_id":4,"merchant_code":"PAYTM","logo_url":{"small":"https://d2co8r51m5ca2d.cloudfront.net/payments_assets/paytm_logo_small.png","large":"https://d2co8r51m5ca2d.cloudfront.net/payments_assets/paytm_logo_large.png"},"aggregator_name":"Juspay","display_priority":1}]},{"name":"UPI","display_priority":9,"payment_mode_id":6,"display_name":"UPI","list":[{"aggregator_name":"UPI_Razorpay","name":"UPI","display_name":"BHIM UPI","code":"UPI","logo_url":{"small":"https://d2co8r51m5ca2d.cloudfront.net/payments_assets/upi_100x78.png","large":"https://d2co8r51m5ca2d.cloudfront.net/payments_assets/upi_150x100.png"},"merchant_code":"UPI","timeout":240,"retry_count":0,"fynd_vpa":"shopsense.rzp@hdfcbank","intent_flow":true,"intent_app_error_list":["com.csam.icici.bank.imobile","in.org.npci.upiapp","com.whatsapp"]}]},{"name":"PL","display_priority":11,"payment_mode_id":1,"display_name":"Pay Later","list":[{"aggregator_name":"Simpl","name":"Simpl","code":"simpl","merchant_code":"SIMPL","logo":"https://d2co8r51m5ca2d.cloudfront.net/payments_assets/simpl_logo.png","logo_url":{"small":"https://d2co8r51m5ca2d.cloudfront.net/payments_assets/simpl_logo.png","large":"https://d2co8r51m5ca2d.cloudfront.net/payments_assets/simpl_logo.png"}}]}],"payment_flows":{"Simpl":{"data":{"gateway":{"route":"simpl","entity":"sdk","is_customer_validation_required":true,"cust_validation_url":"https://api.addsale.com/gringotts/api/v1/validate-customer/","sdk":{"config":{"redirect":false,"callback_url":null,"action_url":"https://api.addsale.com/avis/api/v1/payments/charge-gringotts-transaction/"},"data":{"user_phone":"8452996729","user_email":"paymentsdummy@gofynd.com"}},"return_url":null}},"api_link":"","payment_flow":"sdk"},"Juspay":{"data":{},"api_link":"https://sandbox.juspay.in/txns","payment_flow":"api"},"Razorpay":{"data":{},"api_link":"","payment_flow":"sdk"},"UPI_Razorpay":{"data":{},"api_link":"https://api.addsale.com/gringotts/api/v1/external/payment-initialisation/","payment_flow":"api"},"Fynd":{"data":{},"api_link":"","payment_flow":"api"}},"default":{}},"user_type":"Store User","cod_charges":0,"order_id":null,"cod_available":true,"cod_message":"No additional COD charges applicable","delivery_charges":0,"delivery_charge_order_value":0,"delivery_slots":[{"date":"Sat, 24 Aug","delivery_slot":[{"delivery_slot_timing":"By 9:00 PM","default":true,"delivery_slot_id":1}]}],"store_code":"","store_emps":[],"breakup_values":{"loyalty_points":{"total":0,"applicable":0,"is_applied":false,"description":"Your cashback, referrals, and refund amount get credited to Fynd Cash which can be redeemed while placing an order."},"coupon":{"type":"cash","code":"","uid":"304_1054_9036_R1005753_6","value":0,"is_applied":false,"message":"Sorry! Invalid Coupon"},"raw":{"cod_charge":0,"convenience_fee":0,"coupon":0,"delivery_charge":0,"discount":0,"fynd_cash":0,"gst_charges":214.18,"mrp_total":1999,"subtotal":1999,"total":1999,"vog":1784.82,"you_saved":0},"display":[{"display":"MRP Total","key":"mrp_total","value":1999,"currency_code":"INR"},{"display":"Subtotal","key":"subtotal","value":1999,"currency_code":"INR"},{"display":"Total","key":"total","value":1999,"currency_code":"INR"}]},"shipments":[{"fulfillment_id":3009,"shipment_type":"single_shipment","fulfillment_type":"store","dp_id":"29","order_type":"PickAtStore","dp_options":{"4":{"f_priority":4,"r_priority":5,"is_cod":true,"is_prepaid":true,"is_reverse":true},"7":{"f_priority":3,"r_priority":4,"is_cod":true,"is_prepaid":true,"is_reverse":true},"29":{"f_priority":1,"r_priority":2,"is_cod":true,"is_prepaid":true,"is_reverse":true}},"promise":{"timestamp":{"min":1566678108,"max":1567023708},"formatted":{"min":"Aug 24","max":"Aug 28"},"iso":{"min":"2019-08-25T00:35:08.000Z","max":"2019-08-29T07:55:08.000Z"}},"box_type":"Small Courier bag","shipments":1,"items":[{"quantity":1,"identifiers":{"identifier":"5mPyy88URXuh3Lo35uaTg"},"product":{"type":"product","uid":820312,"name":"Navy Blue Melange Shorts","slug":"883-police-navy-blue-melange-shorts-820312-4943a8","brand":{"uid":610,"name":"883 Police"},"categories":[{"uid":193,"name":"Shorts"}],"images":[{"aspect_ratio":"16:25","url":"http://cdn4.gofynd.com/media/pictures/tagged_items/original/610_SPIRAL19ANAVY/1_1549105947281.jpg","secure_url":"https://d2zv4gzhlr4ud6.cloudfront.net/media/pictures/tagged_items/original/610_SPIRAL19ANAVY/1_1549105947281.jpg"}],"action":{"type":"product","url":"https://api.addsale.com/platform/content/v1/products/883-police-navy-blue-melange-shorts-820312-4943a8/","query":{"product_slug":["883-police-navy-blue-melange-shorts-820312-4943a8"]}}},"discount":"","bulk_offer":{},"key":"820312_L","price":{"base":{"add_on":1999,"marked":1999,"effective":1999,"selling":1999,"currency_code":"INR"},"converted":{"add_on":1999,"marked":1999,"effective":1999,"selling":1999,"currency_code":"INR"}},"article":{"type":"article","uid":"381_610_IGPL01_SPIRAL19ANAVY_L","size":"L","seller":{"uid":381,"name":"INTERSOURCE GARMENTS PVT LTD"},"store":{"uid":3009,"name":"Kormangala"},"quantity":2,"price":{"base":{"marked":1999,"effective":1999,"currency_code":"INR"},"converted":{"marked":1999,"effective":1999,"currency_code":"INR"}}},"availability":{"sizes":["L","XL","XXL"],"other_store_quantity":1,"out_of_stock":false,"deliverable":true,"is_valid":true},"coupon_message":"","message":""}]}],"delivery_charge_info":"","coupon_text":"View all offers","gstin":"","checkout_mode":"self","last_modified":"2023-03-03","restrict_checkout":false,"is_valid":true}},"Shipment Generation Failed":{"value":{"items":[],"cart_id":7501,"uid":"7501","success":true,"error_message":"Note: Your order delivery will be delayed by 7-10 Days","payment_options":{"payment_option":[{"name":"COD","display_name":"Cash on Delivery","display_priority":1,"payment_mode_id":11,"logo":"https://d2co8r51m5ca2d.cloudfront.net/payments_assets/cod.png","logo_url":{"small":"https://d2co8r51m5ca2d.cloudfront.net/payments_assets/cod.png","large":"https://d2co8r51m5ca2d.cloudfront.net/payments_assets/cod.png"},"list":[]},{"name":"CARD","display_priority":2,"payment_mode_id":2,"display_name":"Card","list":[]},{"name":"NB","display_priority":3,"payment_mode_id":3,"display_name":"Net Banking","list":[{"aggregator_name":"Razorpay","bank_name":"ICICI Bank","bank_code":"ICIC","url":"https://d2co8r51m5ca2d.cloudfront.net/payments_assets/NB_ICICI.png","logo_url":{"small":"https://d2co8r51m5ca2d.cloudfront.net/payments_assets/NB_ICICI.png","large":"https://d2co8r51m5ca2d.cloudfront.net/payments_assets/NB_ICICI.png"},"merchant_code":"NB_ICICI","display_priority":1}]},{"name":"WL","display_priority":4,"payment_mode_id":4,"display_name":"Wallet","list":[{"wallet_name":"Paytm","wallet_code":"paytm","wallet_id":4,"merchant_code":"PAYTM","logo_url":{"small":"https://d2co8r51m5ca2d.cloudfront.net/payments_assets/paytm_logo_small.png","large":"https://d2co8r51m5ca2d.cloudfront.net/payments_assets/paytm_logo_large.png"},"aggregator_name":"Juspay","display_priority":1}]},{"name":"UPI","display_priority":9,"payment_mode_id":6,"display_name":"UPI","list":[{"aggregator_name":"UPI_Razorpay","name":"UPI","display_name":"BHIM UPI","code":"UPI","logo_url":{"small":"https://d2co8r51m5ca2d.cloudfront.net/payments_assets/upi_100x78.png","large":"https://d2co8r51m5ca2d.cloudfront.net/payments_assets/upi_150x100.png"},"merchant_code":"UPI","timeout":240,"retry_count":0,"fynd_vpa":"shopsense.rzp@hdfcbank","intent_flow":true,"intent_app_error_list":["com.csam.icici.bank.imobile","in.org.npci.upiapp","com.whatsapp"]}]},{"name":"PL","display_priority":11,"payment_mode_id":1,"display_name":"Pay Later","list":[{"aggregator_name":"Simpl","name":"Simpl","code":"simpl","merchant_code":"SIMPL","logo":"https://d2co8r51m5ca2d.cloudfront.net/payments_assets/simpl_logo.png","logo_url":{"small":"https://d2co8r51m5ca2d.cloudfront.net/payments_assets/simpl_logo.png","large":"https://d2co8r51m5ca2d.cloudfront.net/payments_assets/simpl_logo.png"}}]}],"payment_flows":{"Simpl":{"data":{"gateway":{"route":"simpl","entity":"sdk","is_customer_validation_required":true,"cust_validation_url":"https://api.addsale.com/gringotts/api/v1/validate-customer/","sdk":{"config":{"redirect":false,"callback_url":null,"action_url":"https://api.addsale.com/avis/api/v1/payments/charge-gringotts-transaction/"},"data":{"user_phone":"8452996729","user_email":"paymentsdummy@gofynd.com"}},"return_url":null}},"api_link":"","payment_flow":"sdk"},"Juspay":{"data":{},"api_link":"https://sandbox.juspay.in/txns","payment_flow":"api"},"Razorpay":{"data":{},"api_link":"","payment_flow":"sdk"},"UPI_Razorpay":{"data":{},"api_link":"https://api.addsale.com/gringotts/api/v1/external/payment-initialisation/","payment_flow":"api"},"Fynd":{"data":{},"api_link":"","payment_flow":"api"}},"default":{}},"user_type":"Store User","cod_charges":0,"order_id":null,"cod_available":true,"cod_message":"No additional COD charges applicable","delivery_charges":0,"delivery_charge_order_value":0,"delivery_slots":[{"date":"Sat, 24 Aug","delivery_slot":[{"delivery_slot_timing":"By 9:00 PM","default":true,"delivery_slot_id":1}]}],"store_code":"","store_emps":[],"breakup_values":{"loyalty_points":{"total":0,"applicable":0,"is_applied":false,"description":"Your cashback, referrals, and refund amount get credited to Fynd Cash which can be redeemed while placing an order."},"coupon":{"type":"cash","code":"","uid":"304_1054_9036_R1005753_6","value":0,"is_applied":false,"message":"Sorry! Invalid Coupon"},"raw":{"cod_charge":0,"convenience_fee":0,"coupon":0,"delivery_charge":0,"discount":0,"fynd_cash":0,"gst_charges":214.18,"mrp_total":1999,"subtotal":1999,"total":1999,"vog":1784.82,"you_saved":0},"display":[{"display":"MRP Total","key":"mrp_total","value":1999,"currency_code":"INR"},{"display":"Subtotal","key":"subtotal","value":1999,"currency_code":"INR"},{"display":"Total","key":"total","value":1999,"currency_code":"INR"}]},"shipments":[],"message":"Shipments could not be generated. Please Try again after some time.","delivery_charge_info":"","coupon_text":"View all offers","gstin":"","checkout_mode":"self","last_modified":"2023-03-03","restrict_checkout":false,"is_valid":false}}}}}},"500":{"description":"Unhandled API error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}},"example":{"message":"oops! something went wrong."}}}}}}},"/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/meta":{"put":{"summary":"updateCartMeta | Update the cart meta for platform pos user","description":"Use this API to update cart meta like checkout_mode and gstin.","tags":["Cart"],"parameters":[{"schema":{"type":"string"},"description":"Current company id","in":"path","required":true,"name":"company_id"},{"schema":{"type":"string"},"description":"Current Application _id","in":"path","required":true,"name":"application_id"},{"in":"query","name":"id","schema":{"type":"string","description":"The unique identifier of the cart"}},{"in":"query","name":"buy_now","schema":{"type":"boolean","description":"this is boolean to get buy_now cart"}}],"requestBody":{"description":"gstin:Pass gstin number to claim GST credit, e.g. 27AAPFU0939F1ZV checkout_mode:Pass checkout mode for current order as described below. self:Customer him self placing order staff:Placing order on behalf of customer comment:Set comments to be passed to order team during adding items, e.g. leave the package with my neighbour.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformCartMetaRequest"},"example":{"checkout_mode":"self","gstin":"27AAPFU0939F1ZV","comment":"Leave it with neighbour","pan_no":"AAPFU0939F","gift_details":{"63c52cf23b300449784fdf4d":{"is_gift_applied":true,"gift_message":""}}}}}},"responses":{"200":{"description":"Returns a message indicating the success of cart meta updation as shown below.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CartMetaResponse"},"example":{"message":"cart meta updated"}}}},"400":{"description":"Missing required Field","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CartMetaMissingResponse"},"example":{"errors":["Field may not be null."]}}}}}}},"/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/checkout":{"post":{"summary":"platformCheckoutCart | Checkout all items in the cart","description":"Use this API to checkout all items in the cart for payment and order generation. For COD, order will be generated directly, whereas for other checkout modes, user will be redirected to a payment gateway.","tags":["Cart"],"parameters":[{"schema":{"type":"string"},"description":"Current company id","in":"path","required":true,"name":"company_id"},{"schema":{"type":"string"},"description":"Current Application _id","in":"path","required":true,"name":"application_id"},{"in":"query","name":"id","required":false,"schema":{"type":"string","description":"The unique identifier of the cart"}}],"requestBody":{"description":"Check the example shown below or refer `PlatformCartCheckoutDetailRequest` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformCartCheckoutDetailRequest"},"example":{"order_type":"PickAtStore","id":"63e213d45e4206d94485935f","user_id":"63e1f960e2059ce5138cae87","address_id":"8b526f521bb14a2593a8b9e3ce8c76b3","billing_address_id":"8b526f521bb14a2593a8b9e3ce8c76b3","delivery_slot_id":1,"aggregator":"Razorpay","merchant_code":"NB_ICICI","payment_identifier":"ICIC","payment_mode":"NB","customer_details":{"name":"Customer Name","mobile":"9876543210","email":"example@mail.com"}}}}},"responses":{"200":{"description":"Success. Returns the status of cart checkout. Refer `CartCheckoutResponse` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CartCheckoutResponse"},"examples":{"Address id not found":{"value":{"success":false,"message":"No address found with address id {address_id}"}},"Missing address_id":{"value":{"address_id":["Missing data for required field."]}},"Successful checkout cod payment":{"value":{"success":true,"cart":{"success":true,"error_message":"Note: Your order delivery will be delayed by 7-10 Days","payment_options":{"payment_option":[{"name":"COD","display_name":"Cash on Delivery","display_priority":1,"payment_mode_id":11,"logo":"https://d2co8r51m5ca2d.cloudfront.net/payments_assets/cod.png","logo_url":{"small":"https://d2co8r51m5ca2d.cloudfront.net/payments_assets/cod.png","large":"https://d2co8r51m5ca2d.cloudfront.net/payments_assets/cod.png"},"list":[]},{"name":"CARD","display_priority":2,"payment_mode_id":2,"display_name":"Card","list":[]},{"name":"NB","display_priority":3,"payment_mode_id":3,"display_name":"Net Banking","list":[{"aggregator_name":"Razorpay","bank_name":"ICICI Bank","bank_code":"ICIC","url":"https://d2co8r51m5ca2d.cloudfront.net/payments_assets/NB_ICICI.png","logo_url":{"small":"https://d2co8r51m5ca2d.cloudfront.net/payments_assets/NB_ICICI.png","large":"https://d2co8r51m5ca2d.cloudfront.net/payments_assets/NB_ICICI.png"},"merchant_code":"NB_ICICI","display_priority":1}]},{"name":"WL","display_priority":4,"payment_mode_id":4,"display_name":"Wallet","list":[{"wallet_name":"Paytm","wallet_code":"paytm","wallet_id":4,"merchant_code":"PAYTM","logo_url":{"small":"https://d2co8r51m5ca2d.cloudfront.net/payments_assets/paytm_logo_small.png","large":"https://d2co8r51m5ca2d.cloudfront.net/payments_assets/paytm_logo_large.png"},"aggregator_name":"Juspay","display_priority":1}]},{"name":"UPI","display_priority":9,"payment_mode_id":6,"display_name":"UPI","list":[{"aggregator_name":"UPI_Razorpay","name":"UPI","display_name":"BHIM UPI","code":"UPI","logo_url":{"small":"https://d2co8r51m5ca2d.cloudfront.net/payments_assets/upi_100x78.png","large":"https://d2co8r51m5ca2d.cloudfront.net/payments_assets/upi_150x100.png"},"merchant_code":"UPI","timeout":240,"retry_count":0,"fynd_vpa":"shopsense.rzp@hdfcbank","intent_flow":true,"intent_app_error_list":["com.csam.icici.bank.imobile","in.org.npci.upiapp","com.whatsapp"]}]},{"name":"PL","display_priority":11,"payment_mode_id":1,"display_name":"Pay Later","list":[{"aggregator_name":"Simpl","name":"Simpl","code":"simpl","merchant_code":"SIMPL","logo":"https://d2co8r51m5ca2d.cloudfront.net/payments_assets/simpl_logo.png","logo_url":{"small":"https://d2co8r51m5ca2d.cloudfront.net/payments_assets/simpl_logo.png","large":"https://d2co8r51m5ca2d.cloudfront.net/payments_assets/simpl_logo.png"}}]}],"payment_flows":{"Simpl":{"data":{"gateway":{"route":"simpl","entity":"sdk","is_customer_validation_required":true,"cust_validation_url":"https://api.addsale.com/gringotts/api/v1/validate-customer/","sdk":{"config":{"redirect":false,"callback_url":null,"action_url":"https://api.addsale.com/avis/api/v1/payments/charge-gringotts-transaction/"},"data":{"user_phone":"8452996729","user_email":"paymentsdummy@gofynd.com"}},"return_url":null}},"api_link":"","payment_flow":"sdk"},"Juspay":{"data":{},"api_link":"https://sandbox.juspay.in/txns","payment_flow":"api"},"Razorpay":{"data":{},"api_link":"","payment_flow":"sdk"},"UPI_Razorpay":{"data":{},"api_link":"https://api.addsale.com/gringotts/api/v1/external/payment-initialisation/","payment_flow":"api"},"Fynd":{"data":{},"api_link":"","payment_flow":"api"}},"default":{}},"user_type":"Store User","cod_charges":0,"order_id":"FY5D5E215CF287584CE6","cod_available":true,"cod_message":"No additional COD charges applicable","delivery_charges":0,"delivery_charge_order_value":0,"delivery_slots":[{"date":"Sat, 24 Aug","delivery_slot":[{"delivery_slot_timing":"By 9:00 PM","default":true,"delivery_slot_id":1}]}],"store_code":"","store_emps":[],"breakup_values":{"coupon":{"type":"cash","code":"","uid":"","value":0,"is_applied":false,"message":"Sorry! Invalid Coupon"},"loyalty_points":{"total":0,"applicable":0,"is_applied":false,"description":"Your cashback, referrals, and refund amount get credited to Fynd Cash which can be redeemed while placing an order."},"raw":{"cod_charge":0,"convenience_fee":0,"coupon":0,"delivery_charge":0,"discount":0,"fynd_cash":0,"gst_charges":214.18,"mrp_total":1999,"subtotal":1999,"total":1999,"vog":1784.82,"you_saved":0},"display":[{"display":"MRP Total","key":"mrp_total","value":1999,"currency_code":"INR"},{"display":"Subtotal","key":"subtotal","value":1999,"currency_code":"INR"},{"display":"Total","key":"total","value":1999,"currency_code":"INR"}]},"items":[{"key":"820312_L","identifiers":{"identifier":"5mPyy88URXuh3Lo35uaTg"},"message":"","bulk_offer":{},"price":{"base":{"add_on":1999,"marked":1999,"effective":1999,"selling":1999,"currency_code":"INR"},"converted":{"add_on":1999,"marked":1999,"effective":1999,"selling":1999,"currency_code":"INR"}},"quantity":1,"discount":"","product":{"type":"product","uid":820312,"name":"Navy Blue Melange Shorts","slug":"883-police-navy-blue-melange-shorts-820312-4943a8","brand":{"uid":610,"name":"883 Police"},"categories":[{"uid":193,"name":"Shorts"}],"images":[{"aspect_ratio":"16:25","url":"http://cdn4.gofynd.com/media/pictures/tagged_items/original/610_SPIRAL19ANAVY/1_1549105947281.jpg","secure_url":"https://d2zv4gzhlr4ud6.cloudfront.net/media/pictures/tagged_items/original/610_SPIRAL19ANAVY/1_1549105947281.jpg"}],"action":{"type":"product","url":"https://api.addsale.com/platform/content/v1/products/883-police-navy-blue-melange-shorts-820312-4943a8/","query":{"product_slug":["883-police-navy-blue-melange-shorts-820312-4943a8"]}}},"article":{"type":"article","uid":"381_610_IGPL01_SPIRAL19ANAVY_L","size":"L","seller":{"uid":381,"name":"INTERSOURCE GARMENTS PVT LTD"},"store":{"uid":3009,"name":"Kormangala"},"quantity":2,"price":{"base":{"marked":1999,"effective":1999,"currency_code":"INR"},"converted":{"marked":1999,"effective":1999,"currency_code":"INR"}}},"coupon_message":"","availability":{"sizes":["L","XL","XXL"],"other_store_quantity":1,"out_of_stock":false,"deliverable":true,"is_valid":true}}],"delivery_charge_info":"","coupon_text":"View all offers","cart_id":7483,"uid":"7483","gstin":"","checkout_mode":"self","last_modified":"2023-03-03T00:00:00.000Z","restrict_checkout":false,"is_valid":true},"callback_url":"https://api.addsale.com/gringotts/api/v1/external/payment-callback/","app_intercept_url":"http://uniket-testing.addsale.link/cart/order-status","message":"","data":{"order_id":"FY5D5E215CF287584CE6"},"order_id":"FY5D5E215CF287584CE6"}}}}}}}}},"/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/available-delivery-mode":{"get":{"summary":"getAvailableDeliveryModes | Get available delivery modes for cart","description":"Use this API to get the delivery modes (home-delivery/store-pickup) along with a list of pickup stores available for a given cart at a given PIN Code. User can then view the address of a pickup store with the help of store-address API.","tags":["Cart"],"parameters":[{"schema":{"type":"string"},"description":"Current company id","in":"path","required":true,"name":"company_id"},{"schema":{"type":"string"},"description":"Current Application _id","in":"path","required":true,"name":"application_id"},{"in":"query","name":"area_code","required":true,"schema":{"type":"string","description":"The PIN Code of the destination address, e.g. 400059"}},{"name":"id","in":"query","required":false,"schema":{"type":"string","description":"The unique identifier of the cart"}}],"responses":{"200":{"description":"Success. Returns the available delivery mode available for a given PIN Code, along with the UID of all the eligible pickup stores.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CartDeliveryModesResponse"},"example":{"available_modes":["HomeDelivery","PickAtStore"],"pickup_stores":[1]}}}}}}},"/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/store-address":{"get":{"summary":"getStoreAddressByUid | Get list of stores for give uids","description":"Use this API to get the store details by entering the unique identifier of the pickup stores shown in the response of available-delivery-mode API.","tags":["Cart"],"parameters":[{"schema":{"type":"string"},"description":"Current company id","in":"path","required":true,"name":"company_id"},{"schema":{"type":"string"},"description":"Current Application _id","in":"path","required":true,"name":"application_id"},{"in":"query","name":"store_uid","required":true,"schema":{"type":"integer","description":"The unique identifier of the store"}}],"responses":{"200":{"description":"Success. Returns available store information with its address as shown below.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreDetailsResponse"},"example":{"items":[{"name":"Tennille Urse","phone":"9819716565","email":"rehman@cashkart.com","address_type":"store","address":"NO","area":"","pincode":400072,"area_code":"400072","area_code_slug":"pincode","landmark":"","country":"INDIA","city":"MUMBAI","state":"MAHA","store_code":"6462b3cd-9d64-4da9-a764-b0e6a52cf5e8","uid":20,"store_manager_name":"Salma","geo_location":{"longitude":1,"latitude":1}}]}}}}}}},"/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/payment":{"put":{"summary":"selectPaymentMode | Update cart payment","description":"Use this API to update cart payment.","tags":["Cart"],"parameters":[{"schema":{"type":"string"},"description":"Current company id","in":"path","required":true,"name":"company_id"},{"schema":{"type":"string"},"description":"Current Application _id","in":"path","required":true,"name":"application_id"},{"in":"query","name":"id","schema":{"type":"string","description":"The unique identifier of the cart"}},{"in":"query","name":"buy_now","schema":{"type":"boolean","description":"This is boolean to get buy_now cart"}},{"in":"query","name":"order_type","description":"The order type of shipment HomeDelivery - If the customer wants the order home-delivered PickAtStore - If the customer wants the handover of an order at the store itself.","schema":{"type":"string","description":"This is boolean to get buy_now cart"}}],"requestBody":{"description":"Check the example shown below or refer `UpdateCartPaymentRequest` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCartPaymentRequest"},"example":{"payment_mode":"NB","payment_identifier":"ICIC","aggregator_name":"Razorpay","merchant_code":"NB_ICICI","address_id":"8b526f521bb14a2593a8b9e3ce8c76b3","id":"8b526f521bb14a2593a8b9e3ce8c76b3"}}}},"responses":{"200":{"description":"Success. Returns a Cart object as shown below. Refer `CartDetailResponse` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CartDetailResponse"},"example":{"success":true,"error_message":"Note: Your order delivery will be delayed by 7-10 Days","user_type":"Store User","cod_charges":0,"order_id":null,"cod_available":true,"cod_message":"No additional COD charges applicable","delivery_charges":0,"delivery_charge_order_value":0,"store_code":"","store_emps":[],"breakup_values":{"raw":{"cod_charge":0,"convenience_fee":0,"coupon":-2250,"delivery_charge":0,"discount":0,"fynd_cash":0,"gst_charges":315.86,"mrp_total":5198,"subtotal":5198,"total":2948,"vog":2632.15,"you_saved":0},"display":[{"display":"MRP Total","key":"mrp_total","value":5198,"currency_code":"INR"},{"display":"Subtotal","key":"subtotal","value":5198,"currency_code":"INR"},{"display":"Coupon","key":"coupon","value":-2250,"currency_code":"INR"},{"display":"Total","key":"total","value":2948,"currency_code":"INR"}],"coupon":{"type":"cash","code":"PRISMC22250111","uid":"17743","value":2250,"is_applied":true,"message":"coupn applied"},"loyalty_points":{"total":0,"applicable":0,"is_applied":false,"description":"Your cashback, referrals, and refund amount get credited to Fynd Cash which can be redeemed while placing an order."}},"items":[{"message":"","identifiers":{"identifier":"5mPyy88URXuh3Lo35uaTg"},"quantity":1,"availability":{"sizes":["M","S","L","XXL","XL"],"other_store_quantity":10,"out_of_stock":false,"deliverable":true,"is_valid":true},"coupon_message":"PRISMC22250111 coupon applied","price":{"base":{"add_on":3199,"marked":3199,"effective":3199,"selling":3199,"currency_code":"INR"},"converted":{"add_on":3199,"marked":3199,"effective":3199,"selling":3199,"currency_code":"INR"}},"bulk_offer":{},"article":{"type":"article","uid":"381_610_IGPL01_LETTER19APINK_S","size":"S","seller":{"uid":381,"name":"INTERSOURCE GARMENTS PVT LTD"},"store":{"uid":3009,"name":"Kormangala"},"quantity":11,"price":{"base":{"marked":3199,"effective":3199,"currency_code":"INR"},"converted":{"marked":3199,"effective":3199,"currency_code":"INR"}}},"product":{"type":"product","uid":857596,"name":"Pink Solid Hoodie","slug":"883-police-pink-solid-hoodie-857596-111bdc","brand":{"uid":610,"name":"883 Police"},"categories":[{"uid":144,"name":"Hoodies"}],"images":[{"aspect_ratio":"16:25","url":"http://cdn4.gofynd.com/media/pictures/tagged_items/original/610_LETTER19APINK/1_1553062658148.jpg","secure_url":"https://d2zv4gzhlr4ud6.cloudfront.net/media/pictures/tagged_items/original/610_LETTER19APINK/1_1553062658148.jpg"}],"action":{"type":"product","url":"https://api.addsale.com/platform/content/v1/products/883-police-pink-solid-hoodie-857596-111bdc/","query":{"product_slug":["883-police-pink-solid-hoodie-857596-111bdc"]}}},"key":"857596_S","discount":""},{"message":"","identifiers":{"identifier":"5mPyy88URXuh3Lo35uaTg"},"quantity":1,"availability":{"sizes":["L","XL","XXL"],"other_store_quantity":1,"out_of_stock":false,"deliverable":true,"is_valid":true},"coupon_message":"PRISMC22250111 coupon applied","price":{"base":{"add_on":1999,"marked":1999,"effective":1999,"selling":1999,"currency_code":"INR"},"converted":{"add_on":1999,"marked":1999,"effective":1999,"selling":1999,"currency_code":"INR"}},"bulk_offer":{},"article":{"type":"article","uid":"381_610_IGPL01_SPIRAL19ANAVY_L","size":"L","seller":{"uid":381,"name":"INTERSOURCE GARMENTS PVT LTD"},"store":{"uid":3009,"name":"Kormangala"},"quantity":2,"price":{"base":{"marked":1999,"effective":1999,"currency_code":"INR"},"converted":{"marked":1999,"effective":1999,"currency_code":"INR"}}},"product":{"type":"product","uid":820312,"name":"Navy Blue Melange Shorts","slug":"883-police-navy-blue-melange-shorts-820312-4943a8","brand":{"uid":610,"name":"883 Police"},"categories":[{"uid":193,"name":"Shorts"}],"images":[{"aspect_ratio":"16:25","url":"http://cdn4.gofynd.com/media/pictures/tagged_items/original/610_SPIRAL19ANAVY/1_1549105947281.jpg","secure_url":"https://d2zv4gzhlr4ud6.cloudfront.net/media/pictures/tagged_items/original/610_SPIRAL19ANAVY/1_1549105947281.jpg"}],"action":{"type":"product","url":"https://api.addsale.com/platform/content/v1/products/883-police-navy-blue-melange-shorts-820312-4943a8/","query":{"product_slug":["883-police-navy-blue-melange-shorts-820312-4943a8"]}}},"key":"820312_L","discount":""}],"delivery_charge_info":"","coupon_text":"View all offers","buy_now":false,"cart_id":7477,"uid":"7477","gstin":"","checkout_mode":"self","last_modified":"2023-02-02T00:00:00.000Z","restrict_checkout":false,"is_valid":true}}}}}}},"/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/payment/validate/":{"get":{"summary":"validateCouponForPayment | Verify the coupon eligibility against the payment mode","description":"Use this API to validate a coupon against the payment mode such as NetBanking, Wallet, UPI etc.","tags":["Cart"],"parameters":[{"schema":{"type":"string"},"description":"Current company id","in":"path","required":true,"name":"company_id"},{"schema":{"type":"string"},"description":"Current Application _id","in":"path","required":true,"name":"application_id"},{"in":"query","name":"id","schema":{"type":"string","description":"The unique identifier of the cart"}},{"in":"query","name":"buy_now","schema":{"type":"boolean","description":"This is boolean to get buy_now cart"}},{"in":"query","name":"address_id","schema":{"type":"string","description":"ID allotted to an address"}},{"in":"query","name":"payment_mode","schema":{"type":"string","description":"Payment mode selected by the customer"}},{"in":"query","name":"payment_identifier","schema":{"type":"string","description":"Identifier of payment like ICIC, PAYTM"}},{"in":"query","name":"aggregator_name","schema":{"type":"string","description":"Payment gateway identifier"}},{"in":"query","name":"merchant_code","schema":{"type":"string","description":"Identifier used by payment gateway for a given payment mode, e.g. NB_ICIC, PAYTM"}}],"responses":{"200":{"description":"Success. Returns a success message and the coupon validity. Refer `PaymentCouponValidate` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentCouponValidate"},"example":{"success":true,"message":"","coupon_validity":{"valid":true,"discount":499.5,"code":"testpayment","display_message_en":"","title":"Coupon value will change."}}}}}}}},"/service/platform/cart/v2.0/company/{company_id}/application/{application_id}/checkout":{"post":{"summary":"platformCheckoutCartV2 | Checkout all items in the cart","description":"Use this API to checkout all items in the cart for payment and order generation. For COD, order will be directly generated, whereas for other checkout modes, user will be redirected to a payment gateway.","tags":["Cart"],"parameters":[{"schema":{"type":"string"},"description":"Current company id","in":"path","required":true,"name":"company_id"},{"schema":{"type":"string"},"description":"Current Application _id","in":"path","required":true,"name":"application_id"},{"in":"query","name":"id","required":false,"schema":{"type":"string","description":"The unique identifier of the cart"}}],"requestBody":{"description":"Check the example shown below or refer `PlatformCartCheckoutDetailV2Request` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformCartCheckoutDetailV2Request"},"example":{"order_type":"PickAtStore","id":"63e213d45e4206d94485935f","user_id":"63e1f960e2059ce5138cae87","address_id":"8b526f521bb14a2593a8b9e3ce8c76b3","billing_address_id":"8b526f521bb14a2593a8b9e3ce8c76b3","delivery_slot_id":1,"payment_methods":[{"mode":"UDHARIWL","name":"UDHARI Wallet","amount":50000,"payment":"blocked","payment_meta":{"merchant_code":"UDHARIWL","payment_gateway":"UDHARIExtension","payment_identifier":"BNPLWL","type":"extension"}},{"mode":"JIOPG","payment_meta":{"merchant_code":"UDHARIWL","payment_gateway":"UDHARIExtension","payment_identifier":"BNPLWL","type":"extension"},"name":"JIOPG","payment":"required","meta":{"merchant_code":"JIOPG","payment_gateway":"Jio","payment_identifier":"JIOPG","type":"aggregator"}}]}}}},"responses":{"200":{"description":"Success. Returns the status of cart checkout. Refer `CartCheckoutResponseSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CartCheckoutResponse"},"examples":{"Address id not found":{"value":{"success":false,"message":"No address found with address id {address_id}"}},"Missing address_id":{"value":{"address_id":["Missing data for required field."]}},"Successful checkout cod payment":{"value":{"success":true,"cart":{"success":true,"error_message":"Note: Your order delivery will be delayed by 7-10 Days","payment_options":{"payment_option":[{"name":"COD","display_name":"Cash on Delivery","display_priority":1,"payment_mode_id":11,"logo":"https://d2co8r51m5ca2d.cloudfront.net/payments_assets/cod.png","logo_url":{"small":"https://d2co8r51m5ca2d.cloudfront.net/payments_assets/cod.png","large":"https://d2co8r51m5ca2d.cloudfront.net/payments_assets/cod.png"},"list":[]},{"name":"CARD","display_priority":2,"payment_mode_id":2,"display_name":"Card","list":[]},{"name":"NB","display_priority":3,"payment_mode_id":3,"display_name":"Net Banking","list":[{"aggregator_name":"Razorpay","bank_name":"ICICI Bank","bank_code":"ICIC","url":"https://d2co8r51m5ca2d.cloudfront.net/payments_assets/NB_ICICI.png","logo_url":{"small":"https://d2co8r51m5ca2d.cloudfront.net/payments_assets/NB_ICICI.png","large":"https://d2co8r51m5ca2d.cloudfront.net/payments_assets/NB_ICICI.png"},"merchant_code":"NB_ICICI","display_priority":1}]},{"name":"WL","display_priority":4,"payment_mode_id":4,"display_name":"Wallet","list":[{"wallet_name":"Paytm","wallet_code":"paytm","wallet_id":4,"merchant_code":"PAYTM","logo_url":{"small":"https://d2co8r51m5ca2d.cloudfront.net/payments_assets/paytm_logo_small.png","large":"https://d2co8r51m5ca2d.cloudfront.net/payments_assets/paytm_logo_large.png"},"aggregator_name":"Juspay","display_priority":1}]},{"name":"UPI","display_priority":9,"payment_mode_id":6,"display_name":"UPI","list":[{"aggregator_name":"UPI_Razorpay","name":"UPI","display_name":"BHIM UPI","code":"UPI","logo_url":{"small":"https://d2co8r51m5ca2d.cloudfront.net/payments_assets/upi_100x78.png","large":"https://d2co8r51m5ca2d.cloudfront.net/payments_assets/upi_150x100.png"},"merchant_code":"UPI","timeout":240,"retry_count":0,"fynd_vpa":"shopsense.rzp@hdfcbank","intent_flow":true,"intent_app_error_list":["com.csam.icici.bank.imobile","in.org.npci.upiapp","com.whatsapp"]}]},{"name":"PL","display_priority":11,"payment_mode_id":1,"display_name":"Pay Later","list":[{"aggregator_name":"Simpl","name":"Simpl","code":"simpl","merchant_code":"SIMPL","logo":"https://d2co8r51m5ca2d.cloudfront.net/payments_assets/simpl_logo.png","logo_url":{"small":"https://d2co8r51m5ca2d.cloudfront.net/payments_assets/simpl_logo.png","large":"https://d2co8r51m5ca2d.cloudfront.net/payments_assets/simpl_logo.png"}}]}],"payment_flows":{"Simpl":{"data":{"gateway":{"route":"simpl","entity":"sdk","is_customer_validation_required":true,"cust_validation_url":"https://api.addsale.com/gringotts/api/v1/validate-customer/","sdk":{"config":{"redirect":false,"callback_url":null,"action_url":"https://api.addsale.com/avis/api/v1/payments/charge-gringotts-transaction/"},"data":{"user_phone":"8452996729","user_email":"paymentsdummy@gofynd.com"}},"return_url":null}},"api_link":"","payment_flow":"sdk"},"Juspay":{"data":{},"api_link":"https://sandbox.juspay.in/txns","payment_flow":"api"},"Razorpay":{"data":{},"api_link":"","payment_flow":"sdk"},"UPI_Razorpay":{"data":{},"api_link":"https://api.addsale.com/gringotts/api/v1/external/payment-initialisation/","payment_flow":"api"},"Fynd":{"data":{},"api_link":"","payment_flow":"api"}},"default":{}},"user_type":"Store User","cod_charges":0,"order_id":"FY5D5E215CF287584CE6","cod_available":true,"cod_message":"No additional COD charges applicable","delivery_charges":0,"delivery_charge_order_value":0,"delivery_slots":[{"date":"Sat, 24 Aug","delivery_slot":[{"delivery_slot_timing":"By 9:00 PM","default":true,"delivery_slot_id":1}]}],"store_code":"","store_emps":[],"breakup_values":{"coupon":{"type":"cash","code":"","uid":"","value":0,"is_applied":false,"message":"Sorry! Invalid Coupon"},"loyalty_points":{"total":0,"applicable":0,"is_applied":false,"description":"Your cashback, referrals, and refund amount get credited to Fynd Cash which can be redeemed while placing an order."},"raw":{"cod_charge":0,"convenience_fee":0,"coupon":0,"delivery_charge":0,"discount":0,"fynd_cash":0,"gst_charges":214.18,"mrp_total":1999,"subtotal":1999,"total":1999,"vog":1784.82,"you_saved":0},"display":[{"display":"MRP Total","key":"mrp_total","value":1999,"currency_code":"INR"},{"display":"Subtotal","key":"subtotal","value":1999,"currency_code":"INR"},{"display":"Total","key":"total","value":1999,"currency_code":"INR"}]},"items":[{"key":"820312_L","identifiers":{"identifier":"5mPyy88URXuh3Lo35uaTg"},"message":"","bulk_offer":{},"price":{"base":{"add_on":1999,"marked":1999,"effective":1999,"selling":1999,"currency_code":"INR"},"converted":{"add_on":1999,"marked":1999,"effective":1999,"selling":1999,"currency_code":"INR"}},"quantity":1,"discount":"","product":{"type":"product","uid":820312,"name":"Navy Blue Melange Shorts","slug":"883-police-navy-blue-melange-shorts-820312-4943a8","brand":{"uid":610,"name":"883 Police"},"categories":[{"uid":193,"name":"Shorts"}],"images":[{"aspect_ratio":"16:25","url":"http://cdn4.gofynd.com/media/pictures/tagged_items/original/610_SPIRAL19ANAVY/1_1549105947281.jpg","secure_url":"https://d2zv4gzhlr4ud6.cloudfront.net/media/pictures/tagged_items/original/610_SPIRAL19ANAVY/1_1549105947281.jpg"}],"action":{"type":"product","url":"https://api.addsale.com/platform/content/v1/products/883-police-navy-blue-melange-shorts-820312-4943a8/","query":{"product_slug":["883-police-navy-blue-melange-shorts-820312-4943a8"]}}},"article":{"type":"article","uid":"381_610_IGPL01_SPIRAL19ANAVY_L","size":"L","seller":{"uid":381,"name":"INTERSOURCE GARMENTS PVT LTD"},"store":{"uid":3009,"name":"Kormangala"},"quantity":2,"price":{"base":{"marked":1999,"effective":1999,"currency_code":"INR"},"converted":{"marked":1999,"effective":1999,"currency_code":"INR"}}},"coupon_message":"","availability":{"sizes":["L","XL","XXL"],"other_store_quantity":1,"out_of_stock":false,"deliverable":true,"is_valid":true}}],"delivery_charge_info":"","coupon_text":"View all offers","cart_id":7483,"uid":"7483","gstin":"","checkout_mode":"self","last_modified":"2023-02-02T00:00:00.000Z","restrict_checkout":false,"is_valid":true},"callback_url":"https://api.addsale.com/gringotts/api/v1/external/payment-callback/","app_intercept_url":"http://uniket-testing.addsale.link/cart/order-status","message":"","data":{"order_id":"FY5D5E215CF287584CE6"},"order_id":"FY5D5E215CF287584CE6"}}}}}},"400":{"description":"Invalid payment method error","content":{"application/json":{"schema":{"type":"object","properties":{"is_valid":{"type":"boolean"},"message":{"type":"string"}}},"examples":{"Invalid Payment Method":{"value":{"is_valid":false,"message":"Please enter a valid payment amount."}}}}}}}}},"/service/platform/cart/v2.0/company/{company_id}/application/{application_id}/payment":{"put":{"summary":"selectPaymentModeV2 | Update cart payment","description":"Use this API to update cart payment.","tags":["Cart"],"parameters":[{"schema":{"type":"string"},"description":"Current company id","in":"path","required":true,"name":"company_id"},{"schema":{"type":"string"},"description":"Current Application _id","in":"path","required":true,"name":"application_id"},{"in":"query","name":"id","schema":{"type":"string","description":"The unique identifier of the cart"}},{"in":"query","name":"buy_now","schema":{"type":"boolean","description":"This is boolean to get buy_now cart"}},{"in":"query","name":"order_type","description":"The order type of shipment HomeDelivery - If the customer wants the order home-delivered PickAtStore - If the customer wants the handover of an order at the store itself.","schema":{"type":"string","description":"This is boolean to get buy_now cart"}}],"requestBody":{"description":"Check the example shown below or refer `UpdateCartPaymentRequestV2` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCartPaymentRequestV2"},"example":{"id":"6449021c177c336e338fb38b","address_id":"63e49dcd54c4c21b15909711","payment_methods":[{"name":"COD","payment":"required","mode":"COD","payment_meta":{"merchant_code":"COD","payment_identifier":"COD","type":"aggregator","payment_gateway":"Fynd"}},{"mode":"CREDIT_NOTE","name":"CREDIT_NOTE","payment":"blocked","amount":100,"payment_meta":{"merchant_code":"CREDIT_NOTE","payment_gateway":"DayTrader","payment_identifier":"CREDIT_NOTE","type":"Extension"}}]}}}},"responses":{"200":{"description":"Success. Returns a Cart object as shown below. Refer `CartDetailResponse` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CartDetailResponse"},"example":{"success":true,"error_message":"Note: Your order delivery will be delayed by 7-10 Days","user_type":"Store User","cod_charges":0,"order_id":null,"cod_available":true,"cod_message":"No additional COD charges applicable","delivery_charges":0,"delivery_charge_order_value":0,"store_code":"","store_emps":[],"breakup_values":{"raw":{"cod_charge":0,"convenience_fee":0,"coupon":-2250,"delivery_charge":0,"discount":0,"fynd_cash":0,"gst_charges":315.86,"mrp_total":5198,"subtotal":5198,"total":2948,"vog":2632.15,"you_saved":0},"display":[{"display":"MRP Total","key":"mrp_total","value":5198,"currency_code":"INR"},{"display":"Subtotal","key":"subtotal","value":5198,"currency_code":"INR"},{"display":"Coupon","key":"coupon","value":-2250,"currency_code":"INR"},{"display":"Total","key":"total","value":2948,"currency_code":"INR"}],"coupon":{"type":"cash","code":"PRISMC22250111","uid":"17743","value":2250,"is_applied":true,"message":"coupn applied"},"loyalty_points":{"total":0,"applicable":0,"is_applied":false,"description":"Your cashback, referrals, and refund amount get credited to Fynd Cash which can be redeemed while placing an order."}},"items":[{"message":"","identifiers":{"identifier":"5mPyy88URXuh3Lo35uaTg"},"quantity":1,"availability":{"sizes":["M","S","L","XXL","XL"],"other_store_quantity":10,"out_of_stock":false,"deliverable":true,"is_valid":true},"coupon_message":"PRISMC22250111 coupon applied","price":{"base":{"add_on":3199,"marked":3199,"effective":3199,"selling":3199,"currency_code":"INR"},"converted":{"add_on":3199,"marked":3199,"effective":3199,"selling":3199,"currency_code":"INR"}},"bulk_offer":{},"article":{"type":"article","uid":"381_610_IGPL01_LETTER19APINK_S","size":"S","seller":{"uid":381,"name":"INTERSOURCE GARMENTS PVT LTD"},"store":{"uid":3009,"name":"Kormangala"},"quantity":11,"price":{"base":{"marked":3199,"effective":3199,"currency_code":"INR"},"converted":{"marked":3199,"effective":3199,"currency_code":"INR"}}},"product":{"type":"product","uid":857596,"name":"Pink Solid Hoodie","slug":"883-police-pink-solid-hoodie-857596-111bdc","brand":{"uid":610,"name":"883 Police"},"categories":[{"uid":144,"name":"Hoodies"}],"images":[{"aspect_ratio":"16:25","url":"http://cdn4.gofynd.com/media/pictures/tagged_items/original/610_LETTER19APINK/1_1553062658148.jpg","secure_url":"https://d2zv4gzhlr4ud6.cloudfront.net/media/pictures/tagged_items/original/610_LETTER19APINK/1_1553062658148.jpg"}],"action":{"type":"product","url":"https://api.addsale.com/platform/content/v1/products/883-police-pink-solid-hoodie-857596-111bdc/","query":{"product_slug":["883-police-pink-solid-hoodie-857596-111bdc"]}}},"key":"857596_S","discount":""},{"message":"","identifiers":{"identifier":"5mPyy88URXuh3Lo35uaTg"},"quantity":1,"availability":{"sizes":["L","XL","XXL"],"other_store_quantity":1,"out_of_stock":false,"deliverable":true,"is_valid":true},"coupon_message":"PRISMC22250111 coupon applied","price":{"base":{"add_on":1999,"marked":1999,"effective":1999,"selling":1999,"currency_code":"INR"},"converted":{"add_on":1999,"marked":1999,"effective":1999,"selling":1999,"currency_code":"INR"}},"bulk_offer":{},"article":{"type":"article","uid":"381_610_IGPL01_SPIRAL19ANAVY_L","size":"L","seller":{"uid":381,"name":"INTERSOURCE GARMENTS PVT LTD"},"store":{"uid":3009,"name":"Kormangala"},"quantity":2,"price":{"base":{"marked":1999,"effective":1999,"currency_code":"INR"},"converted":{"marked":1999,"effective":1999,"currency_code":"INR"}}},"product":{"type":"product","uid":820312,"name":"Navy Blue Melange Shorts","slug":"883-police-navy-blue-melange-shorts-820312-4943a8","brand":{"uid":610,"name":"883 Police"},"categories":[{"uid":193,"name":"Shorts"}],"images":[{"aspect_ratio":"16:25","url":"http://cdn4.gofynd.com/media/pictures/tagged_items/original/610_SPIRAL19ANAVY/1_1549105947281.jpg","secure_url":"https://d2zv4gzhlr4ud6.cloudfront.net/media/pictures/tagged_items/original/610_SPIRAL19ANAVY/1_1549105947281.jpg"}],"action":{"type":"product","url":"https://api.addsale.com/platform/content/v1/products/883-police-navy-blue-melange-shorts-820312-4943a8/","query":{"product_slug":["883-police-navy-blue-melange-shorts-820312-4943a8"]}}},"key":"820312_L","discount":""}],"delivery_charge_info":"","coupon_text":"View all offers","buy_now":false,"cart_id":7477,"uid":"7477","gstin":"","checkout_mode":"self","last_modified":"2023-02-02T00:00:00.000Z","restrict_checkout":false,"is_valid":true}}}},"400":{"description":"Invalid payment method error","content":{"application/json":{"schema":{"type":"object","properties":{"is_valid":{"type":"boolean"},"message":{"type":"string"}}},"examples":{"Invalid Payment Method":{"value":{"is_valid":false,"message":"Please enter a valid payment amount."}}}}}}}}},"/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/analytics/insights/":{"get":{"description":"Catalog Insights api returns the count of catalog related data like products, brands, departments and categories that have been made live as per configuration of the app.","parameters":[{"description":"A `company_id` is a unique identifier for a particular seller account.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"A `application_id` is a unique identifier for a particular sale channel.","in":"path","name":"application_id","required":true,"schema":{"type":"string"}},{"description":"Brand slug","in":"query","name":"brand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"item":{"count":637707,"out_of_stock_count":452806,"sellable_count":184901}},"schema":{"$ref":"#/components/schemas/CatalogInsightResponse"}}},"description":"Response Data"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"getCatalogInsights | Analytics data of catalog and inventory.","tags":["Catalog"]}},"/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/brand":{"get":{"description":"A brand is the name under which a product is being sold. Use this API to list all the brands. You can pass optionally filter the brands by the department. If successful, returns a paginated list of brands specified in `BrandListingResponse`","parameters":[{"description":"A `company_id` is a unique identifier for a particular seller account.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"A `application_id` is a unique identifier for a particular sale channel.","in":"path","name":"application_id","required":true,"schema":{"type":"string"}},{"description":"The page number to navigate through the given set of results","in":"query","name":"page_no","required":false,"schema":{"type":"integer"}},{"description":"Number of items to retrieve in each page. Default is 12.","in":"query","name":"page_size","required":false,"schema":{"default":12,"type":"integer"}},{"description":"Search query with brand name.Use this parameter to search brands by  brand name.","in":"query","name":"q","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"items":[{"action":{"page":{"query":{"brand":["Hess-Inc"]},"type":"products"},"type":"page"},"banners":{"portrait":{"type":"image","url":"https://hdn-1.fynd.com/media/banner_portrait/brand/original/12537_9cdfc6835e814b0986ee1643d38cf6cd.png"}},"en_name":"Barry, Jennings and Larson","logo":{"type":"image","url":"https://hdn-1.fynd.com/media/logo/brand/original/12391_0d956c6c71a4427895c15e44cba82f88.jpg"},"name":"Barry, Jennings and Larson","slug":"Hess-Inc","uid":1}],"page":{"current":1,"has_next":false,"has_previous":false,"item_total":1,"total":1,"type":"number"}},"schema":{"$ref":"#/components/schemas/BrandListingResponse"}}},"description":"List of Brands. See example below or refer `BrandListingResponse` for details"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"getApplicationBrandListing | List all the brands for the application","tags":["Catalog"]}},"/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/brand/{brand_uid}":{"patch":{"description":"This API helps to update data associated to a item custom meta.","parameters":[{"description":"Id of the company associated to brand custom json.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"application id for which the custom_json is associated.","in":"path","name":"application_id","required":true,"schema":{"type":"string"}},{"description":"brand id for which the custom_json is associated.","in":"path","name":"brand_uid","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"_custom_json":{"sample_key1":"Sample Value 1","sample_key2":"Sample Value 2","sample_key3":"Sample Value 3"}},"schema":{"$ref":"#/components/schemas/ApplicationBrandJson"}}},"description":"custom json object that needs to be added.","required":true},"responses":{"200":{"content":{"application/json":{"example":{"success":true},"schema":{"$ref":"#/components/schemas/SuccessResponse1"}}},"description":"Returns a success response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"updateAppBrand | Update a single custom json.","tags":["Catalog"]}},"/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/brands":{"get":{"description":"A brand is the name under which a product is being sold. Use this API to list all the brands. You can pass optionally filter the brands by the department. If successful, returns a paginated list of brands specified in `BrandListingResponse`","parameters":[{"description":"A `company_id` is a unique identifier for a particular seller account.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"A `application_id` is a unique identifier for a particular sale channel.","in":"path","name":"application_id","required":true,"schema":{"type":"string"}},{"description":"The name of the department. Use this parameter to filter products by a particular department. See below the list of available departments. You can retrieve available departments from the **v1.0/departments/** API","in":"query","name":"department","required":false,"schema":{"enum":["baby-care-kids-essentials","beauty-personal-care","home-living","kids","men","others","toys","women"],"type":"string"}},{"description":"The page number to navigate through the given set of results","in":"query","name":"page_no","required":false,"schema":{"type":"integer"}},{"description":"Number of items to retrieve in each page. Default is 12.","in":"query","name":"page_size","required":false,"schema":{"default":12,"type":"integer"}},{"description":"Search query with brand name.Use this parameter to search brands by  brand name.","in":"query","name":"q","required":false,"schema":{"type":"string"}},{"description":"Helps to sort the brands list on the basis of uid list.","in":"query","name":"brand_id","required":false,"schema":{"items":{"type":"integer"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"example":{"items":[{"action":{"page":{"query":{"brand":["Hess-Inc"]},"type":"products"},"type":"page"},"banners":{"portrait":{"type":"image","url":"https://hdn-1.fynd.com/media/banner_portrait/brand/original/12537_9cdfc6835e814b0986ee1643d38cf6cd.png"}},"en_name":"Barry, Jennings and Larson","logo":{"type":"image","url":"https://hdn-1.fynd.com/media/logo/brand/original/12391_0d956c6c71a4427895c15e44cba82f88.jpg"},"name":"Barry, Jennings and Larson","slug":"Hess-Inc","uid":1}],"page":{"current":1,"has_next":false,"has_previous":false,"item_total":1,"total":1,"type":"number"}},"schema":{"$ref":"#/components/schemas/BrandListingResponse"}}},"description":"List of Brands. See example below or refer `BrandListingResponse` for details"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"getApplicationBrands | List all the brands","tags":["Catalog"]}},"/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/categories":{"get":{"description":"List all the categories. You can optionally pass filter the brands by the department. If successful, returns a paginated list of brands specified in `CategoryListingResponse`","parameters":[{"description":"A `company_id` is a unique identifier for a particular seller account.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"A `application_id` is a unique identifier for a particular sale channel.","in":"path","name":"application_id","required":true,"schema":{"type":"string"}},{"description":"The name of the department. Use this parameter to filter products by a particular department. See below the list of available departments. You can retrieve available departments from the **v1.0/departments/** API","in":"query","name":"department","required":false,"schema":{"enum":["baby-care-kids-essentials","beauty-personal-care","home-living","kids","men","others","toys","women"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"department":"Cody-Doyle","items":[{"_custom_json":{},"action":{"query":{"department":["Jaime-Chambers"],"l1_category":["Janet-Parker"]},"type":"category","url":"https://api.addsale.com/platform/content/v1/products/?l1_category=Janet-Parker&department=Jaime-Chambers"},"childs":[{"_custom_json":{},"action":{"query":{"department":["Jaime-Chambers"],"l2_category":["Hannah-Lawson"]},"type":"category","url":"https://api.addsale.com/platform/content/v1/products/?l2_category=Hannah-Lawson&department=Jaime-Chambers"},"childs":[{"_custom_json":{},"action":{"query":{"category":["Logan-Black"],"department":["Jaime-Chambers"]},"type":"category","url":"https://api.addsale.com/platform/content/v1/products/?category=Logan-Black&department=Jaime-Chambers"},"childs":[],"image":{"aspect_ratio":"13:20","aspect_ratio_f":0.65,"url":"https://d2zv4gzhlr4ud6.cloudfront.net/media/banner_portrait/category/resize-w:130,h:200/12064_e69e1d8b5e934d3488f0dc8663d8a158.jpg"},"name":"Logan Black","slug":"Logan-Black","uid":3}],"image":{"aspect_ratio":"13:20","aspect_ratio_f":0.65,"url":"https://d2zv4gzhlr4ud6.cloudfront.net/media/banner_portrait/category/resize-w:130,h:200/12064_e69e1d8b5e934d3488f0dc8663d8a158.jpg"},"name":"Hannah Lawson","slug":"Hannah-Lawson","uid":2}],"image":{"aspect_ratio":"13:20","aspect_ratio_f":0.65,"url":"https://d2zv4gzhlr4ud6.cloudfront.net/media/banner_portrait/category/resize-w:130,h:200/12064_e69e1d8b5e934d3488f0dc8663d8a158.jpg"},"name":"Janet Parker","slug":"Janet-Parker","uid":1}]}],"departments":[{"slug":"Cody-Doyle","uid":1}]},"schema":{"$ref":"#/components/schemas/CategoryListingResponse"}}},"description":"List of Categories. See example below or refer `CategoryListingResponse` for details."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"getCategories | List all the categories","tags":["Catalog"]}},"/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/category":{"get":{"description":"A brand is the name under which a product is being sold. Use this API to list all the brands. You can pass optionally filter the brands by the department. If successful, returns a paginated list of brands specified in `BrandListingResponse`","parameters":[{"description":"A `company_id` is a unique identifier for a particular seller account.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"A `application_id` is a unique identifier for a particular sale channel.","in":"path","name":"application_id","required":true,"schema":{"type":"string"}},{"description":"A `department_id` is a unique identifier for a particular department.","in":"query","name":"department_id","required":false,"schema":{"type":"integer"}},{"description":"The page number to navigate through the given set of results","in":"query","name":"page_no","required":false,"schema":{"type":"integer"}},{"description":"Number of items to retrieve in each page. Default is 12.","in":"query","name":"page_size","required":false,"schema":{"default":12,"type":"integer"}},{"description":"Search query with brand name.Use this parameter to search brands by  brand name.","in":"query","name":"q","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"items":[{"action":{"page":{"query":{"brand":["Hess-Inc"]},"type":"products"},"type":"page"},"banners":{"portrait":{"type":"image","url":"https://hdn-1.fynd.com/media/banner_portrait/brand/original/12537_9cdfc6835e814b0986ee1643d38cf6cd.png"}},"en_name":"Barry, Jennings and Larson","logo":{"type":"image","url":"https://hdn-1.fynd.com/media/logo/brand/original/12391_0d956c6c71a4427895c15e44cba82f88.jpg"},"name":"Barry, Jennings and Larson","slug":"Hess-Inc","uid":1}],"page":{"current":1,"has_next":false,"has_previous":false,"item_total":1,"total":1,"type":"number"}},"schema":{"$ref":"#/components/schemas/BrandListingResponse"}}},"description":"List of Brands. See example below or refer `BrandListingResponse` for details"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"getApplicationCategoryListing | List all the brands for the application","tags":["Catalog"]}},"/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/category/{category_uid}":{"patch":{"description":"This API helps to update data associated to a item custom meta.","parameters":[{"description":"Id of the company associated to category custom json.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"application id for which the custom_json is associated.","in":"path","name":"application_id","required":true,"schema":{"type":"string"}},{"description":"category id for which the custom_json is associated.","in":"path","name":"category_uid","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"_custom_json":{"sample_key_1":"Sample Value 1","sample_key_2":"Sample Value 2"}},"schema":{"$ref":"#/components/schemas/ApplicationCategoryJson"}}},"description":"custom json object that needs to be added.","required":true},"responses":{"200":{"content":{"application/json":{"example":{"success":true},"schema":{"$ref":"#/components/schemas/SuccessResponse1"}}},"description":"Returns a success response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"updateAppCategory | Update a single custom json.","tags":["Catalog"]}},"/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/collections/":{"get":{"description":"A Collection allows you to organize your products into hierarchical groups. For example, a dress might be in the category _Clothing_, the individual product might also be in the collection _Summer_. On successful request, returns all the collections as specified in `CollectionListingSchema`","parameters":[{"description":"A `company_id` is a unique identifier for a particular seller account.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"A `application_id` is a unique identifier for a particular sale channel.","in":"path","name":"application_id","required":true,"schema":{"type":"string"}},{"description":"Get collection list filtered by q string,","in":"query","name":"q","required":false,"schema":{"type":"string"}},{"description":"Get collection list filtered by scheduled status,","in":"query","name":"schedule_status","required":false,"schema":{"enum":["live","upcoming","expired"],"type":"string"}},{"description":"type of the collections","in":"query","name":"type","required":false,"schema":{"type":"string"}},{"description":"Each response will contain next_id param, which should be sent back to make pagination work.","in":"query","name":"tags","required":false,"schema":{"items":{"type":"string"},"type":"array"}},{"description":"get collections filtered by active status.","in":"query","name":"is_active","required":false,"schema":{"type":"boolean"}},{"description":"The page number to navigate through the given set of results.","in":"query","name":"page_no","required":false,"schema":{"type":"integer"}},{"description":"Number of items to retrieve in each page. Default is 12.","in":"query","name":"page_size","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"example":{"filters":{"tags":[{"display":"1+","is_selected":false,"name":"1+"},{"display":"aa","is_selected":false,"name":"aa"},{"display":"asd","is_selected":false,"name":"asd"},{"display":"dda","is_selected":false,"name":"dda"},{"display":"fahim","is_selected":false,"name":"fahim"},{"display":"gfg","is_selected":false,"name":"gfg"},{"display":"sakri","is_selected":false,"name":"sakri"},{"display":"sdsadas","is_selected":false,"name":"sdsadas"},{"display":"uuy","is_selected":false,"name":"uuy"}],"type":[{"display":"items","is_selected":false,"name":"items"},{"display":"query","is_selected":false,"name":"query"}]},"items":[{"_custom_json":{},"_locale_language":{},"_schedule":{"end":null,"next_schedule":[{"end":null,"start":"2021-03-04T15:35:13.640000Z"}],"start":"2021-03-04T15:35:13.640000Z"},"action":{"page":{"query":{"collection":["test1"]},"type":"collection"},"type":"page"},"allow_facets":true,"allow_sort":true,"badge":{"color":"#ffffff","text":""},"banners":{"landscape":{"type":"image","url":"https://hdn-1.addsale.com/x0/company/1/applications/000000000000000000000001/collections/pictures/landscape-banner/original/3jSEzw9CN-1601465376892.jpeg"},"portrait":{"type":"image","url":"https://hdn-1.addsale.com/x0/company/1/applications/000000000000000000000001/collections/pictures/portrait-banner/original/mP6OnINGR-1601466767814.jpeg"}},"description":"this is description","is_active":true,"logo":{"type":"image","url":"https://hdn-1.addsale.com/x0/company/1/applications/000000000000000000000001/collections/pictures/square-logo/original/y_-XUYXwx-1602326103322.jpeg"},"meta":{},"name":"test1","published":true,"query":[],"slug":"test1","sort_on":"price_asc","tags":[],"type":"query","uid":"6040fed076d8a500011ef829","visible_facets_keys":[]},{"_custom_json":{},"_locale_language":{},"_schedule":{"end":null,"next_schedule":[{"end":null,"start":"2021-03-04T09:33:53.686000Z"}],"start":"2021-03-04T09:33:53.686000Z"},"action":{"page":{"query":{"collection":["newapiplaform"]},"type":"collection"},"type":"page"},"allow_facets":true,"allow_sort":true,"badge":{"color":"#aa2727","text":""},"banners":{"landscape":{"type":"image","url":"https://res.cloudinary.com/dwzm9bysq/image/upload/v1588857999/production/applications/app_000000000000000000000001/media/collection/landscape/avm7xibo2jgk8glc4bwl.png"},"portrait":{"type":"image","url":"https://res.cloudinary.com/dwzm9bysq/image/upload/v1588858137/production/applications/app_000000000000000000000001/media/collection/portrait/xzuftshmmw4yuwzb12pm.png"}},"description":"sadasd","is_active":true,"logo":{"type":"image","url":"https://res.cloudinary.com/dwzm9bysq/image/upload/v1588857854/production/applications/app_000000000000000000000001/media/collection/logo/w9ns7nfgv7fk45xqrpoh.png"},"meta":{},"name":"newapiplaform","published":true,"query":[{"attribute":"catalogue","op":"in","value":[]}],"slug":"newapiplaform","sort_on":"popular","tags":["sdsadas","asd"],"type":"items","uid":"6040a9b250f97e0001886294","visible_facets_keys":[]},{"_custom_json":{},"_locale_language":{},"_schedule":{"end":null,"next_schedule":[{"end":null,"start":"2021-03-03T10:45:40.544000Z"}],"start":"2021-03-03T10:45:40.544000Z"},"action":{"page":{"query":{"collection":["old"]},"type":"collection"},"type":"page"},"allow_facets":true,"allow_sort":true,"badge":{"color":"#ffffff","text":""},"banners":{"landscape":{"type":"image","url":"https://res.cloudinary.com/dwzm9bysq/image/upload/v1588857999/production/applications/app_000000000000000000000001/media/collection/landscape/avm7xibo2jgk8glc4bwl.png"},"portrait":{"type":"image","url":"https://res.cloudinary.com/dwzm9bysq/image/upload/v1588858137/production/applications/app_000000000000000000000001/media/collection/portrait/xzuftshmmw4yuwzb12pm.png"}},"description":"","is_active":true,"logo":{"type":"image","url":"https://res.cloudinary.com/dwzm9bysq/image/upload/v1588857854/production/applications/app_000000000000000000000001/media/collection/logo/w9ns7nfgv7fk45xqrpoh.png"},"meta":{},"name":"new","published":true,"query":[],"slug":"old","sort_on":"popular","tags":[],"type":"query","uid":"603f68fd953a69000145dc92","visible_facets_keys":[]}],"page":{"current":1,"has_next":true,"has_previous":false,"item_total":190,"size":19,"type":"collection"}},"schema":{"$ref":"#/components/schemas/GetCollectionListingResponse"}}},"description":"List of collections. See example below or refer `GetCollectionListingResponse` for details"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"getAllCollections | List all the collections","tags":["Catalog"]},"post":{"description":"Create a collection. See `CreateCollectionRequestSchema` for the list of attributes needed to create a collection and collections/query-options for the available options to create a collection. On successful request, returns a paginated list of collections specified in `CollectionCreateResponse`","parameters":[{"description":"A `company_id` is a unique identifier for a particular seller account.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"A `application_id` is a unique identifier for a particular sale channel.","in":"path","name":"application_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCollection"}}},"description":"A Collection object that needs to be added","required":true},"responses":{"200":{"content":{"application/json":{"example":{"_custom_json":{},"_locale_language":{},"_schedule":{"end":null,"next_schedule":[{"end":null,"start":"2021-03-15T12:51:21.333000+00:00Z"}],"start":"2021-03-15T12:51:21.333000+00:00Z"},"action":{"page":{"query":{"collection":["new"]},"type":"collection"},"type":"page"},"allow_facets":true,"allow_sort":true,"badge":{"color":"#ffffff","text":""},"banners":{"landscape":{"type":"image","url":"https://res.cloudinary.com/dwzm9bysq/image/upload/v1588857999/production/applications/app_000000000000000000000001/media/collection/landscape/avm7xibo2jgk8glc4bwl.png"},"portrait":{"type":"image","url":"https://res.cloudinary.com/dwzm9bysq/image/upload/v1588858137/production/applications/app_000000000000000000000001/media/collection/portrait/xzuftshmmw4yuwzb12pm.png"}},"description":"","is_active":true,"logo":{"type":"image","url":"https://res.cloudinary.com/dwzm9bysq/image/upload/v1588857854/production/applications/app_000000000000000000000001/media/collection/logo/w9ns7nfgv7fk45xqrpoh.png"},"meta":{},"name":"New","published":true,"query":[],"seo":{"description":"Test description","title":"Test"},"slug":"new","sort_on":"depth_desc","tags":[],"type":"query","uid":"604f585a7051e30001173ac1","visible_facets_keys":[]},"schema":{"$ref":"#/components/schemas/CollectionCreateResponse"}}},"description":"List of all the collections including the one you added. See example below or refer `CollectionCreateResponse` for details"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"createCollection | Add a Collection","tags":["Catalog"]}},"/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/collections/query-options/":{"get":{"description":"Get query filters to configure a collection","parameters":[{"description":"A `company_id` is a unique identifier for a particular seller account.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"A `application_id` is a unique identifier for a particular sale channel.","in":"path","name":"application_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"filters":[{"key":{"display":"Department","kind":"multivalued","logo":"https://hdn-1.fynd.com/global/menu-icons/Department.png","name":"department"},"values":[{"count":2113,"display":"Men's Fashion","is_selected":false,"logo":{"type":"image","url":"https://hdn-1.fynd.com/media/category_tab_icons/department/Men.png"},"value":"men"}]},{"key":{"display":"Category","kind":"multivalued","logo":"https://hdn-1.fynd.com/global/menu-icons/Category.png","name":"category"},"values":[{"count":968,"display":"T-Shirts","is_selected":false,"logo":"https://hdn-1.fynd.com/media/logo/category/original/15442_57fdc97abfd248aaaf8841f097a4ed67.jpg","value":"192"}]},{"key":{"display":"Category L1","kind":"multivalued","logo":"https://hdn-1.fynd.com/global/menu-icons/Category.png","name":"category"},"values":[{"count":968,"display":"T-Shirts","is_selected":false,"logo":"https://hdn-1.fynd.com/media/logo/category/original/15442_57fdc97abfd248aaaf8841f097a4ed67.jpg","value":"192"}]},{"key":{"display":"Category L2","kind":"multivalued","logo":"https://hdn-1.fynd.com/global/menu-icons/Category.png","name":"category"},"values":[{"count":968,"display":"T-Shirts","is_selected":false,"logo":"https://hdn-1.fynd.com/media/logo/category/original/15442_57fdc97abfd248aaaf8841f097a4ed67.jpg","value":"192"}]},{"key":{"display":"Size","kind":"multivalued","logo":"https://hdn-1.fynd.com/global/menu-icons/Sizes.png","name":"sizes"},"values":[{"count":1438,"display":"S","is_selected":false,"value":"S"}]},{"key":{"display":"Brand","kind":"multivalued","logo":"https://hdn-1.fynd.com/global/menu-icons/Brand%20ID.png","name":"brand"},"values":[{"count":4263,"display":"Superdry","is_selected":false,"logo":"https://hdn-1.fynd.com/media/logo/brand/original/1008_238113b8e11448f792e9bf860aac30f2.jpg","value":"235"}]},{"key":{"display":"Rating","kind":"multivalued","logo":"https://hdn-1.fynd.com/global/menu-icons/Rating.png","name":"rating"},"values":[{"count":3,"display":"5 ★","is_selected":false,"value":"[4 TO *}"}]},{"key":{"display":"Company","kind":"multivalued","logo":"https://hdn-1.fynd.com/global/menu-icons/Store%20ID%20List.png","name":"company_id_list"},"values":[{"count":4262,"display":"RELIANCE BRANDS LIMITED","is_selected":false,"value":"46"}]},{"key":{"display":"Store Ids","kind":"multivalued","logo":"https://hdn-1.fynd.com/global/menu-icons/Store%20ID%20List.png","name":"store_id_list"},"values":[{"count":1385,"display":"PHOENIX, ,PALLADIUM,  LOWER PAREL - 5410","is_selected":false,"value":"2201"}]},{"key":{"display":"Image","kind":"multivalued","logo":"https://hdn-1.fynd.com/global/menu-icons/image%20Nature.png","name":"image_nature"},"values":[{"count":3111,"display":"Good Quality","is_selected":false,"value":"standard"},{"count":1152,"display":"No Image","is_selected":false,"value":"default"}]},{"key":{"display":"Set","kind":"multivalued","logo":"","name":"is_set"},"values":[{"count":4263,"display":"No","is_selected":false,"value":false}]},{"key":{"display":"Product Fit","kind":"multivalued","logo":"","name":"product_fit"},"values":[{"count":14,"display":"Regular","is_selected":false,"value":"Regular"}]},{"key":{"display":"Primary Material","kind":"multivalued","logo":"","name":"primary_material"},"values":[{"count":1246,"display":"Cotton","is_selected":false,"value":"Cotton"}]},{"key":{"display":"Gender","kind":"multivalued","logo":"","name":"gender"},"values":[{"count":2125,"display":"Men","is_selected":false,"value":"Men"},{"count":1492,"display":"Women","is_selected":false,"value":"Women"}]},{"key":{"display":"Primary Colour","kind":"multivalued","logo":"","name":"primary_color"},"values":[{"count":1403,"display":"Multi","is_selected":false,"value":"Multi"}]},{"key":{"display":"Size Depth","kind":"range","logo":"https://hdn-1.fynd.com/global/menu-icons/Size%20Depth.png","name":"size_depth"},"values":[{"count":4263,"display":"0 - 9","display_format":"{} - {}","is_selected":false,"max":9,"min":0,"query_format":"[{} TO {}]","selected_max":9,"selected_min":0}]},{"key":{"display":"Price","kind":"range","logo":"https://hdn-1.fynd.com/global/menu-icons/Min%20price%20effective.png","name":"min_price_effective"},"values":[{"count":4263,"currency_code":"INR","currency_symbol":"₹","is_selected":false,"max":24999,"min":398,"query_format":"[{},INR TO {},INR]","selected_max":24998.77,"selected_min":398.8}]},{"key":{"display":"Discount","kind":"range","logo":"https://hdn-1.fynd.com/global/menu-icons/Platform%20Discount.png","name":"platform_discount"},"values":[{"count":4263,"display":"0 - 50","display_format":"{} - {}","is_selected":false,"max":50,"min":0,"query_format":"[{} TO {}]","selected_max":50,"selected_min":0}]}],"sort_on":[{"display":"Latest Products","is_selected":true,"logo":"https://hdn-1.fynd.com/global/menu-icons/Latest%20Products.png","name":"Latest Products","value":"latest"},{"display":"Popularity","is_selected":false,"logo":"https://hdn-1.fynd.com/global/menu-icons/Popularity.png","name":"Popularity","value":"popular"},{"display":"Price Low to High","is_selected":false,"logo":"https://hdn-1.fynd.com/global/menu-icons/Price%20High%20to%20Low.png","name":"Price Low to High","value":"price_asc"},{"display":"Price High to Low","is_selected":false,"logo":"https://hdn-1.fynd.com/global/menu-icons/Price%20High%20to%20Low.png","name":"Price High to Low","value":"price_dsc"},{"display":"Discount Low to High","is_selected":false,"logo":"https://hdn-1.fynd.com/global/menu-icons/Discount%20Low%20to%20High.png","name":"Discount Low to High","value":"discount_asc"},{"display":"Discount High to Low","is_selected":false,"logo":"https://hdn-1.fynd.com/global/menu-icons/Discount%20Low%20to%20High.png","name":"Discount High to Low","value":"discount_dsc"},{"display":"Rating","is_selected":false,"logo":"https://hdn-1.fynd.com/global/menu-icons/Rating.png","name":"Rating","value":"rating_dsc"},{"display":"Size Depth (High to Low)","is_selected":false,"logo":"https://hdn-1.fynd.com/global/menu-icons/Size%20Depth.png","name":"Size Depth (High to Low)","value":"depth_desc"}]},"schema":{"$ref":"#/components/schemas/GetQueryFiltersResponse"}}},"description":"The attached items of an collection. See example below or refer `GetQueryFiltersResponse` for details"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"getQueryFilters | Get query filters to configure a collection","tags":["Catalog"]}},"/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/collections/{id}/":{"delete":{"description":"Delete a collection by it's id. Returns an object that tells whether the collection was deleted successfully","parameters":[{"description":"A `company_id` is a unique identifier for a particular seller account.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"A `application_id` is a unique identifier for a particular sale channel.","in":"path","name":"application_id","required":true,"schema":{"type":"string"}},{"description":"A `id` is a unique identifier of a collection.","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"message":"Collection Deleted"},"schema":{"$ref":"#/components/schemas/CommonResponseSchemaCollection"}}},"description":"Status object. Tells whether the operation was successful."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"deleteCollection | Delete a Collection","tags":["Catalog"]},"put":{"description":"Update a collection by it's id. On successful request, returns the updated collection","parameters":[{"description":"A `company_id` is a unique identifier for a particular seller account.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"A `application_id` is a unique identifier for a particular sale channel.","in":"path","name":"application_id","required":true,"schema":{"type":"string"}},{"description":"A `id` is a unique identifier of a collection.","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCollection"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"_custom_json":{},"_locale_language":{},"_schedule":{"end":null,"next_schedule":[{"end":null,"start":"2021-03-15T12:51:21.333000+00:00Z"}],"start":"2021-03-15T12:51:21.333000+00:00Z"},"action":{"page":{"query":{"collection":["new"]},"type":"collection"},"type":"page"},"allow_facets":true,"allow_sort":true,"badge":{"color":"#ffffff","text":""},"banners":{"landscape":{"type":"image","url":"https://res.cloudinary.com/dwzm9bysq/image/upload/v1588857999/production/applications/app_000000000000000000000001/media/collection/landscape/avm7xibo2jgk8glc4bwl.png"},"portrait":{"type":"image","url":"https://res.cloudinary.com/dwzm9bysq/image/upload/v1588858137/production/applications/app_000000000000000000000001/media/collection/portrait/xzuftshmmw4yuwzb12pm.png"}},"description":"","is_active":true,"logo":{"type":"image","url":"https://res.cloudinary.com/dwzm9bysq/image/upload/v1588857854/production/applications/app_000000000000000000000001/media/collection/logo/w9ns7nfgv7fk45xqrpoh.png"},"meta":{},"name":"New","published":true,"query":{},"seo":{"description":"Test description","title":"Test"},"slug":"new","sort_on":"depth_desc","tags":[],"type":"query","uid":"604f585a7051e30001173ac1","visible_facets_keys":[]},"schema":{"$ref":"#/components/schemas/UpdateCollection"}}},"description":"The Collection object. See example below or refer `UpdateCollectionSchema` for details."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"updateCollection | Update a collection","tags":["Catalog"]}},"/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/collections/{id}/items/":{"get":{"description":"Get items from a collection specified by its `id`.","parameters":[{"description":"A `company_id` is a unique identifier for a particular seller account.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"A `application_id` is a unique identifier for a particular sale channel.","in":"path","name":"application_id","required":true,"schema":{"type":"string"}},{"description":"A `id` is a unique identifier of a collection.","in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"Each response will contain sort_on param, which should be sent back to make pagination work.","in":"query","name":"sort_on","required":false,"schema":{"type":"string"}},{"description":"Each response will contain next_id param, which should be sent back to make pagination work.","in":"query","name":"page_id","required":false,"schema":{"type":"string"}},{"description":"Number of items to retrieve in each page. Default is 12.","in":"query","name":"page_size","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCollectionItemsResponse"}}},"description":"The attached items of an collection. See example below or refer `GetCollectionItemsResponseSchema` for details"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"getCollectionItems | Get the items for a collection","tags":["Catalog"]},"post":{"description":"Adds items to a collection specified by its `id`. See `CollectionItemRequest` for the list of attributes needed to add items to an collection.","parameters":[{"description":"A `company_id` is a unique identifier for a particular seller account.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"A `application_id` is a unique identifier for a particular sale channel.","in":"path","name":"application_id","required":true,"schema":{"type":"string"}},{"description":"A `id` is a unique identifier of a collection.","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionItemUpdate"}}},"description":"The attributes needed to add items to an collection. See details below","required":true},"responses":{"200":{"content":{"application/json":{"example":{"message":"items updated"},"schema":{"$ref":"#/components/schemas/UpdatedResponse"}}},"description":"Status object. Tells whether the operation was successful."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"addCollectionItems | Add items to a collection","tags":["Catalog"]}},"/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/collections/{slug}/":{"get":{"description":"Get the details of a collection by its `slug`. If successful, returns a Collection resource in the response body specified in `CollectionDetailResponse`","parameters":[{"description":"A `company_id` is a unique identifier for a particular seller account.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"A `application_id` is a unique identifier for a particular sale channel.","in":"path","name":"application_id","required":true,"schema":{"type":"string"}},{"description":"A `slug` is a human readable, URL friendly unique identifier of an object. Pass the `slug` of the collection which you want to retrieve.","in":"path","name":"slug","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"_custom_json":{},"_locale_language":{},"_schedule":{"end":null,"next_schedule":[{"end":null,"start":"2020-05-21T03:58:41.237000Z"}],"start":"2020-05-21T03:58:41.237000Z"},"action":{"page":{"query":{"collection":["new"]},"type":"collection"},"type":"page"},"allow_facets":true,"allow_sort":true,"badge":{"color":"#ffffff","text":""},"banners":{"landscape":{"type":"image","url":"https://res.cloudinary.com/dwzm9bysq/image/upload/v1588857999/production/applications/app_000000000000000000000001/media/collection/landscape/avm7xibo2jgk8glc4bwl.png"},"portrait":{"type":"image","url":"https://res.cloudinary.com/dwzm9bysq/image/upload/v1588858137/production/applications/app_000000000000000000000001/media/collection/portrait/xzuftshmmw4yuwzb12pm.png"}},"description":"","is_active":true,"logo":{"type":"image","url":"https://res.cloudinary.com/dwzm9bysq/image/upload/v1588857854/production/applications/app_000000000000000000000001/media/collection/logo/w9ns7nfgv7fk45xqrpoh.png"},"meta":{},"name":"new","published":true,"query":{"l3_categories":["12"],"sort_on":"discount_asc"},"slug":"new","sort_on":"popular","tags":[],"type":"query","uid":"5ec5fc757cb1e4740a17da23","visible_facets_keys":[]},"schema":{"$ref":"#/components/schemas/GetCollectionDetailResponse"}}},"description":"The Collection object. See example below or refer `GetCollectionDetailResponse` for details"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"getCollectionDetail | Get a particular collection","tags":["Catalog"]}},"/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/department":{"get":{"description":"Departments are a way to categorise similar products. A product can lie in multiple departments. For example, a skirt can below to the 'Women's Fashion' Department while a handbag can lie in 'Women's Accessories' Department. Use this API to list all the application departments. If successful, returns the list of departments specified in `ApplicationDepartmentListingResponse`","parameters":[{"description":"A `company_id` is a unique identifier for a particular seller account.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"A `application_id` is a unique identifier for a particular sale channel.","in":"path","name":"application_id","required":true,"schema":{"type":"string"}},{"description":"The page number to navigate through the given set of results","in":"query","name":"page_no","required":false,"schema":{"type":"integer"}},{"description":"Number of items to retrieve in each page. Default is 12.","in":"query","name":"page_size","required":false,"schema":{"default":12,"type":"integer"}},{"description":"Search query with brand name.Use this parameter to search department by name.","in":"query","name":"q","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"items":[{"action":{"page":{"query":{"brand":["Hess-Inc"]},"type":"products"},"type":"page"},"app_id":"000000000000000000000001","banners":{"portrait":{"type":"image","url":"https://hdn-1.fynd.com/media/banner_portrait/brand/original/12537_9cdfc6835e814b0986ee1643d38cf6cd.png"}},"en_name":"Barry, Jennings and Larson","logo":"https://hdn-1.fynd.com/media/logo/brand/original/12391_0d956c6c71a4427895c15e44cba82f88.jpg","name":"Barry, Jennings and Larson","slug":"Hess-Inc","uid":1}],"page":{"current":1,"has_next":false,"has_previous":false,"item_total":1,"total":1,"type":"number"}},"schema":{"$ref":"#/components/schemas/ApplicationDepartmentListingResponse"}}},"description":"List of Departments. See example below or refer `BrandListingResponse` for details"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"getApplicationDepartmentListing | List all the departments for the application","tags":["Catalog"]}},"/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/department/{department_uid}":{"patch":{"description":"This API helps to update data associated to a item custom meta.","parameters":[{"description":"Id of the company associated to department custom json.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"application id for which the custom_json is associated.","in":"path","name":"application_id","required":true,"schema":{"type":"string"}},{"description":"department id for which the custom_json is associated.","in":"path","name":"department_uid","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"_custom_json":{"sample_key_1":"Sample Value 1","sample_key_2":"Sample Value 2"}},"schema":{"$ref":"#/components/schemas/ApplicationDepartmentJson"}}},"description":"custom json object that needs to be added.","required":true},"responses":{"200":{"content":{"application/json":{"example":{"success":true},"schema":{"$ref":"#/components/schemas/SuccessResponse1"}}},"description":"Returns a success response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"updateAppDepartment | Update a single custom json.","tags":["Catalog"]}},"/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/departments":{"get":{"description":"Departments are a way to categorise similar products. A product can lie in multiple departments. For example, a skirt can below to the 'Women's Fashion' Department while a handbag can lie in 'Women's Accessories' Department. Use this API to list all the departments. If successful, returns the list of departments specified in `DepartmentResponse`","parameters":[{"description":"A `company_id` is a unique identifier for a particular seller account.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"A `application_id` is a unique identifier for a particular sale channel.","in":"path","name":"application_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"items":[{"logo":{"type":"image","url":"http://cdn4.gofynd.com/media/category_tab_icons/department/Men.png"},"name":"Zachary Harris","priority_order":7,"slug":"Zachary-Harris","uid":1},{"logo":{"type":"image","url":"http://cdn4.gofynd.com/media/category_tab_icons/department/Men.png"},"name":"Aaron Reilly","priority_order":7,"slug":"Aaron-Reilly","uid":2},{"logo":{"type":"image","url":"http://cdn4.gofynd.com/media/category_tab_icons/department/Men.png"},"name":"Bobby Sandoval","priority_order":7,"slug":"Bobby-Sandoval","uid":3},{"logo":{"type":"image","url":"http://cdn4.gofynd.com/media/category_tab_icons/department/Men.png"},"name":"Seth Hughes","priority_order":7,"slug":"Seth-Hughes","uid":4},{"logo":{"type":"image","url":"http://cdn4.gofynd.com/media/category_tab_icons/department/Men.png"},"name":"Michelle Moore","priority_order":7,"slug":"Michelle-Moore","uid":5},{"logo":{"type":"image","url":"http://cdn4.gofynd.com/media/category_tab_icons/department/Men.png"},"name":"Annette Baldwin","priority_order":7,"slug":"Annette-Baldwin","uid":6},{"logo":{"type":"image","url":"http://cdn4.gofynd.com/media/category_tab_icons/department/Men.png"},"name":"Chris Mata","priority_order":7,"slug":"Chris-Mata","uid":7},{"logo":{"type":"image","url":"http://cdn4.gofynd.com/media/category_tab_icons/department/Men.png"},"name":"Nicole Jacobs","priority_order":7,"slug":"Nicole-Jacobs","uid":8},{"logo":{"type":"image","url":"http://cdn4.gofynd.com/media/category_tab_icons/department/Men.png"},"name":"Pamela Smith","priority_order":7,"slug":"Pamela-Smith","uid":9},{"logo":{"type":"image","url":"http://cdn4.gofynd.com/media/category_tab_icons/department/Men.png"},"name":"Nicole Simon","priority_order":7,"slug":"Nicole-Simon","uid":10}]},"schema":{"$ref":"#/components/schemas/DepartmentResponse"}}},"description":"List of Departments. See example below or refer `DepartmentResponse` for details."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"getDepartments | List all the departments","tags":["Catalog"]}},"/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/inventory/":{"get":{"description":"Retrieve the available Inventory of the products. Use this API to get the Inventory status of products with the filters of timestamp, store_ids, brand_ids, item_id - Items - Pagination","parameters":[{"description":"A `company_id` is a unique identifier for a particular seller account.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"A `application_id` is a unique identifier for a particular sale channel.","in":"path","name":"application_id","required":true,"schema":{"type":"string"}},{"description":"The Item Id of the product.","in":"query","name":"item_ids","required":false,"schema":{"items":{"type":"integer"},"type":"array"}},{"description":"The Store Id of products to fetch inventory.","in":"query","name":"store_ids","required":false,"schema":{"items":{"type":"integer"},"type":"array"}},{"description":"The Brand Id of products to fetch inventory.","in":"query","name":"brand_ids","required":false,"schema":{"items":{"type":"integer"},"type":"array"}},{"description":"Unique seller_identifier of the product.","in":"query","name":"seller_identifiers","required":false,"schema":{"items":{"type":"string"},"type":"array"}},{"description":"Timestamp in UTC format (2020-07-23T10:27:50Z)","in":"query","name":"timestamp","required":false,"schema":{"type":"string"}},{"description":"The number of items to retrieve in each page.","in":"query","name":"page_size","required":false,"schema":{"default":12,"type":"integer"}},{"description":"Page ID to retrieve next set of results.","in":"query","name":"page_id","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"items":[{"_custom_json":{},"_id":"62d809eebeed53f4e27824b0","brand":{"id":2586},"company":{"id":3},"country_of_origin":"India","created_by":{"user_id":"2a00eecae43d7e7f4340e7cf","username":"mohitkhare_gofynd_com_12594"},"date_meta":{"added_on_store":1658325486,"created_on":1658325486,"inventory_updated_on":1658325486,"modified_on":1660913492},"dimension":{"height":30,"is_default":true,"length":10,"unit":"cm","width":20},"discount_applied":null,"expiration_date":"9998-01-30T23:59:00","fragile":false,"fynd_article_code":"LS101269_11","fynd_item_code":"LS101269","identifier":{"ean":"LSRS401269"},"is_active":true,"is_set":false,"item_id":7523701,"manufacturer":{"address":"POLARIS, 2ND FLOOR, ANDHERI, JSNLCA, MAHARASHTRA, THANE","is_default":true,"name":"Test 21"},"meta":{"service":"Inventory Job"},"modified_by":{"user_id":"2a00eecae43d7e7f4340e7cf","username":"mohitkhare_gofynd_com_12594"},"platforms":{"fynd":false,"uniket_wholesale":true},"price":{"currency":"INR","effective":3250,"marked":5000,"transfer":0,"updated_at":"2022-07-20T13:58:06.122914+00:00"},"quantities":{"sellable":{"count":100,"updated_at":1658325486}},"raw_meta":{"fynd_identifier":"624_LSRS401269"},"return_config":{"returnable":true,"time":30,"unit":"days"},"seller_identifier":"LSRS401269","size":"11","stage":"verified","store":{"id":624},"tax_identifier":{"hsn_code_id":"000000000000000000000001"},"total_quantity":100,"track_inventory":true,"trader":[{"address":["Load Galli, Mumbai"],"name":"Load Company","type":"Importer"}],"uid":"624_LSRS401269","weight":{"is_default":true,"shipping":40,"unit":"gram"}},{"_custom_json":{},"_id":"62d809eebeed53f4e27824b2","brand":{"id":2586},"company":{"id":3},"country_of_origin":"India","created_by":{"user_id":"2a00eecae43d7e7f4340e7cf","username":"mohitkhare_gofynd_com_12594"},"date_meta":{"added_on_store":1658325486,"created_on":1658325486,"inventory_updated_on":1658325486,"modified_on":1660913492},"dimension":{"height":30,"is_default":true,"length":10,"unit":"cm","width":20},"discount_applied":null,"expiration_date":"9998-01-30T23:59:00","fragile":false,"fynd_article_code":"LS101163_11","fynd_item_code":"LS101163","identifier":{"ean":"LSRS401163"},"is_active":true,"is_set":false,"item_id":7523925,"manufacturer":{"address":"POLARIS, 2ND FLOOR, ANDHERI, JSNLCA, MAHARASHTRA, THANE","is_default":true,"name":"Test 21"},"meta":{"service":"Inventory Job"},"modified_by":{"user_id":"2a00eecae43d7e7f4340e7cf","username":"mohitkhare_gofynd_com_12594"},"platforms":{"fynd":false,"uniket_wholesale":true},"price":{"currency":"INR","effective":3250,"marked":5000,"transfer":0,"updated_at":"2022-07-20T13:58:06.396235+00:00"},"quantities":{"sellable":{"count":100,"updated_at":1658325486}},"raw_meta":{"fynd_identifier":"624_LSRS401163"},"return_config":{"returnable":true,"time":30,"unit":"days"},"seller_identifier":"LSRS401163","size":"11","stage":"verified","store":{"id":624},"tax_identifier":{"hsn_code_id":"000000000000000000000001"},"total_quantity":100,"track_inventory":true,"trader":[{"address":["Load Galli, Mumbai"],"name":"Load Company","type":"Importer"}],"uid":"624_LSRS401163","weight":{"is_default":true,"shipping":40,"unit":"gram"}},{"_custom_json":{},"_id":"62d809eebeed53f4e27824b4","brand":{"id":2586},"company":{"id":3},"country_of_origin":"India","created_by":{"user_id":"2a00eecae43d7e7f4340e7cf","username":"mohitkhare_gofynd_com_12594"},"date_meta":{"added_on_store":1658325486,"created_on":1658325486,"inventory_updated_on":1658325486,"modified_on":1660913492},"dimension":{"height":30,"is_default":true,"length":10,"unit":"cm","width":20},"discount_applied":null,"expiration_date":"9998-01-30T23:59:00","fragile":false,"fynd_article_code":"LS101173_11","fynd_item_code":"LS101173","identifier":{"ean":"LSRS401173"},"is_active":true,"is_set":false,"item_id":7523691,"manufacturer":{"address":"POLARIS, 2ND FLOOR, ANDHERI, JSNLCA, MAHARASHTRA, THANE","is_default":true,"name":"Test 21"},"meta":{"service":"Inventory Job"},"modified_by":{"user_id":"2a00eecae43d7e7f4340e7cf","username":"mohitkhare_gofynd_com_12594"},"platforms":{"fynd":false,"uniket_wholesale":true},"price":{"currency":"INR","effective":3250,"marked":5000,"transfer":0,"updated_at":"2022-07-20T13:58:06.635248+00:00"},"quantities":{"sellable":{"count":100,"updated_at":1658325486}},"raw_meta":{"fynd_identifier":"624_LSRS401173"},"return_config":{"returnable":true,"time":30,"unit":"days"},"seller_identifier":"LSRS401173","size":"11","stage":"verified","store":{"id":624},"tax_identifier":{"hsn_code_id":"000000000000000000000001"},"total_quantity":100,"track_inventory":true,"trader":[{"address":["Load Galli, Mumbai"],"name":"Load Company","type":"Importer"}],"uid":"624_LSRS401173","weight":{"is_default":true,"shipping":40,"unit":"gram"}},{"_custom_json":{},"_id":"62d809eebeed53f4e27824b6","brand":{"id":2586},"company":{"id":3},"country_of_origin":"India","created_by":{"user_id":"2a00eecae43d7e7f4340e7cf","username":"mohitkhare_gofynd_com_12594"},"date_meta":{"added_on_store":1658325486,"created_on":1658325486,"inventory_updated_on":1658325486,"modified_on":1660913492},"dimension":{"height":30,"is_default":true,"length":10,"unit":"cm","width":20},"discount_applied":null,"expiration_date":"9998-01-30T23:59:00","fragile":false,"fynd_article_code":"LS101198_11","fynd_item_code":"LS101198","identifier":{"ean":"LSRS401198"},"is_active":true,"is_set":false,"item_id":7524280,"manufacturer":{"address":"POLARIS, 2ND FLOOR, ANDHERI, JSNLCA, MAHARASHTRA, THANE","is_default":true,"name":"Test 21"},"meta":{"service":"Inventory Job"},"modified_by":{"user_id":"2a00eecae43d7e7f4340e7cf","username":"mohitkhare_gofynd_com_12594"},"platforms":{"fynd":false,"uniket_wholesale":true},"price":{"currency":"INR","effective":3250,"marked":5000,"transfer":0,"updated_at":"2022-07-20T13:58:06.898687+00:00"},"quantities":{"sellable":{"count":100,"updated_at":1658325486}},"raw_meta":{"fynd_identifier":"624_LSRS401198"},"return_config":{"returnable":true,"time":30,"unit":"days"},"seller_identifier":"LSRS401198","size":"11","stage":"verified","store":{"id":624},"tax_identifier":{"hsn_code_id":"000000000000000000000001"},"total_quantity":100,"track_inventory":true,"trader":[{"address":["Load Galli, Mumbai"],"name":"Load Company","type":"Importer"}],"uid":"624_LSRS401198","weight":{"is_default":true,"shipping":40,"unit":"gram"}}],"page":{"has_next":true,"has_previous":true,"item_total":1714,"next_id":"62d809eebeed53f4e27824b6","type":"cursor"}},"schema":{"$ref":"#/components/schemas/InventoryStockResponse"}}},"description":"Success. Returns the article/stock of the product stock."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body to know the exact reason."}},"summary":"getAppInventory | Get the stock of a product","tags":["Catalog"]}},"/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/locations":{"get":{"description":"This API allows to view all the locations asscoiated to a application.","parameters":[{"description":"Id of the company whose locations are to fetched","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"Id of the application whose locations are to fetched","in":"path","name":"application_id","required":true,"schema":{"type":"string"}},{"description":"Helps to sort the location list on the basis of location type.","in":"query","name":"store_type","required":false,"schema":{"type":"string"}},{"description":"Helps to sort the location list on the basis of uid list.","in":"query","name":"uid","required":false,"schema":{"items":{"type":"integer"},"type":"array"}},{"description":"Query that is to be searched.","in":"query","name":"q","required":false,"schema":{"type":"string"}},{"description":"to filter companies on basis of verified or unverified companies.","in":"query","name":"stage","required":false,"schema":{"type":"string"}},{"description":"The page number to navigate through the given set of results","in":"query","name":"page_no","required":false,"schema":{"default":1,"type":"integer"}},{"description":"Number of items to retrieve in each page. Default is 20.","in":"query","name":"page_size","required":false,"schema":{"default":20,"type":"integer"}},{"description":"Get locations filtered by tags.","in":"query","name":"tags","required":false,"schema":{"items":{"type":"string"},"type":"array"}},{"description":"Get locations filtered by store types.","in":"query","name":"store_types","required":false,"schema":{"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"example":{"filters":[],"items":[{"address":{"address1":"POLARIS 2ND FLOOR, ANDHERI","address2":"","city":"MUMBAI","country":"INDIA","landmark":"","lat_long":{"coordinates":[72.8776559,19.0759837],"type":"Point"},"pincode":400001,"state":"MAHARASHTRA"},"code":"","company_id":2,"display_name":"Test","name":"Test","phone_number":"","store_code":"HS-a0c85","store_type":"high_street","uid":2}],"page":{"current":1,"has_next":true,"has_previous":false,"item_total":3,"size":3,"type":"number"}},"schema":{"$ref":"#/components/schemas/LocationListSerializer"}}},"description":"Company profile object. See example below or refer `LocationListSerializer` for details"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"getAppLocations | Get list of locations","tags":["Catalog"]}},"/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/product-configuration/":{"get":{"description":"configured details for catalog.","parameters":[{"description":"A `company_id` is a unique identifier for a particular seller account.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"A `application_id` is a unique identifier for a particular sale channel.","in":"path","name":"application_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"app_id":"000000000000000000000001","config_id":"000000000000000000000001","config_type":"app","listing":{"filter":{"allow_single":false,"attribute_config":[{"is_active":true,"key":"gender","name":"Gender","priority":1,"type":"multivalued","value_config":{"bucket_points":[],"condition":"OR","map":{},"sort":"count","value":""}},{"is_active":true,"key":"min_price_effective","name":"Price","priority":2,"type":"range","value_config":{"bucket_points":[],"condition":"OR","map":{"< 500":"Below Rs. 500",">= 6000":"Above Rs. 6000"},"sort":"count","value":""}},{"is_active":true,"key":"departments","name":"Department","priority":3,"type":"multivalued","value_config":{"bucket_points":[],"condition":"OR","map":{},"sort":"count","value":"metadata"}},{"is_active":true,"key":"brand_id","name":"Brand","priority":4,"type":"multivalued","value_config":{"bucket_points":[],"condition":"OR","map":{"5th Avenue":"A {{value}}"},"sort":"ascending","value":"metadata"}},{"is_active":false,"key":"season","name":"Season","priority":5,"type":"multivalued","value_config":{"bucket_points":[],"condition":"OR","map":{"":""},"sort":"count","value":""}},{"is_active":true,"key":"is_set","name":"Set","priority":6,"type":"multivalued","value_config":{"bucket_points":[],"condition":"OR","map":{"false":"No","true":"Yes"},"sort":"descending","value":""}},{"is_active":true,"key":"rating","name":"Rating","priority":7,"type":"multivalued","value_config":{"bucket_points":[],"condition":"OR","map":{"":""},"sort":"count","value":""}},{"is_active":true,"key":"size_depth","name":"Size Depth","priority":8,"type":"range","value_config":{"bucket_points":[],"condition":"OR","map":{"{} - {}":"{} - {}"},"sort":"count","value":""}}]},"sort":{"config":[{"is_active":false,"key":"price_dsc","logo":"https://hdn-1.fynd.com/global/menu-icons/Price%20High%20to%20Low.png","name":"Price High to Low","priority":1},{"is_active":true,"key":"rating_dsc","logo":"https://hdn-1.fynd.com/global/menu-icons/Rating.png","name":"Rating","priority":2},{"is_active":true,"key":"depth_desc","name":"Size Depth (High to Low)","priority":3},{"is_active":true,"key":"discount_dsc","logo":"https://hdn-1.fynd.com/global/menu-icons/Discount%20Low%20to%20High.png","name":"Discount High to Low","priority":4},{"is_active":true,"key":"popular","logo":"https://hdn-1.fynd.com/global/menu-icons/Popularity.png","name":"Popularity","priority":5},{"is_active":true,"key":"relevance","name":"Relevance","priority":6},{"is_active":true,"key":"price_asc","logo":"https://hdn-1.fynd.com/global/menu-icons/Price%20Low%20to%20High.png","name":"Price Low to High","priority":7}],"default_key":""}},"product":{"similar":{"config":[{"is_active":true,"key":"seller","priority":1,"size":{"max":10,"min":2},"subtitle":"","title":"Seller"},{"is_active":true,"key":"visual","priority":2,"size":{"max":10,"min":2},"subtitle":"","title":"Visual"},{"is_active":true,"key":"brand","priority":3,"size":{"max":10,"min":2},"subtitle":"","title":"Brand"},{"is_active":true,"key":"specs","priority":4,"size":{"max":10,"min":2},"subtitle":"","title":"Specs"}]},"variant":{"config":[{"display_type":"image","is_active":true,"key":"color","name":"Additional Colors12","priority":1,"size":{"max":10,"min":2}},{"display_type":"text","is_active":true,"key":"storage","name":"Memory","priority":2,"size":{"max":10,"min":2}},{"display_type":"image","is_active":true,"key":"visual","name":"Additional Colors","priority":3,"size":{"max":10,"min":2}},{"display_type":"text","is_active":true,"key":"ram_storage","name":"Ram_Storage","priority":4,"size":{"max":10,"min":2}},{"display_type":"color","is_active":true,"key":"shade","name":"Additional Shades","priority":5,"size":{"max":10,"min":2}},{"display_type":"text","is_active":true,"key":"water_resistant","name":"Water_Resistant","priority":6,"size":{"max":10,"min":2}}]}}},"is_default":false},"schema":{"$ref":"#/components/schemas/GetAppCatalogConfiguration"}}},"description":"Get application level configured catalog details. See example below or refer `GetAppCatalogConfigurationSchema` for details"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"getConfigurations | Get configured details for catalog","tags":["Catalog"]},"post":{"description":"Add configuration for products & listing.","parameters":[{"description":"A `company_id` is a unique identifier for a particular seller account.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"A `application_id` is a unique identifier for a particular sale channel.","in":"path","name":"application_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppConfiguration"}}},"description":"The configuration for products & listings. See details below","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAppCatalogConfiguration"}}},"description":"success flag will tell whether the operation was successful."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"createConfigurationProductListing | Add configuration for products & listings","tags":["Catalog"]}},"/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/product-configuration/metadata/":{"get":{"description":"configuration meta  details for catalog.","parameters":[{"description":"A `company_id` is a unique identifier for a particular seller account.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"A `application_id` is a unique identifier for a particular sale channel.","in":"path","name":"application_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCatalogConfigurationMetaData"}}},"description":"configuration details for catalog. See example below or refer `GetCatalogConfigurationMetaDataSchema` for details"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"getCatalogConfiguration | Get configuration meta  details for catalog for admin panel","tags":["Catalog"]}},"/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/product-configuration/{type}/":{"get":{"description":"configured details for catalog.","parameters":[{"description":"A `company_id` is a unique identifier for a particular seller account.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"A `application_id` is a unique identifier for a particular sale channel.","in":"path","name":"application_id","required":true,"schema":{"type":"string"}},{"description":"type can be brands, categories etc.","in":"path","name":"type","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAppCatalogEntityConfiguration"}}},"description":"Get application level configured catalog details. See example below or refer `GetAppCatalogEntityConfigurationSchema` for details"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"getConfigurationByType | Get configured details for catalog","tags":["Catalog"]},"post":{"description":"Add configuration for categories & brands.","parameters":[{"description":"A `company_id` is a unique identifier for a particular seller account.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"A `application_id` is a unique identifier for a particular sale channel.","in":"path","name":"application_id","required":true,"schema":{"type":"string"}},{"description":"type can be brands, categories etc.","in":"path","name":"type","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppConfiguration"}}},"description":"The configuration for categories & brands. See details below","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAppCatalogConfiguration"}}},"description":"success flag will tell whether the operation was successful."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"createConfigurationByType | Add configuration for categories and brands","tags":["Catalog"]}},"/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/product/{item_id}/":{"get":{"description":"Products are the core resource of an application. If successful, returns a Company Application Product resource in the response body depending upon filter sent.","parameters":[{"description":"A `company_id` is a unique identifier for a particular seller account.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"A `application_id` is a unique identifier for a particular sale channel.","in":"path","name":"application_id","required":true,"schema":{"type":"string"}},{"description":"product id for a particular product.","in":"path","name":"item_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"alt_text":{"https://test-url.com/test.png":"test-alt"},"is_cod":false,"is_gift":false,"moq":{"increment_unit":2,"maximum":10,"minimum":1},"seo":{"description":"test-description","title":"test-title","breadcrumbs":[],"sitemap":{},"meta_tags":[],"canonical_url":"/test"},"size_promotion_threshold":{"threshold_type":"flat","threshold_value":100}},"schema":{"$ref":"#/components/schemas/OwnerAppItemResponse"}}},"description":"The Company Applicaton Product Data(MOQ/SEO)."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"getAppProduct | Get company application product data.","tags":["Catalog"]},"patch":{"description":"This API helps to update data associated to a item custom meta.","parameters":[{"description":"Id of the company associated to custom meta.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"application id for which the custom_meta is associated.","in":"path","name":"application_id","required":true,"schema":{"type":"string"}},{"description":"product id for which the custom_meta is associated.","in":"path","name":"item_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"_custom_meta":[{"key":"rating_user_count","value":"3452"},{"key":"rating_user_count","value":"3452"},{"key":"rating_user_count","value":"3452"}]},"schema":{"$ref":"#/components/schemas/ApplicationItemMeta"}}},"description":"custom meta object that needs to be added.","required":true},"responses":{"200":{"content":{"application/json":{"example":{"success":true},"schema":{"$ref":"#/components/schemas/SuccessResponse1"}}},"description":"Returns a success response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"updateAppProduct | Update a single custom meta.","tags":["Catalog"]}},"/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/products":{"get":{"description":"List all the products associated with a brand, collection or category in a requested sort order. The API additionally supports arbitrary search queries that may refer the name of any product, brand, category or collection. If successful, returns a paginated list of products specified in `ApplicationProductListingResponse`","parameters":[{"description":"A `company_id` is a unique identifier for a particular seller account.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"A `application_id` is a unique identifier for a particular sale channel.","in":"path","name":"application_id","required":true,"schema":{"type":"string"}},{"description":"The search query. This can be a partial or complete name of a either a product, brand or category","in":"query","name":"q","required":false,"schema":{"type":"string"}},{"description":"The search filter parameters. All the parameter filtered from filter parameters will be passed in **f** parameter in this format. **?f=brand:voi-jeans||and:::category:t-shirts||shirts**","in":"query","name":"f","required":false,"schema":{"type":"string"}},{"description":"The search filter parameters for collection items. All the parameter filtered from filter parameters will be passed in **c** parameter in this format. **?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts**","in":"query","name":"c","required":false,"schema":{"type":"string"}},{"description":"Pass `filters` parameter to fetch the filter details. This flag is used to fetch all filters","in":"query","name":"filters","required":false,"schema":{"default":true,"type":"boolean"}},{"description":"This query parameter is used to get the dependent products in the listing.","in":"query","name":"is_dependent","required":false,"schema":{"default":true,"type":"boolean"}},{"description":"The order to sort the list of products on. The supported sort parameters are popularity, price, redemption and discount in either ascending or descending order. See the supported values below.","in":"query","name":"sort_on","required":false,"schema":{"enum":["latest","popular","price_asc","price_dsc","discount_asc","discount_dsc"],"type":"string"}},{"description":"Each response will contain **page_id** param, which should be sent back to make pagination work.","in":"query","name":"page_id","required":false,"schema":{"type":"string"}},{"description":"Number of items to retrieve in each page. Default is 12.","in":"query","name":"page_size","required":false,"schema":{"default":12,"type":"integer"}},{"description":"If page_type is number then pass it to fetch page items. Default is 1.","in":"query","name":"page_no","required":false,"schema":{"default":1,"type":"integer"}},{"description":"For pagination type should be cursor or number. Default is cursor.","in":"query","name":"page_type","required":false,"schema":{"default":"cursor","type":"string"}},{"description":"Item Ids of product","in":"query","name":"item_ids","required":false,"schema":{"items":{"type":"integer"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"example":{"filters":[{"key":{"display":"Department","kind":"multivalued","logo":"https://hdn-1.fynd.com/global/menu-icons/Department.svg","name":"department"},"values":[{"count":15,"display":"Debra Villarreal","is_selected":false,"logo":{"type":"image","url":"http://cdn4.gofynd.com/media/category_tab_icons/department/Men.png"},"value":"Debra-Villarreal"},{"count":15,"display":"Tracey Miller","is_selected":false,"logo":{"type":"image","url":"http://cdn4.gofynd.com/media/category_tab_icons/department/Men.png"},"value":"Tracey-Miller"}]},{"key":{"display":"Category","kind":"multivalued","logo":"https://hdn-1.fynd.com/global/menu-icons/Category.svg","name":"category"},"values":[{"count":15,"display":"Amy Kim DDS","is_selected":false,"logo":"http://cdn4.gofynd.com/media/banner/category/original/12063_a5bb91bd5cb44c3c9db98c2a0e6b3d99.jpg","value":"3"}]},{"key":{"display":"Gender","kind":"multivalued","logo":"https://hdn-1.fynd.com/global/menu-icons/Gender.svg","name":"gender"},"values":[{"count":15,"display":"Men","is_selected":false,"value":"men"},{"count":15,"display":"Women","is_selected":false,"value":"women"}]},{"key":{"display":"Size","kind":"multivalued","logo":"https://hdn-1.fynd.com/global/menu-icons/Sizes.svg","name":"sizes"},"values":[{"count":15,"display":"13","is_selected":false,"value":"13"}]},{"key":{"display":"Brand","kind":"multivalued","logo":"https://hdn-1.fynd.com/global/menu-icons/Brand%20ID.svg","name":"brand"},"values":[{"count":15,"display":"Barry, Jennings and Larson","is_selected":false,"logo":"https://hdn-1.fynd.com/media/logo/brand/original/12391_0d956c6c71a4427895c15e44cba82f88.jpg","value":"1"}]},{"key":{"display":"Rating","kind":"multivalued","logo":"https://hdn-1.fynd.com/global/menu-icons/Rating.svg","name":"rating"},"values":[{"count":15,"display":"2 - 3","is_selected":false,"value":"[2 TO 3}"}]},{"key":{"display":"Image","kind":"multivalued","logo":"https://hdn-1.fynd.com/global/menu-icons/image%20Nature.svg","name":"image_nature"},"values":[{"count":15,"display":"GoodQuality","is_selected":false,"value":"standard"}]},{"key":{"display":"Monica Hampton","kind":"multivalued","logo":"https://hdn-1.fynd.com/global/menu-icons/image%20Nature.svg","name":"material"},"values":[{"count":15,"display":"Neoprene","is_selected":false,"value":"Neoprene"}]},{"key":{"display":"John Mendoza","kind":"multivalued","logo":"https://hdn-1.fynd.com/global/menu-icons/image%20Nature.svg","name":"weight"},"values":[{"count":15,"display":"100","is_selected":false,"value":"100"}]},{"key":{"display":"Kimberly Mcdaniel","kind":"multivalued","logo":"https://hdn-1.fynd.com/global/menu-icons/image%20Nature.svg","name":"gender"},"values":[{"count":15,"display":"['Men', 'Women']","is_selected":false,"value":"['Men', 'Women']"}]},{"key":{"display":"Kimberly Davidson","kind":"multivalued","logo":"https://hdn-1.fynd.com/global/menu-icons/image%20Nature.svg","name":"color"},"values":[{"count":15,"display":"Grey","is_selected":false,"value":"808080"}]},{"key":{"display":"Available","kind":"singlevalued","logo":"https://hdn-1.fynd.com/global/menu-icons/image%20Nature.svg","name":"is_available"},"values":[{"count":3,"display":"Available","is_selected":false,"value":true}]}],"items":[{"action":{"page":{"query":{"slug":"benchmark-collaborative-paradigms"},"type":"product"},"type":"page"},"attributes":{"gender":"women","material":"Neoprene","primary_color":"DarkGrey","primary_color_hex":"808080","weight":"100"},"brand":{"_custom_json":{},"action":{"page":{"query":{"brand":["Hess-Inc"]},"type":"products"},"type":"page"},"logo":{"type":"image","url":"https://hdn-1.fynd.com/media/logo/brand/original/12391_0d956c6c71a4427895c15e44cba82f88.jpg"},"name":"Hess Inc","type":"brand"},"categories":[{"_custom_json":{},"action":{"page":{"query":{"category":["Amy-Kim-DDS"]},"type":"category"},"type":"page"},"id":3,"logo":{"type":"image","url":"https://hdn-1.fynd.com/media/banner_portrait/brand/original/540_ecba3a1af141467da8abc20500f983db.jpg"},"name":"Amy Kim DDS","uid":3}],"discount":"14% OFF","is_tryout":false,"item_code":"ITEM_CODE_1","item_type":"set","medias":[{"type":"image","url":"https://hdn-1.fynd.com/media/fynd_store_items/l2_category/original/2830_c5bb5fc02f414307a828c4c56483c30a.jpg"}],"name":"benchmark collaborative paradigms","price":{"effective":{"currency_code":"INR","currency_symbol":"₹","max":1399,"min":1199},"marked":{"currency_code":"INR","currency_symbol":"₹","max":1499,"min":1399}},"promo_meta":{"subtitle":"","title":""},"rating":2.7,"sellable":true,"slug":"benchmark-collaborative-paradigms","type":"product","uid":1},{"action":{"page":{"query":{"slug":"architect-granular-e-business"},"type":"product"},"type":"page"},"attributes":{"gender":"women","material":"Neoprene","primary_color":"DarkGrey","primary_color_hex":"808080","weight":"100"},"brand":{"_custom_json":{},"action":{"page":{"query":{"brand":["Hess-Inc"]},"type":"products"},"type":"page"},"logo":{"type":"image","url":"https://hdn-1.fynd.com/media/logo/brand/original/12391_0d956c6c71a4427895c15e44cba82f88.jpg"},"name":"Hess Inc","type":"brand"},"categories":[{"_custom_json":{},"action":{"page":{"query":{"category":["Amy-Kim-DDS"]},"type":"category"},"type":"page"},"id":3,"logo":{"type":"image","url":"https://hdn-1.fynd.com/media/banner_portrait/brand/original/540_ecba3a1af141467da8abc20500f983db.jpg"},"name":"Amy Kim DDS","uid":3}],"discount":"14% OFF","is_tryout":false,"item_code":"ITEM_CODE_2","item_type":"set","medias":[{"type":"image","url":"https://hdn-1.fynd.com/media/fynd_store_items/l2_category/original/2830_c5bb5fc02f414307a828c4c56483c30a.jpg"}],"name":"architect granular e-business","price":{"effective":{"currency_code":"INR","currency_symbol":"₹","max":1399,"min":1199},"marked":{"currency_code":"INR","currency_symbol":"₹","max":1499,"min":1399}},"promo_meta":{"subtitle":"","title":""},"rating":2.7,"sellable":true,"slug":"architect-granular-e-business","type":"product","uid":10},{"action":{"page":{"query":{"slug":"facilitate-enterprise-supply-chains"},"type":"product"},"type":"page"},"attributes":{"gender":"women","material":"Neoprene","primary_color":"DarkGrey","primary_color_hex":"808080","weight":"100"},"brand":{"_custom_json":{},"action":{"page":{"query":{"brand":["Hess-Inc"]},"type":"products"},"type":"page"},"logo":{"type":"image","url":"https://hdn-1.fynd.com/media/logo/brand/original/12391_0d956c6c71a4427895c15e44cba82f88.jpg"},"name":"Hess Inc","type":"brand"},"categories":[{"_custom_json":{},"action":{"page":{"query":{"category":["Amy-Kim-DDS"]},"type":"category"},"type":"page"},"id":3,"logo":{"type":"image","url":"https://hdn-1.fynd.com/media/banner_portrait/brand/original/540_ecba3a1af141467da8abc20500f983db.jpg"},"name":"Amy Kim DDS","uid":3}],"discount":"14% OFF","is_tryout":false,"item_code":"ITEM_CODE_3","item_type":"set","medias":[{"type":"image","url":"https://hdn-1.fynd.com/media/fynd_store_items/l2_category/original/2830_c5bb5fc02f414307a828c4c56483c30a.jpg"}],"name":"facilitate enterprise supply-chains","price":{"effective":{"currency_code":"INR","currency_symbol":"₹","max":1399,"min":1199},"marked":{"currency_code":"INR","currency_symbol":"₹","max":1499,"min":1399}},"promo_meta":{"subtitle":"","title":""},"rating":2.7,"sellable":true,"slug":"facilitate-enterprise-supply-chains","type":"product","uid":11},{"action":{"page":{"query":{"slug":"optimize-web-enabled-e-tailers"},"type":"product"},"type":"page"},"attributes":{"gender":"women","material":"Neoprene","primary_color":"DarkGrey","primary_color_hex":"808080","weight":"100"},"brand":{"_custom_json":{},"action":{"page":{"query":{"brand":["Hess-Inc"]},"type":"products"},"type":"page"},"logo":{"type":"image","url":"https://hdn-1.fynd.com/media/logo/brand/original/12391_0d956c6c71a4427895c15e44cba82f88.jpg"},"name":"Hess Inc","type":"brand"},"categories":[{"_custom_json":{},"action":{"page":{"query":{"category":["Amy-Kim-DDS"]},"type":"category"},"type":"page"},"id":3,"logo":{"type":"image","url":"https://hdn-1.fynd.com/media/banner_portrait/brand/original/540_ecba3a1af141467da8abc20500f983db.jpg"},"name":"Amy Kim DDS","uid":3}],"discount":"14% OFF","is_tryout":false,"item_code":"ITEM_CODE_4","item_type":"set","medias":[{"type":"image","url":"https://hdn-1.fynd.com/media/fynd_store_items/l2_category/original/2830_c5bb5fc02f414307a828c4c56483c30a.jpg"}],"name":"optimize web-enabled e-tailers","price":{"effective":{"currency_code":"INR","currency_symbol":"₹","max":1399,"min":1199},"marked":{"currency_code":"INR","currency_symbol":"₹","max":1499,"min":1399}},"promo_meta":{"subtitle":"","title":""},"rating":2.7,"sellable":true,"slug":"optimize-web-enabled-e-tailers","type":"product","uid":12}],"page":{"current":1,"has_next":true,"has_previous":false,"item_total":15,"total":2,"type":"number"},"sort_on":[{"display":"Latest Products.","is_selected":true,"logo":"https://d2zv4gzhlr4ud6.cloudfront.net/media/pictures/tagged_items/360x0/56_MKT02AI060CORAL/1_1567590349681.jpg","name":"Latest Products.","value":"latest"}]},"schema":{"$ref":"#/components/schemas/ApplicationProductListingResponse"}}},"description":"List of Products. See example below or refer `ApplicationProductListingResponse` for details"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"getAppicationProducts | List the products","tags":["Catalog"]}},"/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/products/{item_id}/inventory/{size_identifier}":{"get":{"description":"This API allows get Inventory data for particular company grouped by size and store.","parameters":[{"description":"Id of the company associated to product that is to be viewed.","in":"path","name":"company_id","required":true,"schema":{"type":"integer"}},{"description":"Uniquer Application ID.","in":"path","name":"application_id","required":true,"schema":{"type":"string"}},{"description":"Item code of the product of which size is to be get.","in":"path","name":"item_id","required":true,"schema":{"type":"integer"}},{"description":"Size Identifier (Seller Identifier or Primary Identifier) of which inventory is to get.","in":"path","name":"size_identifier","required":true,"schema":{"type":"string"}},{"description":"The page number to navigate through the given set of results","in":"query","name":"page_no","required":false,"schema":{"type":"integer"}},{"description":"Number of items to retrieve in each page. Default is 12.","in":"query","name":"page_size","required":false,"schema":{"default":12,"type":"integer"}},{"description":"Search with help of store code.","in":"query","name":"q","required":false,"schema":{"type":"string"}},{"description":"Search by store ids.","in":"query","name":"location_ids","required":false,"schema":{"items":{"type":"integer"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"example":{"items":[{"brand":{"id":1,"name":"ab"},"company":{"id":1},"country_of_origin":"","currency":"INR","dimension":{"height":15,"is_default":true,"length":10.5,"unit":"cm","width":5.2},"fragile":true,"fynd_article_code":"","fynd_item_code":"","identifier":{"article_id":1},"identifiers":[{"gtin_type":"sku_code","gtin_value":"RTYUIDSDFV","primary":true}],"inventory_updated_on":"2021-04-06T03:30:01.487000","item_id":7500651,"manufacturer":{"address":"st","is_default":true,"name":"manufacturer"},"price":{"currency":"USD","effective":79.99,"marked":99.99,"transfer":79.99},"price_effective":1234,"price_transfer":0,"quantity":10,"sellable_quantity":10,"seller_identifier":"RTYUIDSDFV","size":"AAX1 (1 PCS)","store":{"id":1},"total_quantity":1,"uid":"59_RTYUIDSDFV","weight":{"is_default":true,"shipping":1.5,"unit":"kg"}},{"brand":{"id":1,"name":"ab"},"company":{"id":1},"country_of_origin":"","currency":"INR","dimension":{"height":15,"is_default":true,"length":10.5,"unit":"cm","width":5.2},"fragile":true,"fynd_article_code":"","fynd_item_code":"","identifier":{"article_id":1},"identifiers":[{"gtin_type":"sku_code","gtin_value":"RTYUIDSDFV","primary":true}],"inventory_updated_on":"2021-04-06T03:29:35.291000","item_id":7500651,"manufacturer":{"address":"st","is_default":true,"name":"manufacturer"},"price":{"currency":"USD","effective":79.99,"marked":99.99,"transfer":79.99},"price_effective":1234,"price_transfer":0,"quantity":10,"sellable_quantity":10,"seller_identifier":"RTYUIDSDFV","size":"AAX1 (1 PCS)","store":{"id":1},"total_quantity":1,"uid":"10_RTYUIDSDFV","weight":{"is_default":true,"shipping":1.5,"unit":"kg"}},{"brand":{"id":1,"name":"ab"},"company":{"id":1},"country_of_origin":"","currency":"INR","dimension":{"height":15,"is_default":true,"length":10.5,"unit":"cm","width":5.2},"fragile":true,"fynd_article_code":"","fynd_item_code":"","identifier":{"article_id":1},"identifiers":[{"gtin_type":"sku_code","gtin_value":"RTYUIDSDFV","primary":true}],"inventory_updated_on":"2021-03-17T12:35:29.992000","item_id":7500651,"manufacturer":{"address":"st","is_default":true,"name":"manufacturer"},"order_committed_quantity":0,"price":{"currency":"USD","effective":79.99,"marked":99.99,"transfer":79.99},"price_effective":1234,"price_transfer":0,"quantity":10000000,"sellable_quantity":10000000,"seller_identifier":"RTYUIDSDFV","size":"AAX1 (1 PCS)","store":{"id":1},"total_quantity":1,"uid":"11061_RTYUIDSDFV","weight":{"is_default":true,"shipping":1.5,"unit":"kg"}},{"brand":{"id":1,"name":"ab"},"company":{"id":1},"country_of_origin":"","currency":"INR","damaged_quantity":0,"dimension":{"height":15,"is_default":true,"length":10.5,"unit":"cm","width":5.2},"fragile":true,"fynd_article_code":"","fynd_item_code":"","identifier":{"article_id":1},"identifiers":[{"gtin_type":"sku_code","gtin_value":"RTYUIDSDFV","primary":true}],"inventory_updated_on":"2021-03-31T19:00:10.943000","item_id":7500651,"manufacturer":{"address":"st","is_default":true,"name":"manufacturer"},"not_available_quantity":0,"order_committed_quantity":7,"price":{"currency":"USD","effective":79.99,"marked":99.99,"transfer":79.99},"price_effective":1234,"price_transfer":0,"quantity":39,"sellable_quantity":18,"seller_identifier":"RTYUIDSDFV","size":"AAX1 (1 PCS)","store":{"id":1},"total_quantity":1,"uid":"1_RTYUIDSDFV","weight":{"is_default":true,"shipping":1.5,"unit":"kg"}},{"brand":{"id":1,"name":"ab"},"company":{"id":1},"country_of_origin":"","currency":"INR","dimension":{"height":15,"is_default":true,"length":10.5,"unit":"cm","width":5.2},"fragile":true,"fynd_article_code":"","fynd_item_code":"","identifier":{"article_id":1},"identifiers":[{"gtin_type":"sku_code","gtin_value":"RTYUIDSDFV","primary":true}],"inventory_updated_on":"2020-07-07T10:37:06.146000","item_id":7500651,"manufacturer":{"address":"st","is_default":true,"name":"manufacturer"},"order_committed_quantity":39,"price":{"currency":"USD","effective":79.99,"marked":99.99,"transfer":79.99},"price_effective":1234,"price_transfer":0,"quantity":39,"sellable_quantity":0,"seller_identifier":"RTYUIDSDFV","size":"AAX1 (1 PCS)","store":{"id":1},"total_quantity":1,"uid":"1_rtyuidsdfv","weight":{"is_default":true,"shipping":1.5,"unit":"kg"}}],"page":{"current":1,"has_next":false,"has_previous":false,"item_total":5,"size":1,"type":"number"}},"schema":{"$ref":"#/components/schemas/InventorySellerIdentifierResponsePaginated"}}},"description":"returns a list of all inventory grouped by size and store"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"getDiscountedInventoryBySizeIdentifier | Get Inventory for company","tags":["Catalog"]}},"/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/products/{slug}":{"get":{"description":"Products are the core resource of an application. Products can be associated by categories, collections, brands and more. This API retrieves the product specified by the given **slug**. If successful, returns a Product resource in the response body specified in `ProductDetail`","parameters":[{"description":"A `company_id` is a unique identifier for a particular seller account.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"A `application_id` is a unique identifier for a particular sale channel.","in":"path","name":"application_id","required":true,"schema":{"type":"string"}},{"description":"The unique identifier of a product. i.e; `slug` of a product. You can retrieve these from the APIs that list products like **v1.0/products/**","in":"path","name":"slug","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"attributes":{"brand":"Barry, Jennings and Larson","color":"DarkGrey","color_hex":"808080","gender":["Men","Women"],"item_code":"LGLAPTOPSLEEVE5","material":"Neoprene","occasion":"Casual","primary_color":"Grey","primary_color_hex":"808080","primary_material":"Others","product_details":"This is a Unisex Product.","product_type":"LaptopBags","style_note":"Shape up your overall appeal with this stunning laptop bag. The amazing storage and great design will let you carry your laptop in style!","variant":"LGLAPTOPSLEEVE5","weight":100},"brand":{"_custom_json":{},"action":{"page":{"query":{"brand":["Hess-Inc"]},"type":"products"},"type":"page"},"logo":{"type":"image","url":"https://hdn-1.fynd.com/media/logo/brand/original/12391_0d956c6c71a4427895c15e44cba82f88.jpg"},"name":"Barry, Jennings and Larson","uid":1},"categories":[{"_custom_json":{},"action":{"page":{"query":{"category":["Amy-Kim-DDS"]},"type":"category"},"type":"page"},"id":3,"logo":{"type":"image","url":"https://hdn-1.fynd.com/media/banner_portrait/brand/original/540_ecba3a1af141467da8abc20500f983db.jpg"},"name":"Amy Kim DDS","uid":3}],"color":"808080","custom_order":{},"grouped_attributes":[{"details":[{"key":"Kimberly Davidson","type":"text","value":"DarkGrey"},{"key":"Kimberly Mcdaniel","type":"text","value":"Men,Women"},{"key":"Monica Hampton","type":"text","value":"Neoprene"},{"key":"John Mendoza","type":"text","value":"100 g"}],"title":"Alexander Sawyer"}],"has_variant":true,"image_nature":"standard","medias":[{"type":"image","url":"http://cdn4.gofynd.com/media/pictures/tagged_items/original/1309_LGLAPTOPSLEEVE5/1_1564735832806.jpg"}],"name":"benchmark collaborative paradigms","no_of_boxes":1,"product_online_date":"2021-02-03T07:22:29Z","rating":2.7,"rating_count":2,"similars":["brand"],"slug":"benchmark-collaborative-paradigms","tags":["Digital"],"teaser_tag":{},"tryouts":[],"type":"product","uid":1},"schema":{"$ref":"#/components/schemas/ProductDetail"}}},"description":"The Product object. See example below or refer `ProductDetail` for details."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"getProductDetailBySlug | Get a product","tags":["Catalog"]}},"/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/raw-products/":{"get":{"description":"Products are the core resource of an application. Products can be associated by categories, collections, brands and more. If successful, returns a Product resource in the response body specified in `ApplicationProductListingResponseDatabasePowered`","parameters":[{"description":"A `company_id` is a unique identifier for a particular seller account.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"A `application_id` is a unique identifier for a particular sale channel.","in":"path","name":"application_id","required":true,"schema":{"type":"string"}},{"description":"Get multiple products filtered by Brand Ids","in":"query","name":"brand_ids","required":false,"schema":{"items":{"type":"integer"},"type":"array"}},{"description":"Get multiple products filtered by Category Ids","in":"query","name":"category_ids","required":false,"schema":{"items":{"type":"integer"},"type":"array"}},{"description":"Get multiple products filtered by Department Ids","in":"query","name":"department_ids","required":false,"schema":{"items":{"type":"integer"},"type":"array"}},{"description":"Get multiple products filtered by tags","in":"query","name":"tags","required":false,"schema":{"items":{"type":"string"},"type":"array"}},{"description":"Get multiple products filtered by Item Ids","in":"query","name":"item_ids","required":false,"schema":{"items":{"type":"integer"},"type":"array"}},{"description":"The page number to navigate through the given set of results","in":"query","name":"page_no","required":false,"schema":{"type":"integer"}},{"description":"Number of items to retrieve in each page. Default is 10.","in":"query","name":"page_size","required":false,"schema":{"default":10,"type":"integer"}},{"description":"Search with Item Code, Name, Slug or Identifier.","in":"query","name":"q","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"items":[{"_custom_json":{},"all_company_ids":[1],"all_identifiers":["19WE100"],"all_sizes":[{"brand_uid":1,"company_id":1,"identifiers":[{"gtin_type":"ean","gtin_value":"HGS272727272","primary":true}],"item_code":"TVSET111","marked_price":35000,"seller_identifier":"HGS272727272","size":"XXLX23, MX11, LX67, XLX45 (146 PCS)"}],"brand":{"logo":{"aspect_ratio":"1:1","aspect_ratio_f":1,"secure_url":"https://hdn-1.jiox0.de/jioecomm/seller/pictures/logo/50x0/apple-7f951c/logo_apple.png","url":"https://hdn-1.jiox0.de/jioecomm/seller/pictures/logo/50x0/apple-7f951c/logo_apple.png"},"name":"Apple","uid":13},"brand_uid":1,"category_slug":"qled-television","category_uid":1,"country_of_origin":"India","created_by":{"user_id":"5","username":"919049753052_37528"},"created_on":"2021-04-02T15:43:59.410000Z","currency":"INR","custom_order":{"is_custom_order":true,"manufacturing_time":2,"manufacturing_time_unit":"days"},"departments":[1],"description":"Tv","highlights":["42 Inch"],"hsn_code":"11111111","id":"5f4f2f6371a5970001f13655","image_nature":"standard","images":["https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/original/5050407896640/8hn0-cPlN0-1.jpg","https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/original/5050407896640/1ODGjR9NLY-2.jpg","https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/original/5050407896640/mJqqfEQilY-3.jpg","https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/original/5050407896640/htM1r1aHwa-4.jpg"],"is_dependent":false,"is_image_less_product":false,"is_physical":true,"is_set":true,"item_code":"TVSET111","item_type":"set","l3_mapping":["electronics>qled_television"],"media":[{"type":"image","url":"https://hdn-1.addsale.com/x0/products/pictures/item/free/135x0/dcizgsG_Y-Tv-Set.png"}],"modified_by":{"user_id":"xxxxxxxxxxx","username":"xxxxxxxxxx"},"modified_on":"2021-04-02T15:43:59.410000Z","multi_size":true,"name":"TV Set","no_of_boxes":1,"price":{"effective":{"max":25000,"min":25000},"marked":{"max":35000,"min":35000}},"product_group_tag":[],"product_publish":{"is_set":false,"product_online_date":1627642009},"return_config":{"returnable":false,"time":0,"unit":"days"},"short_description":"","size_guide":"slim-fit-shirts-for-men","sizes":[{"size":"FGX33, GHX33 (66 PCS)","store_count":1},{"size":"XSE WE23X100 (100 PCS)","store_count":2},{"size":"XSEX100 (100 PCS)","store_count":3},{"size":"XXLX23, MX11, LX67, XLX45 (146 PCS)","store_count":3}],"slug":"tv-set","stage":"verified","synonyms":[],"tags":[],"teaser_tag":{},"template_tag":"television","trader":[{"address":["sdfdsfsdf"],"name":"asdasd"}],"trader_type":"Packer","uid":7501547,"variants":{},"verification_status":"pending","verified_by":{"user_id":"0","username":"Silverbolt"},"verified_on":"2021-04-02T15:43:59.410000Z"}],"page":{"current":1,"has_next":false,"has_previous":false,"item_total":1,"size":1,"type":"number"}},"schema":{"$ref":"#/components/schemas/RawProductListingResponse"}}},"description":"The Product object. See example below or refer `ApplicationProductListingResponseDatabasePowered` for details."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"getAppProducts | Get applicationwise products","tags":["Catalog"]}},"/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/return-config":{"get":{"description":"Get Product Return configuration set at an application level","parameters":[{"description":"A `company_id` is a unique identifier for a particular seller account.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"A `application_id` is a unique identifier for a particular sale channel.","in":"path","name":"application_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"app_id":"5d638512c9accedcd910591a","category_count":32,"company_id":1,"created_by":{"user_id":"054bb99f009aece85a3fa087","username":"test"},"modified_by":{"user_id":"054bb99f009aece85a3fa087","username":"test"},"modified_on":"2023-03-28T06:05:24.026000","return_config_level":"category"},"schema":{"$ref":"#/components/schemas/AppReturnConfigResponse"}}},"description":"success message will tell whether the operation was successful."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"getAppReturnConfiguration | Get Return configuration level set for an application","tags":["Catalog"]},"post":{"description":"Create Return configuration level set for an application.","parameters":[{"description":"A `company_id` is a unique identifier for a particular seller account.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"A `application_id` is a unique identifier for a particular sale channel.","in":"path","name":"application_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"default":{"value":{"app_id":"5d638512c9accedcd910591a","company_id":1,"return_config_level":"no-return"}}},"schema":{"$ref":"#/components/schemas/CreateUpdateAppReturnConfig"}}},"description":"The configuration for listings. See details below","required":true},"responses":{"200":{"content":{"application/json":{"examples":{"default":{"value":{"success":true}}},"schema":{"$ref":"#/components/schemas/SuccessResponse1"}}},"description":"success message will tell whether the operation was successful."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"createAppReturnConfiguration | Create Return configuration level set for an application","tags":["Catalog"]},"put":{"description":"Update Return configuration level set for an application.","parameters":[{"description":"A `company_id` is a unique identifier for a particular seller account.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"A `application_id` is a unique identifier for a particular sale channel.","in":"path","name":"application_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"default":{"value":{"app_id":"5d638512c9accedcd910591a","company_id":1,"return_config_level":"no-return"}}},"schema":{"$ref":"#/components/schemas/CreateUpdateAppReturnConfig"}}},"description":"The configuration for listings. See details below","required":true},"responses":{"200":{"content":{"application/json":{"examples":{"default":{"value":{"success":true}}},"schema":{"$ref":"#/components/schemas/SuccessResponse1"}}},"description":"success message will tell whether the operation was successful."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"updateAppReturnConfiguration | Update Return configuration level set for an application","tags":["Catalog"]}},"/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/return-config/categories":{"delete":{"description":"Delete Category level Application Return Configuration setttings","parameters":[{"description":"A `company_id` is a unique identifier for a particular seller account.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"A `application_id` is a unique identifier for a particular sale channel.","in":"path","name":"application_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"default":{"value":{"category_ids":[133],"app_id":"5d638512c9accedcd910591a","company_id":1}}},"schema":{"$ref":"#/components/schemas/DeleteAppCategoryReturnConfig"}}},"description":"The configuration for listings. See details below","required":true},"responses":{"200":{"content":{"application/json":{"examples":{"default":{"value":{"success":true}}},"schema":{"$ref":"#/components/schemas/SuccessResponse"}}},"description":"success message will tell whether the operation was successful."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"deleteAppCategoryReturnConfiguration | Delete Category level Application Return Configuration setttings","tags":["Catalog"]},"get":{"description":"Get all category level configuration level set for an application.","parameters":[{"description":"A `company_id` is a unique identifier for a particular seller account.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"A `application_id` is a unique identifier for a particular sale channel.","in":"path","name":"application_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"default":{"value":{"data":[{"app_id":"5d638512c9accedcd910591a","category_id":1659,"logo":"https://hdn-1.addsale.com/addsale/category/pictures/square-logo/original/7hR5xHVUi0-eTdgOunCZ-.jpeg","name":"MG TEST DIGITAL","return_config":{"returnable":true,"time":10,"unit":"days"}}],"page":{"current":"1","has_next":false,"has_previous":false,"item_total":1,"size":1,"type":"number"}}}},"schema":{"$ref":"#/components/schemas/BaseAppCategoryReturnConfigResponse"}}},"description":"success message will tell whether the operation was successful."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"getAppCategoryReturnConfig | Get all category level configuration level set for an application","tags":["Catalog"]},"post":{"description":"Create Category level Application Return Configuration setttings","parameters":[{"description":"A `company_id` is a unique identifier for a particular seller account.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"A `application_id` is a unique identifier for a particular sale channel.","in":"path","name":"application_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"default":{"value":{"app_id":"5d5fa86df301d79a91c4a9ff","company_id":1,"data":[{"category_id":133,"return_config":{"returnable":false,"time":0,"unit":"days"}}]}}},"schema":{"$ref":"#/components/schemas/BaseAppCategoryReturnConfig"}}},"description":"The configuration for listings. See details below","required":true},"responses":{"200":{"content":{"application/json":{"examples":{"default":{"value":{"success":true}}},"schema":{"$ref":"#/components/schemas/SuccessResponse1"}}},"description":"success message will tell whether the operation was successful."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"createAppCategoryReturnConfiguration | Create Category level Application Return Configuration setttings","tags":["Catalog"]},"put":{"description":"Update Category level Application Return Configuration setttings","parameters":[{"description":"A `company_id` is a unique identifier for a particular seller account.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"A `application_id` is a unique identifier for a particular sale channel.","in":"path","name":"application_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"default":{"value":{"app_id":"5d5fa86df301d79a91c4a9ff","company_id":1,"data":[{"category_id":133,"return_config":{"returnable":true,"time":10,"unit":"days"}}]}}},"schema":{"$ref":"#/components/schemas/BaseAppCategoryReturnConfig"}}},"description":"The configuration for listings. See details below","required":true},"responses":{"200":{"content":{"application/json":{"examples":{"default":{"value":{"success":true}}},"schema":{"$ref":"#/components/schemas/SuccessResponse"}}},"description":"success message will tell whether the operation was successful."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"updateAppCategoryReturnConfiguration | Update Category level Application Return Configuration setttings","tags":["Catalog"]}},"/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/search/autocomplete/":{"get":{"description":"Custom Autocomplete Keyword allows you to map conditions with keywords to give you the ultimate results","parameters":[{"description":"A `company_id` is a unique identifier for a particular seller account.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"A `application_id` is a unique identifier for a particular sale channel.","in":"path","name":"application_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"items":[{"app_id":"000000000000000000000001","is_active":true,"results":[{"_custom_json":{},"action":{"page":{"query":{"brand":["nike"]},"type":"products","url":"/products/?brand=nike"},"type":"page"},"display":"Helllow","logo":{"url":"https://hdn-1.addsale.com/addsale/company/61/applications/600a5b3fe0991a4718cdb448/company/1/application/000000000000000000000001/search/pictures/square-logo/original/n_8bvEaBw-Helllow.png"}}],"uid":"602fa1eaa596ce349563f6c6","words":["dasd"]}],"page":{"current":1,"has_next":false,"has_previous":false,"item_count":1,"size":1,"type":"number"}},"schema":{"$ref":"#/components/schemas/GetAutocompleteWordsResponse"}}},"description":"List of custom autocomplete keywords. See example below or refer `GetAutocompleteWordsResponseSchema` for details"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"getAutocompleteConfig | List all Autocomplete Keyword Listing","tags":["Catalog"]},"post":{"description":"Create a Custom Autocomplete Keywords. See `CreateAutocompleteKeywordSchema` for the list of attributes needed to create a mapping and /collections/query-options for the available options to create a rule. On successful request, returns a paginated list of collections specified in `CreateAutocompleteKeywordSchema`","parameters":[{"description":"A `company_id` is a unique identifier for a particular seller account.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"A `application_id` is a unique identifier for a particular sale channel.","in":"path","name":"application_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"app_id":"000000000000000000000001","is_active":true,"results":[{"_custom_json":{},"action":{"page":{"query":{"brand":["nike"]},"type":"products","url":"/products/?brand=nike"},"type":"page"},"display":"Helllow","logo":{"url":"https://hdn-1.addsale.com/addsale/company/61/applications/600a5b3fe0991a4718cdb448/company/1/application/000000000000000000000001/search/pictures/square-logo/original/n_8bvEaBw-Helllow.png"}}],"uid":"602fa1eaa596ce349563f6c6","words":["dasd"]},"schema":{"$ref":"#/components/schemas/CreateAutocompleteKeyword"}}},"description":"A Search Keywords object that needs to be added","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAutocompleteWordsResponse"}}},"description":"List of all the collections including the one you added. See example below or refer `CreateAutocompleteWordsResponseSchema` for details"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"createCustomAutocompleteRule | Add a Custom Autocomplete Keywords","tags":["Catalog"]}},"/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/search/autocomplete/{id}/":{"delete":{"description":"Delete a keywords by it's id. Returns an object that tells whether the keywords was deleted successfully","parameters":[{"description":"A `company_id` is a unique identifier for a particular seller account.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"A `application_id` is a unique identifier for a particular sale channel.","in":"path","name":"application_id","required":true,"schema":{"type":"string"}},{"description":"A `id` is a unique identifier for a particular detail. Pass the `id` of the keywords which you want to delete.","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"message":"Words Deleted"},"schema":{"$ref":"#/components/schemas/DeleteResponse"}}},"description":"Status object. Tells whether the operation was successful. See example below or refer `DeleteResponse`"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"deleteAutocompleteKeyword | Delete a Autocomplete Keywords","tags":["Catalog"]},"get":{"description":"Get the details of a words by its `id`. If successful, returns a keywords resource in the response body specified in `GetAutocompleteWordsResponseSchema`","parameters":[{"description":"A `company_id` is a unique identifier for a particular seller account.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"A `application_id` is a unique identifier for a particular sale channel.","in":"path","name":"application_id","required":true,"schema":{"type":"string"}},{"description":"A `id` is a unique identifier for a particular detail. Pass the `id` of the keywords which you want to retrieve.","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"app_id":"000000000000000000000001","is_active":true,"results":[{"_custom_json":{},"action":{"page":{"query":{"brand":["nike"]},"type":"products","url":"/products/?brand=nike"},"type":"page"},"display":"Helllow","logo":{"url":"https://hdn-1.addsale.com/addsale/company/61/applications/600a5b3fe0991a4718cdb448/company/1/application/000000000000000000000001/search/pictures/square-logo/original/n_8bvEaBw-Helllow.png"}}],"uid":"602fa1eaa596ce349563f6c6","words":["dasd"]},"schema":{"$ref":"#/components/schemas/GetAutocompleteWordsResponse"}}},"description":"The mapping object. See example below or refer `GetAutocompleteWordsResponseSchema` for details"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"getAutocompleteKeywordDetail | Get a Autocomplete Keywords Details","tags":["Catalog"]},"put":{"description":"Update a mapping by it's id. On successful request, returns the updated Keyword mapping","parameters":[{"description":"A `company_id` is a unique identifier for a particular seller account.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"A `application_id` is a unique identifier for a particular sale channel.","in":"path","name":"application_id","required":true,"schema":{"type":"string"}},{"description":"A `id` is a unique identifier for a particular detail. Pass the `id` of the keywords which you want to delete.","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAutocompleteKeyword"}}},"description":"A Autocomplete object that needs to be updated","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAutocompleteWordsResponse"}}},"description":"The Mapping object. See example below or refer `GetAutocompleteWordsResponseSchema` for details."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"updateAutocompleteKeyword | Create & Update Autocomplete Keyword","tags":["Catalog"]}},"/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/search/configuration/":{"delete":{"description":"This view allows you to reset search config for an application","parameters":[{"description":"A `company_id` is a unique identifier for a particular seller account.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"A `application_id` is a unique identifier for a particular sale channel.","in":"path","name":"application_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"success":true},"schema":{"$ref":"#/components/schemas/DeleteSearchConfigurationResponse"}}},"description":"Status of the delete operation. See `DeleteSearchConfigurationResponse` for details"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"deleteSearchConfiguration | Delete search configuration for an application","tags":["Catalog"]},"get":{"description":"This view allows you to add/modify searchable attributes for an application","parameters":[{"description":"A `company_id` is a unique identifier for a particular seller account.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"A `application_id` is a unique identifier for a particular sale channel.","in":"path","name":"application_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"application_id":"1234","company_id":1,"is_proximity_enabled":false,"proximity":2,"searchable_attributes":[{"key":"brand_uid","name":"","priority":1},{"key":"category_uid","name":"","priority":2}]},"schema":{"$ref":"#/components/schemas/GetSearchConfigurationResponse"}}},"description":"Search configuration for the specified application. See example below or refer `GetSearchConfigurationResponse` for details"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"getSearchConfiguration | List search configuration for an application","tags":["Catalog"]},"post":{"description":"This view allows you to modify searchable attributes for an application","parameters":[{"description":"A `company_id` is a unique identifier for a particular seller account.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"A `application_id` is a unique identifier for a particular sale channel.","in":"path","name":"application_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSearchConfigurationRequest"}}},"description":"Search configuration that needs to be created. See `CreateSearchConfigurationRequest` for details","required":true},"responses":{"200":{"content":{"application/json":{"example":{"application_id":1234,"company_id":1,"is_proximity_enabled":false,"proximity":2,"searchable_attributes":[{"key":"brand_uid","priority":1},{"key":"category_uid","priority":2}]},"schema":{"$ref":"#/components/schemas/CreateSearchConfigurationResponse"}}},"description":"List of custom search keywords. See example below or refer `CreateSearchConfigurationResponse` for details"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"createSearchConfiguration | Update search configuration for an application","tags":["Catalog"]},"put":{"description":"This view allows you to modify searchable attributes for an application","parameters":[{"description":"A `company_id` is a unique identifier for a particular seller account.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"A `application_id` is a unique identifier for a particular sale channel.","in":"path","name":"application_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSearchConfigurationRequest"}}},"description":"Search configuration that needs to be updated. See `UpdateSearchConfigurationRequest` for details","required":true},"responses":{"200":{"content":{"application/json":{"example":{"searchable_attributes":{}},"schema":{"$ref":"#/components/schemas/UpdateSearchConfigurationResponse"}}},"description":"List of custom search keywords. See example below or refer `UpdateSearchConfigurationResponse` for details"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"updateSearchConfiguration | Update search configuration for an application","tags":["Catalog"]}},"/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/search/keyword/":{"get":{"description":"Custom Search Keyword allows you to map conditions with keywords to give you the ultimate results","parameters":[{"description":"A `company_id` is a unique identifier for a particular seller account.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"A `application_id` is a unique identifier for a particular sale channel.","in":"path","name":"application_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"items":[{"_custom_json":{},"app_id":"000000000000000000000001","is_active":true,"result":{"query":{"department":["men"]},"sort_on":"popular"},"uid":"602fa1e9a596ce349563f6b9","words":["sds"]}],"page":{"current":1,"has_next":false,"has_previous":false,"item_count":1,"size":1,"type":"number"}},"schema":{"$ref":"#/components/schemas/GetSearchWordsResponse"}}},"description":"List of custom search keywords. See example below or refer `GetSearchWordsResponseSchema` for details"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"getAllSearchKeyword | List all Search Custom Keyword Listing","tags":["Catalog"]},"post":{"description":"Create a Custom Search Keywords. See `CreateSearchKeywordSchema` for the list of attributes needed to create a mapping and /collections/query-options for the available options to create a rule. On successful request, returns a paginated list of collections specified in `CreateSearchKeywordSchema`","parameters":[{"description":"A `company_id` is a unique identifier for a particular seller account.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"A `application_id` is a unique identifier for a particular sale channel.","in":"path","name":"application_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSearchKeyword"}}},"description":"A Search Keywords object that needs to be added","required":true},"responses":{"200":{"content":{"application/json":{"example":{"_custom_json":{},"app_id":"000000000000000000000001","is_active":true,"result":{"query":{"department":["men"]},"sort_on":"popular"},"uid":"602fa1e9a596ce349563f6b9","words":["sds"]},"schema":{"$ref":"#/components/schemas/GetSearchWordsData"}}},"description":"Get keyword object with id that is added. See example below or refer `GetSearchWordsDataSchema` for details"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"createCustomKeyword | Add a Custom Search Keywords","tags":["Catalog"]}},"/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/search/keyword/{id}/":{"delete":{"description":"Delete a keywords by it's id. Returns an object that tells whether the keywords was deleted successfully","parameters":[{"description":"A `company_id` is a unique identifier for a particular seller account.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"A `application_id` is a unique identifier for a particular sale channel.","in":"path","name":"application_id","required":true,"schema":{"type":"string"}},{"description":"A `id` is a unique identifier for a particular detail. Pass the `id` of the keywords which you want to delete.","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"message":"Words Deleted"},"schema":{"$ref":"#/components/schemas/DeleteResponse"}}},"description":"Status object. Tells whether the operation was successful. See example below or refer `DeleteResponse`"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"deleteSearchKeywords | Delete a Search Keywords","tags":["Catalog"]},"get":{"description":"Get the details of a words by its `id`. If successful, returns a Collection resource in the response body specified in `GetSearchWordsDetailResponseSchema`","parameters":[{"description":"A `company_id` is a unique identifier for a particular seller account.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"A `application_id` is a unique identifier for a particular sale channel.","in":"path","name":"application_id","required":true,"schema":{"type":"string"}},{"description":"A `id` is a unique identifier for a particular detail. Pass the `id` of the keywords which you want to retrieve.","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"_custom_json":{},"app_id":"000000000000000000000001","is_active":true,"result":{"query":{"department":["men"]},"sort_on":"popular"},"uid":"602fa1e9a596ce349563f6b9","words":["sds"]},"schema":{"$ref":"#/components/schemas/GetSearchWordsDetailResponse"}}},"description":"The Collection object. See example below or refer `GetSearchWordsDetailResponseSchema` for details"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"getSearchKeywords | Get a Search Keywords Details","tags":["Catalog"]},"put":{"description":"Update Search Keyword by its id. On successful request, returns the updated collection","parameters":[{"description":"A `company_id` is a unique identifier for a particular seller account.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"A `application_id` is a unique identifier for a particular sale channel.","in":"path","name":"application_id","required":true,"schema":{"type":"string"}},{"description":"A `id` is a unique identifier for a particular detail. Pass the `id` of the keywords which you want to delete.","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"_custom_json":{},"app_id":"000000000000000000000001","is_active":true,"result":{"query":{"department":["men"]},"sort_on":"popular"},"uid":"602fa1e9a596ce349563f6b9","words":["sds"]},"schema":{"$ref":"#/components/schemas/CreateSearchKeyword"}}},"description":"A Search Keywords object that needs to be added","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetSearchWordsData"}}},"description":"The Collection object. See example below or refer `GetSearchWordsDataSchema` for details."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"updateSearchKeywords | Update Search Keyword","tags":["Catalog"]}},"/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/store/{store_uid}":{"patch":{"description":"This API helps to update data associated to a item custom meta.","parameters":[{"description":"Id of the company associated to location custom json.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"application id for which the custom_json is associated.","in":"path","name":"application_id","required":true,"schema":{"type":"string"}},{"description":"store id for which the custom_json is associated.","in":"path","name":"store_uid","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"_custom_json":{"sample_key_1":"Sample Value 1","sample_key_2":"Sample Value 2"}},"schema":{"$ref":"#/components/schemas/ApplicationStoreJson"}}},"description":"custom json object that needs to be added.","required":true},"responses":{"200":{"content":{"application/json":{"example":{"success":true},"schema":{"$ref":"#/components/schemas/SuccessResponse1"}}},"description":"Returns a success response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"updateAppLocation | Update a single custom json.","tags":["Catalog"]}},"/service/platform/catalog/v1.0/company/{company_id}/category/":{"get":{"description":"This API gets meta associated to product categories.","parameters":[{"description":"A `company_id` is a unique identifier for a particular seller account.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"Get category for multiple levels","in":"query","name":"level","required":false,"schema":{"type":"string"}},{"description":"Get category for multiple departments filtered","in":"query","name":"department","required":false,"schema":{"type":"integer"}},{"description":"Get multiple categories filtered by search string","in":"query","name":"q","required":false,"schema":{"type":"string"}},{"description":"The page number to navigate through the given set of results","in":"query","name":"page_no","required":false,"schema":{"type":"integer"}},{"description":"Number of items to retrieve in each page. Default is 10.","in":"query","name":"page_size","required":false,"schema":{"default":12,"type":"integer"}},{"description":"Get multiple categories filtered by category uids.","in":"query","name":"uids","schema":{"type":"array","items":{"type":"integer"},"maxItems":100},"required":false},{"in":"query","name":"slug","description":"Get category by slug","schema":{"type":"string"},"required":false}],"responses":{"200":{"content":{"application/json":{"example":{"items":[{"created_by":{"user_id":"5646","username":"917972410891_48194"},"created_on":"2021-04-02T15:43:59.410000Z","departments":[1],"hierarchy":[{"department":1,"l1":1,"l2":22329}],"id":"60673bbf7896da00017885ad","is_active":true,"level":3,"marketplaces":{},"media":{"landscape":"https://hdn-1.addsale.com/x0/category/pictures/landscape-banner/original/_7GDi3tyi-.png","logo":"https://hdn-1.addsale.com/x0/category/pictures/square-logo/original/zTgh1zslj-.png","portrait":"https://hdn-1.addsale.com/x0/category/pictures/portrait-banner/original/VKqwRngFh-.png"},"modified_by":{"user_id":"5646","username":"917972410891_48194"},"modified_on":"2021-04-02T15:43:59.410000Z","name":"Air Conditioners","priority":1,"slug":"air-conditioners","synonyms":[],"tryouts":[],"uid":22330},{"created_by":{"user_id":"5646","username":"917972410891_48194"},"created_on":"2021-04-02T15:42:55.405000Z","departments":[1],"hierarchy":[],"id":"60673b7f7896da00017885ac","is_active":true,"level":2,"media":{"landscape":"https://hdn-1.addsale.com/x0/category/pictures/landscape-banner/original/_7GDi3tyi-.png","logo":"https://hdn-1.addsale.com/x0/category/pictures/square-logo/original/zTgh1zslj-.png","portrait":"https://hdn-1.addsale.com/x0/category/pictures/portrait-banner/original/VKqwRngFh-.png"},"modified_by":{"user_id":"5646","username":"917972410891_48194"},"modified_on":"2021-04-02T15:42:55.405000Z","name":"Home Appliances","priority":1,"slug":"home-appliances","synonyms":[],"uid":22329},{"created_by":{"user_id":"5721","username":"919821012599_75351"},"created_on":"2021-01-14T05:28:02.148000Z","departments":[21],"hierarchy":[],"id":"5fffd662e64eb40001fc8a42","is_active":true,"level":2,"media":{"landscape":"https://hdn-1.addsale.com/x0/category/pictures/landscape-banner/original/0wCdjxWpI-.png","logo":"https://hdn-1.addsale.com/x0/category/pictures/square-logo/original/zTgh1zslj-.png","portrait":"https://hdn-1.addsale.com/x0/category/pictures/portrait-banner/original/VKqwRngFh-.png"},"modified_by":{"user_id":"5677","username":"917753852478_51632"},"modified_on":"2021-03-04T15:43:50.495000Z","name":"Dummy category level 2 by fahim","priority":123456,"slug":"dummy-category-level-2","synonyms":["skin","care","asdasd"],"uid":22323},{"created_by":{"user_id":"-1","username":"silverbolt"},"created_on":"2021-02-25T00:00:47.589000Z","departments":[21],"hierarchy":[{"department":21,"l1":22322,"l2":22323}],"id":"60369b57d23031d14be92c18","is_active":true,"level":3,"marketplaces":{},"media":{"landscape":"https://hdn-1.addsale.com/x0/category/pictures/landscape-banner/original/0wCdjxWpI-.png","logo":"https://hdn-1.addsale.com/x0/category/pictures/square-logo/original/EfCt9iXx8-http/d3p8ifzkmzds37.cloudfront.net/media/logo/department/original/15870_c287d3c2431a432bb0e49363ef6b82bc.png.jpeg","portrait":"https://hdn-1.addsale.com/x0/category/pictures/portrait-banner/original/S1axCMOJ4-.png"},"modified_by":{"user_id":"5677","username":"917753852478_51632"},"modified_on":"2021-03-04T15:39:52.108000Z","name":"Dummy level 4","priority":986532,"slug":"dummy-level-4","synonyms":[],"tryouts":[],"uid":22325},{"created_by":{"user_id":"5721","username":"919821012599_75351"},"created_on":"2021-01-14T05:28:59.852000Z","departments":[2,4,21],"hierarchy":[{"department":21,"l1":22322,"l2":22323},{"department":4,"l1":3672,"l2":3732},{"department":2,"l1":595,"l2":730}],"id":"5fffd69be64eb40001fc8a65","is_active":true,"level":3,"marketplaces":{},"media":{"landscape":"https://hdn-1.addsale.com/x0/category/pictures/landscape-banner/original/0wCdjxWpI-.png","logo":"https://hdn-1.addsale.com/x0/category/pictures/square-logo/original/EfCt9iXx8-http/d3p8ifzkmzds37.cloudfront.net/media/logo/department/original/15870_c287d3c2431a432bb0e49363ef6b82bc.png.jpeg","portrait":"https://hdn-1.addsale.com/x0/category/pictures/portrait-banner/original/S1axCMOJ4-.png"},"modified_by":{"user_id":"5677","username":"917753852478_51632"},"modified_on":"2021-03-04T15:39:46.246000Z","name":"Dummy level 3 by fahim","priority":986532,"slug":"dummy-level-3","synonyms":[],"tryouts":["Lipstick","Eyeliner"],"uid":22324},{"created_on":"2016-04-09T06:44:35Z","departments":[4],"hierarchy":[],"id":"5fabab8ea18a1284b97ff6c4","is_active":true,"level":1,"media":{"landscape":"https://hdn-1.addsale.com/x0/seller/pictures/logo/original/ywPVrU_preview_a637ca6e4da6e38f03eb0d650ac5d6ba.jpgc73cc22f-b5ee-4fd4-a585-8ada35762d68/ywPVrU_preview_a637ca6e4da6e38f03eb0d650ac5d6ba.jpg","logo":"https://hdn-1.addsale.com/x0/seller/pictures/logo/original/YHIeoQ_fruit___vegetable_logo.jpg16aab608-a78a-458f-b60b-524525f27dec/YHIeoQ_fruit___vegetable_logo.jpg","portrait":"https://hdn-1.addsale.com/x0/seller/pictures/logo/original/ywPVrU_preview_a637ca6e4da6e38f03eb0d650ac5d6ba.jpgc73cc22f-b5ee-4fd4-a585-8ada35762d68/ywPVrU_preview_a637ca6e4da6e38f03eb0d650ac5d6ba.jpg"},"modified_by":{"uid":"5677","username":"917753852478_51632"},"modified_on":"2021-03-03T09:35:50.415000Z","name":"Gourmet & World Food","priority":123,"slug":"gourmet-world-food","synonyms":["gourmet & world food","food","gourmet"],"uid":3151},{"created_by":{"uid":"5677","username":"917753852478_51632"},"created_on":"2021-03-03T06:30:08.342000Z","departments":[1,2],"hierarchy":[{"department":2,"l1":595,"l2":714},{"department":1,"l1":2,"l2":4}],"id":"603f2cf0aac0360001c00731","is_active":true,"level":3,"marketplaces":{},"media":{"landscape":"https://hdn-1.addsale.com/x0/category/pictures/landscape-banner/original/0wCdjxWpI-.png","logo":"https://hdn-1.addsale.com/x0/category/pictures/square-logo/original/EfCt9iXx8-http/d3p8ifzkmzds37.cloudfront.net/media/logo/department/original/15870_c287d3c2431a432bb0e49363ef6b82bc.png.jpeg","portrait":"https://hdn-1.addsale.com/x0/category/pictures/portrait-banner/original/VKqwRngFh-.png"},"modified_by":{"uid":"5677","username":"917753852478_51632"},"modified_on":"2021-03-03T08:34:47.999000Z","name":"Test Category kaf","priority":23,"slug":"test-category-kaf","synonyms":["test","category"],"tryouts":["Lipstick","Blush"],"uid":22328},{"created_by":{"user_id":"-1","username":"silverbolt"},"created_on":"2021-02-25T09:26:53.123000Z","departments":[1],"hierarchy":[{"department":1,"l1":2,"l2":3}],"id":"60372005d230311fe9e51f0b","is_active":false,"level":3,"marketplaces":{},"media":{"landscape":"https://hdn-1.fynd.com/media/banner/category/original/16128_380bed8bff064a0b981041df65e0d8b3.jpg","logo":"http://d3p8ifzkmzds37.cloudfront.net/media/logo/department/original/15870_c287d3c2431a432bb0e49363ef6b82bc.png","portrait":"http://cdn4.gofynd.com/media/logo/department/original/13239_660c6f5b2b8d458789de4552d241ea1b.jpg"},"modified_by":{"user_id":"-1","username":"silverbolt"},"modified_on":"2021-02-25T09:26:53.123000Z","name":"Smart Cell","priority":5,"slug":"smart-cell","synonyms":[],"tryouts":[],"uid":22327},{"created_by":{"user_id":"-1","username":"silverbolt"},"created_on":"2021-02-25T00:09:35.026000Z","departments":[21],"hierarchy":[{"department":21,"l1":22322,"l2":22323}],"id":"60369d67d2303111b8924dcf","is_active":true,"level":3,"marketplaces":{},"media":{"landscape":"https://hdn-1.addsale.com/x0/category/pictures/landscape-banner/original/0wCdjxWpI-.png","logo":"https://hdn-1.addsale.com/x0/category/pictures/square-logo/original/EfCt9iXx8-http/d3p8ifzkmzds37.cloudfront.net/media/logo/department/original/15870_c287d3c2431a432bb0e49363ef6b82bc.png.jpeg","portrait":"https://hdn-1.addsale.com/x0/category/pictures/portrait-banner/original/S1axCMOJ4-.png"},"modified_by":{"user_id":"-1","username":"silverbolt"},"modified_on":"2021-02-25T00:09:35.026000Z","name":"Dummy level 98","priority":986532,"slug":"dummy-level-98","synonyms":[],"tryouts":[],"uid":22326},{"created_on":"2016-04-09T06:44:35Z","departments":[2,3],"hierarchy":[{"department":2,"l1":65,"l2":66},{"department":2,"l1":442,"l2":26},{"department":3,"l1":442,"l2":26}],"id":"5fdba984642de8d93efb0d71","is_active":true,"level":3,"marketplaces":{},"media":{"landscape":"https://hdn-1.fynd.com/media/banner/category/original/19961_f042f1f4a90f4e828b6d77d6dbea264d.jpg","logo":"https://hdn-1.fynd.com/media/logo/category/original/81ef023d375044e9b9daa66b81ec411f.jpg","portrait":"https://hdn-1.fynd.com/media/banner_portrait/category/original/19960_c679d51cb1bd4ca99f00f9050aa647a4.jpg"},"modified_by":{"user_id":"5677","username":"917753852478_51632"},"modified_on":"2021-02-15T15:48:05.329000Z","name":"Sports Bra","priority":281,"slug":"sports-bra","synonyms":["Sports Bra","activewear bra","gym bra"],"tryouts":[],"uid":315}],"page":{"current":1,"has_next":true,"has_previous":false,"item_total":574,"size":58,"type":"number"}},"schema":{"$ref":"#/components/schemas/CategoryResponse"}}},"description":"Category Meta. See example below or refer `CategoryResponse` for details"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"listCategories | Get product categories list","tags":["Catalog"]},"post":{"description":"This API lets user create product categories","parameters":[{"description":"A `company_id` is a unique identifier for a particular seller account.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategoryRequestBody"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"message":"Success","uid":0},"schema":{"$ref":"#/components/schemas/CategoryCreateResponse"}}},"description":"Category Meta. See example below or refer `CategoryCreateResponse` for details"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"createCategories | Create product categories","tags":["Catalog"]}},"/service/platform/catalog/v1.0/company/{company_id}/category/{uid}/":{"get":{"description":"This API gets meta associated to product categories.","parameters":[{"description":"A `company_id` is a unique identifier for a particular seller account.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"Category unique id","in":"path","name":"uid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"created_by":{"user_id":"5646","username":"917972410891_48194"},"created_on":"2021-04-02T15:43:59.410000Z","departments":[1],"hierarchy":[{"department":1,"l1":1,"l2":22329}],"id":"60673bbf7896da00017885ad","is_active":true,"level":3,"marketplaces":{},"media":{"landscape":"https://hdn-1.addsale.com/x0/category/pictures/landscape-banner/original/nsi0nJ6gX-landscape.png","logo":"https://hdn-1.addsale.com/x0/category/pictures/square-logo/original/zTgh1zslj-.png","portrait":"https://hdn-1.addsale.com/x0/category/pictures/portrait-banner/original/_4p7Kz9Yp-banner.png"},"modified_by":{"user_id":"16","username":"nikhilmhatre_gofynd_com_97636"},"modified_on":"2021-04-13T13:57:56.443000Z","name":"Air Conditioners","priority":1,"slug":"air-conditioners","synonyms":[],"tryouts":[],"uid":22330}},"schema":{"$ref":"#/components/schemas/SingleCategoryResponse"}}},"description":"Get Data for one category. See example below or refer `CategoryResponse` for details"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"getCategoryData | Get product category by uid","tags":["Catalog"]},"put":{"description":"Update a product category using this api","parameters":[{"description":"A `company_id` is a unique identifier for a particular seller account.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"Category unique id","in":"path","name":"uid","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategoryRequestBody"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategoryUpdateResponse"}}},"description":"Category Meta. See example below or refer `CategoryUpdateResponse` for details"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"updateCategory | Update product categories","tags":["Catalog"]}},"/service/platform/catalog/v1.0/company/{company_id}/cross-selling/{seller_app_id}/analytics/insights/":{"get":{"description":"Analytics data of catalog and inventory that are being cross-selled.","parameters":[{"description":"A `company_id` is a unique identifier for a particular seller account.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"Id of the seller application which is serving the invetory/catalog of the company","in":"path","name":"seller_app_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"articles":18,"products":18},"schema":{"$ref":"#/components/schemas/CrossSellingResponse"}}},"description":"Response Data"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"getSellerInsights | Analytics data of catalog and inventory that are being cross-selled.","tags":["Catalog"]}},"/service/platform/catalog/v1.0/company/{company_id}/departments/":{"get":{"description":"Allows you to list all departments, also can search using name and filter active and incative departments, and item type.","parameters":[{"description":"A `company_id` is a unique identifier for a particular seller account.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"The page number to navigate through the given set of results","in":"query","name":"page_no","required":false,"schema":{"type":"integer"}},{"description":"A `item_type` is a type of product eg. set, standard, digital","in":"query","name":"item_type","required":false,"schema":{"type":"string"}},{"description":"Number of items to retrieve in each page. Default is 10.","in":"query","name":"page_size","required":false,"schema":{"type":"integer"}},{"description":"Can search departments by passing name.","in":"query","name":"name","required":false,"schema":{"type":"string"}},{"description":"Can search departments by passing name of the department in search parameter.","in":"query","name":"search","required":false,"schema":{"type":"string"}},{"description":"Can query for departments based on whether they are active or inactive.","in":"query","name":"is_active","required":false,"schema":{"type":"boolean"}},{"in":"query","name":"slug","description":"Can filter by slug","schema":{"type":"string"},"required":false}],"responses":{"200":{"content":{"application/json":{"example":{"items":[{"_cls":"Department","_custom_json":{},"created_by":{"user_id":"3","username":"918793638893_86554"},"created_on":"2020-07-01T05:33:39.325000Z","id":"5efc2033623d390001782238","is_active":true,"logo":"https://hdn-1.addsale.com/x0/seller/pictures/logo/original/BSQ9Gk_123522-best-starry-sky-wallpaper-1920x1200-ipad-pro.jpgc7d0c15c-c1ff-47eb-8423-6e2df51f2ddf/BSQ9Gk_123522-best-starry-sky-wallpaper-1920x1200-ipad-pro.jpg","modified_by":{"user_id":"5677","username":"917753852478_51632"},"modified_on":"2021-03-03T15:55:25.118000Z","name":"Sample Dept","platforms":{},"priority_order":111,"slug":"sample-dept","synonyms":["test","sampe"],"tags":[],"uid":5},{"_cls":"Department","_custom_json":{},"created_by":{"user_id":"0","username":"app@fynd.com"},"created_on":"2020-05-19T06:53:37.629000Z","id":"5ec3827156a7200001c9aeea","is_active":true,"logo":"https://hdn-1.addsale.com/addsale/media/logo/department/original/15974_381e2236c2a348cc851c29a5d05c66a9.png","modified_by":{"user_id":"10","username":"fahimsakri_gofynd_com_44938"},"modified_on":"2021-03-04T14:01:02.556000Z","name":"Men's Fashion","platforms":{"fynd":true,"fynd_store":true,"marketplace":true,"openapi":true,"uniket_store":true,"uniket_wholesale":true},"priority_order":111,"slug":"men-s-fashion","synonyms":[],"tags":[],"uid":2},{"_cls":"Department","_custom_json":{},"created_by":{"user_id":"10","username":"fahimsakri_gofynd_com_44938"},"created_on":"2020-06-29T10:59:33.620000Z","id":"5ef9c9959b04f00001e40dba","is_active":true,"logo":"https://hdn-1.addsale.com/x0/seller/pictures/logo/original/ywPVrU_preview_a637ca6e4da6e38f03eb0d650ac5d6ba.jpgc73cc22f-b5ee-4fd4-a585-8ada35762d68/ywPVrU_preview_a637ca6e4da6e38f03eb0d650ac5d6ba.jpg","modified_by":{"user_id":"3","username":"918793638893_86554"},"modified_on":"2020-08-06T18:08:02.675000Z","name":"Groceries","platforms":{},"priority_order":10,"slug":"groceries","synonyms":[],"tags":[],"uid":4},{"_cls":"Department","_custom_json":{},"created_by":{"user_id":"0","username":"app@fynd.com"},"created_on":"2020-05-18T16:14:41.689000Z","id":"5ec2b471661a4100019fca0d","is_active":true,"logo":"https://hdn-1.addsale.com/x0/platform/pictures/free-logo/original/_G1Z2Fg1L-http:d3p8ifzkmzds37.cloudfront.netmedialogodepartmentoriginal15870_c287d3c2431a432bb0e49363ef6b82bc.png.png","modified_by":{"user_id":"5677","username":"917753852478_51632"},"modified_on":"2021-03-04T15:39:38.528000Z","name":"Electronics","platforms":{"fynd":true,"fynd_store":true,"marketplace":true,"openapi":true,"uniket_store":true,"uniket_wholesale":true},"priority_order":100,"slug":"electronics","synonyms":[],"tags":[],"uid":1},{"_cls":"Department","_custom_json":{},"created_by":{"user_id":"3","username":"918793638893_86554"},"created_on":"2020-05-27T12:04:19.111000Z","id":"5ece5743cd1bae0001440427","is_active":true,"logo":"https://hdn-1.addsale.com/x0/seller/pictures/landscape-banner/original/g2plam_logo_Jio.pngeeb392ca-3958-46a0-9f13-23c205b596f7/g2plam_logo_Jio.png","modified_by":{"user_id":"3","username":"918793638893_86554"},"modified_on":"2020-08-06T18:07:46.060000Z","name":"Industrial Supplies","platforms":{},"priority_order":111,"slug":"industrial-supplies","synonyms":[],"tags":[],"uid":3},{"_cls":"Department","_custom_json":{},"created_by":{"user_id":"13","username":"abhinavsrivastava_gofynd_com_05674"},"created_on":"2020-07-06T07:56:01.508000Z","id":"5f02d9116b0ae500018923dd","is_active":false,"logo":"https://hdn-1.addsale.com/x0/seller/pictures/logo/original/wTcfEi_crysis_-_1.jpg14580947-a659-486d-b2d3-d2ca025b1cac/wTcfEi_crysis_-_1.jpg","modified_by":{"user_id":"3","username":"918793638893_86554"},"modified_on":"2020-08-06T18:08:12.576000Z","name":"Clothing","platforms":{},"priority_order":1,"slug":"clothing","synonyms":[],"tags":[],"uid":6},{"_cls":"Department","_custom_json":{},"created_by":{"user_id":"5634","username":"asavarijadhav_gofynd_com_99880"},"created_on":"2020-08-05T09:04:33.604000Z","id":"5f2a762131c66700018cdc47","is_active":true,"logo":"https://hdn-1.addsale.com/x0/seller/pictures/logo/original/RxTsd8_0DEFAULT-LOGO.jpg000ccfc1-2f79-4426-9ac3-de2468c2fcb9/RxTsd8_0DEFAULT-LOGO.jpg","modified_by":{"user_id":"5634","username":"asavarijadhav_gofynd_com_99880"},"modified_on":"2020-08-05T09:44:01.234000Z","name":"Kids","platforms":{},"priority_order":3,"slug":"kids","synonyms":[],"tags":[],"uid":8},{"_cls":"Department","_custom_json":{},"created_by":{"user_id":"5634","username":"asavarijadhav_gofynd_com_99880"},"created_on":"2020-08-05T09:44:46.632000Z","id":"5f2a7f8e31c66700018cdc49","is_active":true,"logo":"https://hdn-1.addsale.com/x0/seller/pictures/logo/original/tKkDB8_0DEFAULT-LOGO.jpg1c324d4d-f667-4af8-8d98-37205d34e3b5/tKkDB8_0DEFAULT-LOGO.jpg","modified_by":{"user_id":"3","username":"918793638893_86554"},"modified_on":"2020-08-06T18:07:35.231000Z","name":"Women's Fashion","platforms":{},"priority_order":2,"slug":"women-s-fashion","synonyms":[],"tags":[],"uid":9},{"_cls":"Department","_custom_json":{},"created_by":{"user_id":"5634","username":"asavarijadhav_gofynd_com_99880"},"created_on":"2020-08-05T09:45:12.075000Z","id":"5f2a7fa831c66700018cdc4a","is_active":true,"logo":"https://hdn-1.addsale.com/x0/seller/pictures/logo/original/oLoxiL_0DEFAULT-LOGO.jpgbd050200-700a-4a3e-9da6-e6b78fbee943/oLoxiL_0DEFAULT-LOGO.jpg","modified_by":{"user_id":"5634","username":"asavarijadhav_gofynd_com_99880"},"modified_on":"2020-08-05T09:48:01.660000Z","name":"Beauty & Personal Care","platforms":{},"priority_order":4,"slug":"beauty-personal-care","synonyms":[],"tags":[],"uid":10},{"_cls":"Department","_custom_json":{},"created_by":{"user_id":"5634","username":"asavarijadhav_gofynd_com_99880"},"created_on":"2020-08-05T09:45:39.797000Z","id":"5f2a7fc331c66700018cdc4b","is_active":true,"logo":"https://hdn-1.addsale.com/x0/seller/pictures/logo/original/vQv4ot_0DEFAULT-LOGO.jpg701cb5af-2024-4abf-ae5d-b68bc1a3cd43/vQv4ot_0DEFAULT-LOGO.jpg","modified_by":{"user_id":"3","username":"918793638893_86554"},"modified_on":"2020-08-06T11:38:57.599000Z","name":"Home & Living","platforms":{},"priority_order":5,"slug":"home-living","synonyms":[],"tags":[],"uid":11},{"_cls":"Department","_custom_json":{},"created_by":{"user_id":"5634","username":"asavarijadhav_gofynd_com_99880"},"created_on":"2020-08-05T09:48:42.347000Z","id":"5f2a807a31c66700018cdc4e","is_active":false,"logo":"https://hdn-1.addsale.com/x0/seller/pictures/logo/original/hTobjV_0DEFAULT-LOGO.jpga020159c-7fe7-4c1c-a11a-4be61a60da9f/hTobjV_0DEFAULT-LOGO.jpg","modified_by":{"user_id":"5634","username":"asavarijadhav_gofynd_com_99880"},"modified_on":"2020-08-05T09:48:42.347000Z","name":"Baby Care & Kids Essentials","platforms":{},"priority_order":7,"slug":"baby-care-kids-essentials","synonyms":[],"tags":[],"uid":14},{"_cls":"Department","_custom_json":{},"created_by":{"user_id":"5721","username":"919821012599_75351"},"created_on":"2021-01-13T10:12:33.002000Z","id":"5ffec79192813f0001eb6560","is_active":true,"logo":"https://hdn-1.addsale.com/x0/department/pictures/square-logo/original/rNz8grLys-.png","modified_by":{"user_id":"5721","username":"919821012599_75351"},"modified_on":"2021-01-13T13:50:55.415000Z","name":"Skin care products","platforms":{},"priority_order":10235,"slug":"skin-care-produts","synonyms":["skin","care"],"tags":[],"uid":21}],"page":{"current":1,"has_next":false,"has_previous":false,"item_total":12,"size":1,"type":"number"}},"schema":{"$ref":"#/components/schemas/DepartmentsResponse"}}},"description":"List of departments data. See example below or refer `DepartmentsResponse` for details"},"4XX":{"content":{"application/json":{"example":{"code":"400","message":"Invalid filter"},"schema":{"$ref":"#/components/schemas/DepartmentErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"listDepartmentsData | List all Departments.","tags":["Catalog"]},"post":{"description":"Create departments using the API.","parameters":[{"description":"A `company_id` is a unique identifier for a particular seller account.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"is_active":true,"logo":"https://hdn-1.addsale.com/x0/department/pictures/square-logo/original/xKDsQBbu4-department.png","name":"Fashion","priority_order":1,"slug":"fashion","synonyms":["fashion","mensfashion"]},"schema":{"$ref":"#/components/schemas/DepartmentCreateUpdate"}}},"description":"the data of the departments that needs to be added","required":true},"responses":{"200":{"content":{"application/json":{"example":{"message":"Success","uid":2},"schema":{"$ref":"#/components/schemas/DepartmentCreateResponse"}}},"description":"Success Response. See example below or refer `DepartmentCreateResponseSchema` for details"},"4XX":{"content":{"application/json":{"example":{"error":"Invalid filter"},"schema":{"$ref":"#/components/schemas/DepartmentCreateErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"createDepartments | Create the department.","tags":["Catalog"]}},"/service/platform/catalog/v1.0/company/{company_id}/departments/{uid}/":{"get":{"description":"Allows you to get department data, by uid.","parameters":[{"description":"A `company_id` is a unique identifier for a particular seller account.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"A `uid` is a unique identifier of a department.","in":"path","name":"uid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"items":[{"_cls":"Department","_custom_json":{},"created_by":{"user_id":"3","username":"918793638893_86554"},"created_on":"2020-07-01T05:33:39.325000Z","id":"5efc2033623d390001782238","is_active":true,"logo":"https://hdn-1.addsale.com/x0/seller/pictures/logo/original/BSQ9Gk_123522-best-starry-sky-wallpaper-1920x1200-ipad-pro.jpgc7d0c15c-c1ff-47eb-8423-6e2df51f2ddf/BSQ9Gk_123522-best-starry-sky-wallpaper-1920x1200-ipad-pro.jpg","modified_by":{"user_id":"5677","username":"917753852478_51632"},"modified_on":"2021-03-03T15:55:25.118000Z","name":"Sample Dept","platforms":{},"priority_order":111,"slug":"sample-dept","synonyms":["test","sampe"],"tags":[],"uid":5},{"_cls":"Department","_custom_json":{},"created_by":{"user_id":"0","username":"app@fynd.com"},"created_on":"2020-05-19T06:53:37.629000Z","id":"5ec3827156a7200001c9aeea","is_active":true,"logo":"https://hdn-1.addsale.com/addsale/media/logo/department/original/15974_381e2236c2a348cc851c29a5d05c66a9.png","modified_by":{"user_id":"10","username":"fahimsakri_gofynd_com_44938"},"modified_on":"2021-03-04T14:01:02.556000Z","name":"Men's Fashion","platforms":{"fynd":true,"fynd_store":true,"marketplace":true,"openapi":true,"uniket_store":true,"uniket_wholesale":true},"priority_order":111,"slug":"men-s-fashion","synonyms":[],"tags":[],"uid":2},{"_cls":"Department","_custom_json":{},"created_by":{"user_id":"10","username":"fahimsakri_gofynd_com_44938"},"created_on":"2020-06-29T10:59:33.620000Z","id":"5ef9c9959b04f00001e40dba","is_active":true,"logo":"https://hdn-1.addsale.com/x0/seller/pictures/logo/original/ywPVrU_preview_a637ca6e4da6e38f03eb0d650ac5d6ba.jpgc73cc22f-b5ee-4fd4-a585-8ada35762d68/ywPVrU_preview_a637ca6e4da6e38f03eb0d650ac5d6ba.jpg","modified_by":{"user_id":"3","username":"918793638893_86554"},"modified_on":"2020-08-06T18:08:02.675000Z","name":"Groceries","platforms":{},"priority_order":10,"slug":"groceries","synonyms":[],"tags":[],"uid":4},{"_cls":"Department","_custom_json":{},"created_by":{"user_id":"0","username":"app@fynd.com"},"created_on":"2020-05-18T16:14:41.689000Z","id":"5ec2b471661a4100019fca0d","is_active":true,"logo":"https://hdn-1.addsale.com/x0/platform/pictures/free-logo/original/_G1Z2Fg1L-http:d3p8ifzkmzds37.cloudfront.netmedialogodepartmentoriginal15870_c287d3c2431a432bb0e49363ef6b82bc.png.png","modified_by":{"user_id":"5677","username":"917753852478_51632"},"modified_on":"2021-03-04T15:39:38.528000Z","name":"Electronics","platforms":{"fynd":true,"fynd_store":true,"marketplace":true,"openapi":true,"uniket_store":true,"uniket_wholesale":true},"priority_order":100,"slug":"electronics","synonyms":[],"tags":[],"uid":1},{"_cls":"Department","_custom_json":{},"created_by":{"user_id":"3","username":"918793638893_86554"},"created_on":"2020-05-27T12:04:19.111000Z","id":"5ece5743cd1bae0001440427","is_active":true,"logo":"https://hdn-1.addsale.com/x0/seller/pictures/landscape-banner/original/g2plam_logo_Jio.pngeeb392ca-3958-46a0-9f13-23c205b596f7/g2plam_logo_Jio.png","modified_by":{"user_id":"3","username":"918793638893_86554"},"modified_on":"2020-08-06T18:07:46.060000Z","name":"Industrial Supplies","platforms":{},"priority_order":111,"slug":"industrial-supplies","synonyms":[],"tags":[],"uid":3},{"_cls":"Department","_custom_json":{},"created_by":{"user_id":"13","username":"abhinavsrivastava_gofynd_com_05674"},"created_on":"2020-07-06T07:56:01.508000Z","id":"5f02d9116b0ae500018923dd","is_active":false,"logo":"https://hdn-1.addsale.com/x0/seller/pictures/logo/original/wTcfEi_crysis_-_1.jpg14580947-a659-486d-b2d3-d2ca025b1cac/wTcfEi_crysis_-_1.jpg","modified_by":{"user_id":"3","username":"918793638893_86554"},"modified_on":"2020-08-06T18:08:12.576000Z","name":"Clothing","platforms":{},"priority_order":1,"slug":"clothing","synonyms":[],"tags":[],"uid":6},{"_cls":"Department","_custom_json":{},"created_by":{"user_id":"5634","username":"asavarijadhav_gofynd_com_99880"},"created_on":"2020-08-05T09:04:33.604000Z","id":"5f2a762131c66700018cdc47","is_active":true,"logo":"https://hdn-1.addsale.com/x0/seller/pictures/logo/original/RxTsd8_0DEFAULT-LOGO.jpg000ccfc1-2f79-4426-9ac3-de2468c2fcb9/RxTsd8_0DEFAULT-LOGO.jpg","modified_by":{"user_id":"5634","username":"asavarijadhav_gofynd_com_99880"},"modified_on":"2020-08-05T09:44:01.234000Z","name":"Kids","platforms":{},"priority_order":3,"slug":"kids","synonyms":[],"tags":[],"uid":8},{"_cls":"Department","_custom_json":{},"created_by":{"user_id":"5634","username":"asavarijadhav_gofynd_com_99880"},"created_on":"2020-08-05T09:44:46.632000Z","id":"5f2a7f8e31c66700018cdc49","is_active":true,"logo":"https://hdn-1.addsale.com/x0/seller/pictures/logo/original/tKkDB8_0DEFAULT-LOGO.jpg1c324d4d-f667-4af8-8d98-37205d34e3b5/tKkDB8_0DEFAULT-LOGO.jpg","modified_by":{"user_id":"3","username":"918793638893_86554"},"modified_on":"2020-08-06T18:07:35.231000Z","name":"Women's Fashion","platforms":{},"priority_order":2,"slug":"women-s-fashion","synonyms":[],"tags":[],"uid":9},{"_cls":"Department","_custom_json":{},"created_by":{"user_id":"5634","username":"asavarijadhav_gofynd_com_99880"},"created_on":"2020-08-05T09:45:12.075000Z","id":"5f2a7fa831c66700018cdc4a","is_active":true,"logo":"https://hdn-1.addsale.com/x0/seller/pictures/logo/original/oLoxiL_0DEFAULT-LOGO.jpgbd050200-700a-4a3e-9da6-e6b78fbee943/oLoxiL_0DEFAULT-LOGO.jpg","modified_by":{"user_id":"5634","username":"asavarijadhav_gofynd_com_99880"},"modified_on":"2020-08-05T09:48:01.660000Z","name":"Beauty & Personal Care","platforms":{},"priority_order":4,"slug":"beauty-personal-care","synonyms":[],"tags":[],"uid":10},{"_cls":"Department","_custom_json":{},"created_by":{"user_id":"5634","username":"asavarijadhav_gofynd_com_99880"},"created_on":"2020-08-05T09:45:39.797000Z","id":"5f2a7fc331c66700018cdc4b","is_active":true,"logo":"https://hdn-1.addsale.com/x0/seller/pictures/logo/original/vQv4ot_0DEFAULT-LOGO.jpg701cb5af-2024-4abf-ae5d-b68bc1a3cd43/vQv4ot_0DEFAULT-LOGO.jpg","modified_by":{"user_id":"3","username":"918793638893_86554"},"modified_on":"2020-08-06T11:38:57.599000Z","name":"Home & Living","platforms":{},"priority_order":5,"slug":"home-living","synonyms":[],"tags":[],"uid":11},{"_cls":"Department","_custom_json":{},"created_by":{"user_id":"5634","username":"asavarijadhav_gofynd_com_99880"},"created_on":"2020-08-05T09:48:42.347000Z","id":"5f2a807a31c66700018cdc4e","is_active":false,"logo":"https://hdn-1.addsale.com/x0/seller/pictures/logo/original/hTobjV_0DEFAULT-LOGO.jpga020159c-7fe7-4c1c-a11a-4be61a60da9f/hTobjV_0DEFAULT-LOGO.jpg","modified_by":{"user_id":"5634","username":"asavarijadhav_gofynd_com_99880"},"modified_on":"2020-08-05T09:48:42.347000Z","name":"Baby Care & Kids Essentials","platforms":{},"priority_order":7,"slug":"baby-care-kids-essentials","synonyms":[],"tags":[],"uid":14},{"_cls":"Department","_custom_json":{},"created_by":{"user_id":"5721","username":"919821012599_75351"},"created_on":"2021-01-13T10:12:33.002000Z","id":"5ffec79192813f0001eb6560","is_active":true,"logo":"https://hdn-1.addsale.com/x0/department/pictures/square-logo/original/rNz8grLys-.png","modified_by":{"user_id":"5721","username":"919821012599_75351"},"modified_on":"2021-01-13T13:50:55.415000Z","name":"Skin care products","platforms":{},"priority_order":10235,"slug":"skin-care-produts","synonyms":["skin","care"],"tags":[],"uid":21}],"page":{"type":""}},"schema":{"$ref":"#/components/schemas/DepartmentsResponse"}}},"description":"Departments Data. See example below or refer `DepartmentsResponse` for details"},"4XX":{"content":{"application/json":{"example":{"code":"400","message":"Invalid filter"},"schema":{"$ref":"#/components/schemas/DepartmentErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"getDepartmentData | Get specific departments details by passing in unique id of the department.","tags":["Catalog"]},"put":{"description":"Update the department by their uid using this API.","parameters":[{"description":"A `company_id` is a unique identifier for a particular seller account.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"A `uid` is a unique identifier of a department.","in":"path","name":"uid","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"created_on":"2021-04-02T15:43:59.410000Z","is_active":true,"logo":"https://hdn-1.addsale.com/x0/department/pictures/square-logo/original/xKDsQBbu4-department.png","name":"Fashion","priority_order":1,"slug":"fashion","synonyms":["fashion","mensfashion"]},"schema":{"$ref":"#/components/schemas/DepartmentCreateUpdate"}}},"description":"Data of the department that needs to be added","required":true},"responses":{"200":{"content":{"application/json":{"example":{"created_on":"2021-04-02T15:43:59.410000Z","is_active":true,"logo":"https://hdn-1.addsale.com/x0/department/pictures/square-logo/original/xKDsQBbu4-department.png","modified_by":{"user_id":"f5b6a546565146sdfg584c342","username":"31315573458_05620"},"modified_on":"2022-08-09T15:44:02.540740","name":"Fashion","priority_order":1,"slug":"fashion","synonyms":["fashion","mensfashion"],"uid":2},"schema":{"$ref":"#/components/schemas/DepartmentModel"}}},"description":"Success Response. See example below or refer `DepartmentCreateResponseSchema` for details"},"4XX":{"content":{"application/json":{"example":{"error":"Invalid filter"},"schema":{"$ref":"#/components/schemas/DepartmentCreateErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"updateDepartment | Update the department by their uid.","tags":["Catalog"]}},"/service/platform/catalog/v1.0/company/{company_id}/downloads/configuration/":{"get":{"description":"The filter type query parameter defines what type of data to return. The type of query returns the valid values for the same","parameters":[{"description":"A `company_id` is a unique identifier for a particular seller account.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"A `filter` is the unique identifier of the type of value required.","in":"query","name":"filter","required":true,"schema":{"type":"string"}},{"description":"A `template_tag` is the identifier of the type of template required.","in":"query","name":"template_tag","required":false,"schema":{"type":"string"}},{"description":"A `item_type` is the identifier of the type of template required.","in":"query","name":"item_type","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"display":"csv","value":"csv"},{"display":"excel","value":"excel"}],"multivalue":false},"schema":{"$ref":"#/components/schemas/ProductConfigurationDownloads"}}},"description":"See example below or refer `ProductConfigurationDownloadsSchema` for details"},"4XX":{"content":{"application/json":{"example":{"code":"400","message":"Company not found."},"schema":{"$ref":"#/components/schemas/PTErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"listTemplateBrandTypeValues | Allows you to list all values for Templates, Brands or Type","tags":["Catalog"]}},"/service/platform/catalog/v1.0/company/{company_id}/hsn/bulk/":{"post":{"description":"Bulk Create or Update Hsn Code.","parameters":[{"description":"company id","in":"path","name":"company_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"data":[{"company_id":1,"hs2_code":"xx","hsn_code":"xxxxxxxx","tax1":0,"tax2":0,"tax_on_esp":true,"tax_on_mrp":false,"threshold1":999999,"threshold2":0}]},"schema":{"$ref":"#/components/schemas/BulkHsnUpsert"}}},"description":"Bulk Create or Update Hsn Schema","required":true},"responses":{"200":{"content":{"application/json":{"example":{"success":true},"schema":{"$ref":"#/components/schemas/BulkHsnResponse"}}},"description":"See example below for details"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request."}},"summary":"bulkHsnCode | Bulk Create or Update Hsn Code.","tags":["Catalog"]}},"/service/platform/catalog/v1.0/company/{company_id}/hsn/{id}/":{"get":{"description":"Fetch Hsn Code.","parameters":[{"description":"company id","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"Unique id","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"company_id":1,"hs2_code":"xx","hsn_code":"xxxxxxxx","id":"xxxxxxxxxxxx","modified_by":{"user_id":"0","username":"narutouzumaki"},"slabs":[{"tax":0,"threshold":999999},{"tax":0,"threshold":0}],"tax_on":"esp"}},"schema":{"$ref":"#/components/schemas/HsnCode"}}},"description":"See example below details"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request."}},"summary":"getHsnCode | Fetch Hsn Code.","tags":["Catalog"]},"put":{"description":"Update Hsn Code.","parameters":[{"description":"company id","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"Unique id","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"company_id":1,"hs2_code":"xx","hsn_code":"xxxxxxxx","tax1":0,"tax2":0,"tax_on_esp":true,"tax_on_mrp":false,"threshold1":999999,"threshold2":0},"schema":{"$ref":"#/components/schemas/HsnUpsert"}}},"description":"Update Hsn Schema","required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"company_id":1,"hs2_code":"xx","hsn_code":"xxxxxxxx","id":"xxxxxxxxxxxx","modified_by":{"user_id":"0","username":"narutouzumaki"},"slabs":[{"tax":0,"threshold":999999},{"tax":0,"threshold":0}],"tax_on":"esp"}},"schema":{"$ref":"#/components/schemas/HsnCode"}}},"description":"See example below for details"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request."}},"summary":"updateHsnCode | Update Hsn Code.","tags":["Catalog"]}},"/service/platform/catalog/v1.0/company/{company_id}/inventories":{"get":{"description":"This API allows get Inventories data for particular company.","parameters":[{"description":"Id of the company associated to product that is to be viewed.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"Item code of the product of which size is to be get.","in":"query","name":"item_id","required":false,"schema":{"type":"string"}},{"description":"Size of which inventory is to get.","in":"query","name":"size","required":false,"schema":{"type":"string"}},{"description":"The page number to navigate through the given set of results","in":"query","name":"page_no","required":false,"schema":{"type":"integer"}},{"description":"Number of items to retrieve in each page. Default is 12.","in":"query","name":"page_size","required":false,"schema":{"default":12,"type":"integer"}},{"description":"Search with help of store code.","in":"query","name":"q","required":false,"schema":{"type":"string"}},{"description":"Filter on whether product is in stock or not.","in":"query","name":"sellable","required":false,"schema":{"default":false,"type":"boolean"}},{"description":"The Store Id of products to fetch inventory.","in":"query","name":"store_ids","required":false,"schema":{"items":{"type":"integer"},"type":"array"}},{"description":"Size Identifier (Seller Identifier or Primary Identifier) of which inventory is to get.","in":"query","name":"size_identifier","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"items":[{"brand":{"id":355},"company":{"id":46},"country_of_origin":"Malaysia","created_by":{"user_id":"68c3800d602c0fda0dab4fea","username":"abhishekbhakurlekar_gofynd_com_63787"},"date_meta":{"added_on_store":"2023-01-20T07:26:18.834000","created_on":"2023-01-20T07:26:18.828000","inventory_updated_on":"2023-01-20T07:26:18.828000","modified_on":"2023-01-20T07:26:18.828000"},"dimension":{"height":10,"length":25,"unit":"cm","width":15},"expiration_date":"9998-01-30T23:59:00","id":"63ca421a6fb0ce930685f46e","identifier":{"alu":"410163085004","upc":"777697046"},"is_set":false,"manufacturer":{"address":"5TH FLOOR, COURT HOUSE,LOKMANYA TILAK MARGA, DHOBI TALAOMUMBAI MAHARASHTRA, , MAHARASHTRA, MUMBAI","is_default":true,"name":"RELIANCE BRANDS LIMITED"},"modified_by":{"user_id":"68c3800d602c0fda0dab4fea","username":"abhishekbhakurlekar_gofynd_com_63787"},"platforms":{"fynd":false,"uniket_wholesale":false},"price":{"currency":"INR","effective":8000,"marked":8000,"transfer":0},"quantities":{"sellable":{"count":12}},"return_config":{"returnable":true,"time":30,"unit":"days"},"seller_identifier":"410163085004","size":"S","stage":"verified","store":{"name":"Khan Market","store_code":"THR1","store_type":"high_street","uid":10444},"tax_identifier":{"hsn_code_id":"000000000000000000000001"},"total_quantity":12,"trace_id":"inventory.bb475064-9893-11ed-88db-2efc0f0504bd","track_inventory":true,"trader":[{"address":["Brooks Brothers India Private Limited registered address is 8th Floor, Maker Tower 'E' Cuffe Parade Mumbai MH 400005 IN"],"name":"Imported & Marketed by Brooks Brothers India Pvt.Ltd","type":"Importer"}],"uid":"10444_410163085004","weight":{"shipping":999,"unit":"gram"}},{"brand":{"id":355},"company":{"id":46},"country_of_origin":"Malaysia","created_by":{"user_id":"68c3800d602c0fda0dab4fea","username":"abhishekbhakurlekar_gofynd_com_63787"},"date_meta":{"added_on_store":"2023-01-16T05:25:49.491000","created_on":"2023-01-16T05:25:49.482000","inventory_updated_on":"2023-01-16T05:25:49.482000","modified_on":"2023-01-16T05:25:49.482000"},"dimension":{"height":10,"length":25,"unit":"cm","width":15},"expiration_date":"9998-01-30T23:59:00","id":"63c4dfdd11e44ffd96d600bc","identifier":{"alu":"410163085005","upc":"777697038"},"is_set":false,"manufacturer":{"address":"5TH FLOOR, COURT HOUSE,LOKMANYA TILAK MARGA, DHOBI TALAOMUMBAI MAHARASHTRA, , MAHARASHTRA, MUMBAI","is_default":true,"name":"RELIANCE BRANDS LIMITED"},"modified_by":{"user_id":"68c3800d602c0fda0dab4fea","username":"abhishekbhakurlekar_gofynd_com_63787"},"platforms":{"fynd":false,"uniket_wholesale":false},"price":{"currency":"INR","effective":8000,"marked":8000,"transfer":0},"quantities":{"sellable":{"count":12}},"return_config":{"returnable":true,"time":30,"unit":"days"},"seller_identifier":"410163085005","size":"M","stage":"verified","store":{"name":"Khan Market","store_code":"THR1","store_type":"high_street","uid":10444},"tax_identifier":{"hsn_code_id":"000000000000000000000001"},"total_quantity":12,"trace_id":"inventory.3c9a25e4-955e-11ed-8584-92a07e366903","track_inventory":true,"trader":[{"address":["Brooks Brothers India Private Limited registered address is 8th Floor, Maker Tower 'E' Cuffe Parade Mumbai MH 400005 IN"],"name":"Imported & Marketed by Brooks Brothers India Pvt.Ltd","type":"Importer"}],"uid":"10444_410163085005","weight":{"shipping":999,"unit":"gram"}},{"brand":{"id":355},"company":{"id":46},"country_of_origin":"Malaysia","created_by":{"user_id":"bc5fbaf5e6f4b5288e9a9a22","username":"sagardhiman_gofynd_com_43846"},"date_meta":{"added_on_store":"2023-01-05T10:45:41.988000","created_on":"2023-01-05T10:45:41.979000","inventory_updated_on":"2023-01-19T10:37:00.504000","modified_on":"2023-01-19T10:37:00.504000"},"dimension":{"height":10,"length":25,"unit":"cm","width":15},"expiration_date":"9998-01-30T23:59:00","id":"63b6aa5558bf3ed100740c10","identifier":{"alu":"410163085004","upc":"777697046"},"is_set":false,"manufacturer":{"address":"5TH FLOOR, COURT HOUSE,LOKMANYA TILAK MARGA, DHOBI TALAOMUMBAI MAHARASHTRA, , MAHARASHTRA, MUMBAI","is_default":true,"name":"RELIANCE BRANDS LIMITED"},"modified_by":{"user_id":"68c3800d602c0fda0dab4fea","username":"abhishekbhakurlekar_gofynd_com_63787"},"platforms":{"fynd":false,"uniket_wholesale":false},"price":{"currency":"INR","effective":7001,"marked":8000,"transfer":0},"quantities":{"damaged":{"count":0},"not_available":{"count":0},"sellable":{"count":5001}},"return_config":{"returnable":true,"time":30,"unit":"days"},"seller_identifier":"410163085004","size":"S","stage":"verified","store":{"name":"Reliance 2","store_code":"R591","store_type":"warehouse","uid":11336},"tax_identifier":{"hsn_code_id":"000000000000000000000001"},"total_quantity":5001,"trace_id":"inventory.3485e8b4-97e5-11ed-a9d9-5eca1fff6de0","track_inventory":true,"trader":[{"address":["Brooks Brothers India Private Limited registered address is 8th Floor, Maker Tower 'E' Cuffe Parade Mumbai MH 400005 IN"],"name":"Imported & Marketed by Brooks Brothers India Pvt.Ltd","type":"Importer"}],"uid":"11336_410163085004","weight":{"shipping":999,"unit":"gram"}},{"brand":{"id":355},"company":{"id":46},"country_of_origin":"Malaysia","created_by":{"user_id":"5f200182ee4d3377e83330c2","username":"meghanakate_gofynd_com_58351"},"date_meta":{"added_on_store":"2022-11-29T11:17:42.271000","created_on":"2022-11-29T11:17:42.263000","inventory_updated_on":"2022-11-29T11:18:35.183000","modified_on":"2022-11-29T11:18:35.183000"},"dimension":{"height":10,"length":25,"unit":"cm","width":15},"expiration_date":"9998-01-30T23:59:00","id":"6385ea569715e74d8a92ce88","identifier":{"alu":"410163085001","upc":"777697079"},"is_set":false,"manufacturer":{"address":"5TH FLOOR, COURT HOUSE,LOKMANYA TILAK MARGA, DHOBI TALAOMUMBAI MAHARASHTRA, , MAHARASHTRA, MUMBAI","is_default":true,"name":"RELIANCE BRANDS LIMITED"},"modified_by":{"user_id":"5f200182ee4d3377e83330c2","username":"meghanakate_gofynd_com_58351"},"platforms":{"fynd":false,"uniket_wholesale":false},"price":{"currency":"INR","effective":8000,"marked":8000,"transfer":0},"quantities":{"damaged":{"count":0},"not_available":{"count":0},"sellable":{"count":1000}},"return_config":{"returnable":true,"time":30,"unit":"days"},"seller_identifier":"410163085001","size":"XXL","stage":"verified","store":{"name":"Shopsense Retail Technologies","store_code":"SRT91","store_type":"warehouse","uid":11701},"tax_identifier":{"hsn_code_id":"000000000000000000000001"},"total_quantity":1000,"track_inventory":true,"trader":[{"address":["Brooks Brothers India Private Limited registered address is 8th Floor, Maker Tower 'E' Cuffe Parade Mumbai MH 400005 IN"],"name":"Imported & Marketed by Brooks Brothers India Pvt.Ltd","type":"Importer"}],"uid":"11701_410163085001","weight":{"shipping":999,"unit":"gram"}},{"brand":{"id":355},"company":{"id":46},"country_of_origin":"Malaysia","created_by":{"user_id":"5f200182ee4d3377e83330c2","username":"meghanakate_gofynd_com_58351"},"date_meta":{"added_on_store":"2022-11-29T11:17:34.431000","created_on":"2022-11-29T11:17:34.424000","inventory_updated_on":"2022-11-29T11:18:27.331000","modified_on":"2022-11-29T11:18:27.331000"},"dimension":{"height":10,"length":25,"unit":"cm","width":15},"expiration_date":"9998-01-30T23:59:00","id":"6385ea4e9715e74d8a92ce86","identifier":{"alu":"410163085003","upc":"777697053"},"is_set":false,"manufacturer":{"address":"5TH FLOOR, COURT HOUSE,LOKMANYA TILAK MARGA, DHOBI TALAOMUMBAI MAHARASHTRA, , MAHARASHTRA, MUMBAI","is_default":true,"name":"RELIANCE BRANDS LIMITED"},"modified_by":{"user_id":"5f200182ee4d3377e83330c2","username":"meghanakate_gofynd_com_58351"},"platforms":{"fynd":false,"uniket_wholesale":false},"price":{"currency":"INR","effective":8000,"marked":8000,"transfer":0},"quantities":{"damaged":{"count":0},"not_available":{"count":0},"sellable":{"count":1000}},"return_config":{"returnable":true,"time":30,"unit":"days"},"seller_identifier":"410163085003","size":"XL","stage":"verified","store":{"name":"Shopsense Retail Technologies","store_code":"SRT91","store_type":"warehouse","uid":11701},"tax_identifier":{"hsn_code_id":"000000000000000000000001"},"total_quantity":1000,"track_inventory":true,"trader":[{"address":["Brooks Brothers India Private Limited registered address is 8th Floor, Maker Tower 'E' Cuffe Parade Mumbai MH 400005 IN"],"name":"Imported & Marketed by Brooks Brothers India Pvt.Ltd","type":"Importer"}],"uid":"11701_410163085003","weight":{"shipping":999,"unit":"gram"}}],"page":{"current":1,"has_next":false,"has_previous":false,"item_total":5,"size":1,"type":"number"}},"schema":{"$ref":"#/components/schemas/GetInventoriesResponse"}}},"description":"returns a list of all inventory grouped by size and store"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"getInventories | Get Inventory for company","tags":["Catalog"]}},"/service/platform/catalog/v1.0/company/{company_id}/inventory/bulk/":{"get":{"description":"This API helps to get bulk Inventory upload jobs data.","parameters":[{"description":"Company Id of of which Inventory Bulk Upload History to be obtained.","in":"path","name":"company_id","required":true,"schema":{"type":"integer"}},{"description":"The page number to navigate through the given set of results","in":"query","name":"page_no","required":false,"schema":{"type":"integer"}},{"description":"Number of items to retrieve in each page. Default is 12.","in":"query","name":"page_size","required":false,"schema":{"default":12,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"example":{"items":[{"cancelled":0,"cancelled_records":[],"company_id":1,"created_by":{"full_name":"Nikhil Mhatre","user_id":"16","username":"nikhilmhatre_gofynd_com_97636"},"created_on":"2021-03-11T10:54:44.998000Z","failed":0,"failed_records":[],"file_path":"https://hdn-1.addsale.com/x0/company/1/self/documents/inventory-import/free/original/50DbgKLND-NtnL_EAVb-REicn1sDv-V8ZrKdnLt-product_inventory.csv","id":"6049f6f5723043000125a9ea","is_active":true,"modified_by":{"user_id":"0","username":"Silverbolt"},"modified_on":"2021-03-11T10:54:45.296000Z","stage":"completed","succeed":1,"total":1},{"cancelled":0,"cancelled_records":[],"company_id":1,"created_by":{"user_id":"-1","username":"silverbolt"},"created_on":"2021-03-04T09:46:51.714000Z","failed":0,"failed_records":[],"file_path":"https://hdn-1.addsale.com/x0/company/1/self/documents/inventory-import/free/original/NtnL_EAVb-REicn1sDv-V8ZrKdnLt-product_inventory.csv","id":"6040ac8b1803830001fcc1ed","is_active":true,"modified_by":{"user_id":"0","username":"Silverbolt"},"modified_on":"2021-03-04T09:46:55.349000Z","stage":"completed","succeed":1,"total":1},{"cancelled":0,"cancelled_records":[],"company_id":1,"created_by":{"user_id":"-1","username":"silverbolt"},"created_on":"2021-03-04T09:22:32.222000Z","failed":0,"failed_records":[],"file_path":"https://hdn-1.addsale.com/x0/company/1/self/documents/inventory-import/free/original/bmBZY9iAX-REicn1sDv-V8ZrKdnLt-product_inventory.csv","id":"6040a6d8104f110001a85061","is_active":true,"modified_by":{"user_id":"-1","username":"silverbolt"},"modified_on":"2021-03-04T09:22:32.222000Z","stage":"terminated","succeed":0,"total":1},{"cancelled":0,"cancelled_records":[],"company_id":1,"created_by":{"user_id":"-1","username":"silverbolt"},"created_on":"2021-03-04T09:20:29.719000Z","failed":0,"failed_records":[],"file_path":"https://hdn-1.addsale.com/x0/company/1/self/documents/inventory-import/free/original/m73yWRT3v-REicn1sDv-V8ZrKdnLt-product_inventory.csv","id":"6040a65d104f110001a85060","is_active":true,"modified_by":{"user_id":"-1","username":"silverbolt"},"modified_on":"2021-03-04T09:20:29.719000Z","stage":"terminated","succeed":0,"total":1},{"cancelled":0,"cancelled_records":[],"company_id":1,"created_by":{"user_id":"-1","username":"silverbolt"},"created_on":"2021-03-04T08:50:49.367000Z","failed":0,"failed_records":[],"file_path":"https://hdn-1.addsale.com/x0/company/1/self/documents/inventory-import/free/original/W9lxe19Uu-REicn1sDv-V8ZrKdnLt-product_inventory.csv","id":"60409f699b21e30001c1e6b5","is_active":true,"modified_by":{"user_id":"-1","username":"silverbolt"},"modified_on":"2021-03-04T08:50:49.367000Z","stage":"terminated","succeed":0,"total":1},{"cancelled":0,"cancelled_records":[],"company_id":1,"created_by":{"full_name":"Sourabh Nilakhe","user_id":"5646","username":"917972410891_48194"},"created_on":"2021-02-10T10:57:57.236000Z","failed":0,"failed_records":[],"file_path":"https://hdn-1.addsale.com/x0/company/1/self/documents/inventory-import/free/original/REicn1sDv-V8ZrKdnLt-product_inventory.csv","id":"6023bc35c85ca1000171e08a","is_active":true,"modified_by":{"user_id":"0","username":"Silverbolt"},"modified_on":"2021-02-10T10:57:57.571000Z","stage":"completed","succeed":1,"total":1},{"cancelled":0,"cancelled_records":[],"company_id":1,"created_by":{"full_name":"Sourabh Nilakhe","user_id":"5646","username":"917972410891_48194"},"created_on":"2021-02-10T10:57:22.535000Z","failed":0,"failed_records":[],"file_path":"https://hdn-1.addsale.com/x0/company/1/self/documents/inventory-import/free/original/Oth_LaVyI-V8ZrKdnLt-product_inventory.csv","id":"6023bc12c85ca1000171e089","is_active":true,"modified_by":{"user_id":"0","username":"Silverbolt"},"modified_on":"2021-02-10T10:57:23.311000Z","stage":"completed","succeed":1,"total":1},{"cancelled":0,"cancelled_records":[],"company_id":1,"created_by":{"full_name":"Nikhil Mhatre","user_id":"16","username":"nikhilmhatre_gofynd_com_97636"},"created_on":"2021-01-13T13:58:06.155000Z","failed":0,"failed_records":[],"file_path":"https://hdn-1.addsale.com/x0/company/1/self/documents/inventory-import/free/original/V8ZrKdnLt-product_inventory.csv","id":"5ffefc6ee2db8f000183fab8","is_active":true,"modified_by":{"user_id":"0","username":"Silverbolt"},"modified_on":"2021-01-13T13:58:06.369000Z","stage":"completed","succeed":1,"total":1},{"cancelled":0,"cancelled_records":[],"company_id":1,"created_by":{"full_name":"Nikhil Mhatre","user_id":"16","username":"nikhilmhatre_gofynd_com_97636"},"created_on":"2021-01-13T13:57:38.598000Z","failed":1,"failed_records":[],"file_path":"https://hdn-1.addsale.com/x0/company/1/self/documents/inventory-import/free/original/t3T6X2Riy-product_inventory.csv","id":"5ffefc5252f31100012ea981","is_active":true,"modified_by":{"user_id":"0","username":"Silverbolt"},"modified_on":"2021-01-13T13:57:38.832000Z","stage":"failed","succeed":0,"total":1},{"cancelled":0,"cancelled_records":[],"company_id":1,"created_by":{"full_name":"Nikhil Mhatre","user_id":"16","username":"nikhilmhatre_gofynd_com_97636"},"created_on":"2021-01-13T13:57:13.639000Z","failed":1,"failed_records":[],"file_path":"https://hdn-1.addsale.com/x0/company/1/self/documents/inventory-import/free/original/NSTuhgsgq-product_inventory.csv","id":"5ffefc39a0d1e20001ae118c","is_active":true,"modified_by":{"user_id":"0","username":"Silverbolt"},"modified_on":"2021-01-13T13:57:13.847000Z","stage":"failed","succeed":0,"total":1},{"cancelled":0,"cancelled_records":[],"company_id":1,"created_by":{"full_name":"Nikhil Mhatre","user_id":"16","username":"nikhilmhatre_gofynd_com_97636"},"created_on":"2021-01-12T06:37:06.167000Z","failed":0,"failed_records":[],"file_path":"https://hdn-1.addsale.com/x0/company/1/self/documents/inventory-import/free/original/cwQV-Z6gT-product_inventory.xlsx","id":"5ffd4392b4c34d000170697b","is_active":true,"modified_by":{"user_id":"0","username":"Silverbolt"},"modified_on":"2021-01-12T06:37:06.307000Z","stage":"completed","succeed":1,"total":1},{"cancelled":0,"cancelled_records":[],"company_id":1,"created_by":{"full_name":"Nikhil Mhatre","user_id":"16","username":"nikhilmhatre_gofynd_com_97636"},"created_on":"2021-01-12T06:36:24.292000Z","failed":0,"failed_records":[],"file_path":"https://hdn-1.addsale.com/x0/company/1/self/documents/inventory-import/free/original/gccehef2f-product_inventory.xlsx","id":"5ffd4368b4c34d0001706960","is_active":true,"modified_by":{"user_id":"0","username":"Silverbolt"},"modified_on":"2021-01-12T06:36:24.535000Z","stage":"completed","succeed":1,"total":1}],"page":{"current":1,"has_next":true,"has_previous":false,"item_total":39,"size":4,"type":"number"}},"schema":{"$ref":"#/components/schemas/BulkInventoryGet"}}},"description":"List of bulk Inventory upload jobs. See `BulkInventoryGetSchema` for details"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"getInventoryBulkUploadHistory | Get a list of all bulk Inventory upload jobs.","tags":["Catalog"]},"post":{"description":"This API helps to create a bulk Inventory upload job.","parameters":[{"description":"Company Id in which Inventory to be uploaded.","in":"path","name":"company_id","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkJob"}}},"description":"Bulk Inventory data that needs to be uploaded","required":true},"responses":{"200":{"content":{"application/json":{"example":{"batch_id":"507f1f77bcf86cd799439011","created_on":"2021-04-02T15:43:59.410000Z"},"schema":{"$ref":"#/components/schemas/BulkResponse"}}},"description":"Returns a success response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"createBulkInventoryJob | Create a Bulk Inventory upload Job.","tags":["Catalog"]}},"/service/platform/catalog/v1.0/company/{company_id}/inventory/bulk/{batch_id}/":{"delete":{"description":"This API allows to delete bulk Inventory job associated with company.","parameters":[{"description":"Company Id of the company of which bulk Inventory job is to be deleted.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"Batch Id of the bulk delete job.","in":"path","name":"batch_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"success":true},"schema":{"$ref":"#/components/schemas/SuccessResponse"}}},"description":"Returns a success response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"deleteBulkInventoryJob | Delete Bulk Inventory job.","tags":["Catalog"]},"post":{"description":"This API helps to create products in bulk push to kafka for approval/creation.","parameters":[{"description":"Company Id in which Inventory is to be uploaded.","in":"path","name":"company_id","required":true,"schema":{"type":"integer"}},{"description":"Batch Id of the bulk create job.","in":"path","name":"batch_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InventoryBulkRequest"}}},"description":"Bulk Inventory Upload data that needs to be uploaded","required":true},"responses":{"200":{"content":{"application/json":{"example":{"success":true},"schema":{"$ref":"#/components/schemas/SuccessResponse"}}},"description":"Returns a success response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"createBulkInventory | Create products in bulk associated with given batch Id.","tags":["Catalog"]}},"/service/platform/catalog/v1.0/company/{company_id}/inventory/download/":{"get":{"description":"This API helps to get Inventory export history.","parameters":[{"description":"Company Id in which assets to be uploaded.","in":"path","name":"company_id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InventoryExportJob"}}},"description":"Returns a list of inventory export jobs"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"getInventoryExport | Get Inventory export history.","tags":["Catalog"]},"post":{"description":"This API helps to create a Inventory export job.","parameters":[{"description":"Company Id in which assets to be uploaded.","in":"path","name":"company_id","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InventoryExportRequest"}}},"description":"Inventory export job object.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InventoryExportResponse"}}},"description":"Returns a success response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"createInventoryExportJob | Create a Inventory export Job.","tags":["Catalog"]}},"/service/platform/catalog/v1.0/company/{company_id}/inventory/download/configuration/":{"get":{"description":"This API allows get List of different filters like brand, store, and type for inventory export.","parameters":[{"description":"Id of the company associated to product that is to be viewed.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"filter type from any one of ['brand', 'store', 'type']","in":"query","name":"filter_type","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"display":"csv","value":"csv"},{"display":"excel","value":"excel"}],"multivalues":true},"schema":{"$ref":"#/components/schemas/InventoryConfig"}}},"description":"returns filters configuration for inventory export"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"exportInventoryConfig | Get List of different filters for inventory export","tags":["Catalog"]}},"/service/platform/catalog/v1.0/company/{company_id}/inventory/templates/download/":{"get":{"description":"Allows you to download product template data","parameters":[{"description":"A `company_id` is a unique identifier for a particular seller account.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"An `item_type` defines the type of item.","in":"query","name":"item_type","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"text/csv":{"schema":{"format":"binary","type":"string"}}},"description":"CSV File of product template data."},"4XX":{"content":{"application/json":{"example":{"code":"400","message":"Company not found."},"schema":{"$ref":"#/components/schemas/PTErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"downloadInventoryTemplateView | Download Product Template View","tags":["Catalog"]}},"/service/platform/catalog/v1.0/company/{company_id}/inventory/templates/validation/schema/":{"get":{"description":"Allows you to list all product templates validation values for all the fields present in the database","parameters":[{"description":"A `company_id` is a unique identifier for a particular seller account.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"An `item_type` defines the type of item. The default value is standard.","in":"query","name":"item_type","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"definitions":{"InventoryBaseSchema":{"properties":{"currency":{"title":"Currency","type":"string"},"price":{"exclusiveMinimum":1,"title":"Actual Price","type":"number"},"price_effective":{"exclusiveMinimum":1,"title":"Selling Price","type":"number"},"quantity":{"minimum":0,"title":"Quantity","type":"integer"},"seller_identifier":{"pattern":"^[A-Za-z0-9]*$","title":"Gtin Value","type":"string"},"size":{"title":"Size","type":"string"},"store_code":{"enum":["RUOSH43","S106","S108","TIO9","talha"],"title":"Store Code","type":"string"}},"required":["price","price_effective","seller_identifier","quantity","store_code","currency","size"],"title":"InventoryBaseSchema","type":"object"},"ItemQuery":{"properties":{"brand_uid":{"title":"Brand Uid","type":"integer"},"item_code":{"title":"Item Code","type":"integer"},"uid":{"title":"Uid","type":"integer"}},"title":"ItemQuery","type":"object"}},"properties":{"sizes":{"title":"Sizes","type":"array"}},"required":["item","sizes"],"title":"InventoryValidationResponse","type":"object"},"message":"Success"},"schema":{"$ref":"#/components/schemas/InventoryValidationResponse"}}},"description":"List of fields and validation values fro each. See example below or refer `InventoryValidationResponse` for details"},"4XX":{"content":{"application/json":{"example":{"code":"400","message":"Company not found."},"schema":{"$ref":"#/components/schemas/PTErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"validateProductTemplateSchema | Validate Product Template Schema","tags":["Catalog"]}},"/service/platform/catalog/v1.0/company/{company_id}/location/reassign/":{"post":{"parameters":[{"description":"Id of the company inside which the location is to be created.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"app_id":"5d65089e031f9029f8e8dc2f","articles":[{"article_assignment":{"level":"multi-company","strategy":"app-config"},"meta":{},"quantity":1,"query":{"item_id":75252658,"size":"OS"}}],"pincode":"203201","query_type":"reassignment","user_id":"12121212"},"schema":{"$ref":"#/components/schemas/AssignStore"}}},"description":"Object that needs to be added.","required":true},"responses":{"200":{"content":{"application/json":{"example":{"_id":"61161830f1061e7c7f81d8ed","article_assignment":{"level":"multi-company","strategy":"app-config"},"company_id":783,"index":0,"item_id":75252658,"price_effective":995,"price_marked":995,"quantity":1,"s_city":"NOIDA","size":"OS","status":true,"store_id":11550,"store_pincode":201303,"strategy_wise_listing":[],"uid":"11550_000000410234883001"},"schema":{"$ref":"#/components/schemas/StoreAssignResponse"}}},"description":"Returns a success response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"getOptimalLocations | Location Reassignment","tags":["Catalog"]}},"/service/platform/catalog/v1.0/company/{company_id}/marketplaces/":{"get":{"description":"Use this API to fetch opt-in information for all the platforms. If successful, returns a logs in the response body as specified in `GetOptInPlatformSchema`","parameters":[{"in":"path","name":"company_id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOptInPlatform"}}},"description":"See example below or refer `GetOptInPlatformSchema` for details."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"getMarketplaceOptinDetail | Get opt-in infomation.","tags":["Catalog"]}},"/service/platform/catalog/v1.0/company/{company_id}/marketplaces/company-brand-details/":{"get":{"description":"Get the details of the Brands associated with the given company_id passed.","parameters":[{"description":"The company id for which the detail needs to be retrieved.","in":"path","name":"company_id","required":true,"schema":{"type":"integer"}},{"description":"The is_active status for the optin id.","in":"query","name":"is_active","required":false,"schema":{"type":"boolean"}},{"description":"The search value to filter the list.","in":"query","name":"q","required":false,"schema":{"type":"string"}},{"description":"The number of page for the company id.","in":"query","name":"page_no","required":false,"schema":{"type":"integer"}},{"description":"Number of records that can be seen on the page for the company id.","in":"query","name":"page_size","required":false,"schema":{"type":"integer"}},{"description":"The marketplace platform associated with the company id.","in":"query","name":"marketplace","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OptinCompanyBrandDetailsView"}}},"description":"See example below or refer `OptinCompanyBrandDetailsView` for details"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"getCompanyBrandDetail | Get the Company Brand details of Optin.","tags":["Catalog"]}},"/service/platform/catalog/v1.0/company/{company_id}/marketplaces/company-details/":{"get":{"description":"Get the details of the company associated with the given company_id passed.","parameters":[{"description":"The company id for which the detail needs to be retrieved.","in":"path","name":"company_id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OptinCompanyDetail"}}},"description":"See example below or refer `OptinCompanyDetailSchema` for details"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"getCompanyDetail | Get the Company details.","tags":["Catalog"]}},"/service/platform/catalog/v1.0/company/{company_id}/marketplaces/company-metrics/":{"get":{"description":"Get the Company metrics associated with the company ID passed.","parameters":[{"description":"The company id for which the detail needs to be retrieved.","in":"path","name":"company_id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OptinCompanyMetrics"}}},"description":"See example below or refer `OptinCompanyMetrics` for details"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"getCompanyMetrics | Get the Company metrics","tags":["Catalog"]}},"/service/platform/catalog/v1.0/company/{company_id}/marketplaces/location-details/":{"get":{"description":"Get the details of the store associated with the company ID passed.","parameters":[{"description":"The company id for which the detail needs to be retrieved.","in":"path","name":"company_id","required":true,"schema":{"type":"integer"}},{"description":"The search related the store for the company id.","in":"query","name":"q","required":false,"schema":{"type":"string"}},{"description":"The number of page for the company id.","in":"query","name":"page_no","required":false,"schema":{"type":"integer"}},{"description":"Number of records that can be seen on the page for the company id.","in":"query","name":"page_size","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OptinStoreDetails"}}},"description":"See example below or refer `OptinStoreDetailsSchema` for details"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"getStoreDetail | Get the Store details.","tags":["Catalog"]}},"/service/platform/catalog/v1.0/company/{company_id}/marketplaces/{marketplace}/optin/":{"post":{"description":"Use this API to create/update opt-in information for given platform. If successful, returns data in the response body as specified in `OptInPostResponseSchema`","parameters":[{"description":"The company id for which the detail needs to be retrieved.","in":"path","name":"company_id","required":true,"schema":{"type":"integer"}},{"description":"The marketplace for which the detail needs to be retrieved.","in":"path","name":"marketplace","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OptInPostRequest"}}},"description":"Metadata for Optin","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatedResponse"}}},"description":"See example below or refer `UpdatedResponse` for details."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"createMarketplaceOptin | Create/Update opt-in infomation.","tags":["Catalog"]}},"/service/platform/catalog/v1.0/company/{company_id}/product-attributes/":{"get":{"description":"This API allows to list all the attributes by their l3_categories.","parameters":[{"description":"company for which you want to view the genders","in":"path","name":"company_id","required":true,"schema":{"type":"integer"}},{"description":"It is the name of the l3 cateogry","in":"query","name":"category","required":true,"schema":{"type":"string"}},{"description":"If true, returns filtered values, else returns all the attributes","in":"query","name":"filter","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"example":{"items":[{"created_by":{"user_id":"8ec76d9df98f4246a9d6e5a6","username":"anveshreddy_fynd_external_com_85084"},"created_on":"2022-05-25T16:15:01.276000Z","departments":["men-s-fashion"],"description":"to test the attribute that represents area","details":{"display_type":"text"},"filters":{"indexing":false},"id":"628e5605c71589dba709c365","modified_by":{"user_id":"8ec76d9df98f4246a9d6e5a6","username":"anveshreddy_fynd_external_com_85084"},"modified_on":"2022-05-25T16:15:01.276000Z","name":"test number area","schema":{"allowed_values":[],"format":"","multi":true,"range":{},"type":"int"},"slug":"test-number-area","unit":"ft**2","variant":false},{"created_by":{"user_id":"8ec76d9df98f4246a9d6e5a6","username":"anveshreddy_fynd_external_com_85084"},"created_on":"2022-05-05T09:40:00.453000Z","departments":["men-s-fashion","anvesh-department"],"description":"tells the power of the motor","details":{"display_type":"text"},"enabled_for_end_consumer":true,"filters":{"indexing":true,"priority":26},"id":"62739b7043385c1f314d4868","logo":"https://hdn-1.jiomarketx0.de/x0/products/pictures/attribute/logo/original/UYTUHgLGj-Color.png","modified_by":{"user_id":"8ec76d9df98f4246a9d6e5a6","username":"anveshreddy_fynd_external_com_85084"},"modified_on":"2022-05-05T09:40:00.453000Z","name":"Motor Power","schema":{"allowed_values":[],"format":"","mandatory":true,"multi":false,"range":{"max":10,"min":1},"type":"int"},"slug":"motor-power","unit":"hp","variant":true},{"created_by":{"user_id":"8ec76d9df98f4246a9d6e5a6","username":"anveshreddy_fynd_external_com_85084"},"created_on":"2022-05-05T08:56:59.483000Z","departments":["men-s-fashion","electronics-test","anvesh-department","fashion","test1"],"description":"describes the size of the item","details":{"display_type":"text"},"enabled_for_end_consumer":true,"filters":{"indexing":true,"priority":25},"id":"6273915b43385c1f314d4867","logo":"https://hdn-1.jiomarketx0.de/x0/products/pictures/attribute/logo/original/UYTUHgLGj-Color.png","modified_by":{"user_id":"8ec76d9df98f4246a9d6e5a6","username":"anveshreddy_fynd_external_com_85084"},"modified_on":"2022-05-05T13:25:33.353000Z","name":"SIZE NEW","schema":{"allowed_values":["XS","S","M","L","XXL","XXXL"],"format":"upper case","mandatory":true,"multi":false,"range":{},"type":"str"},"slug":"size-new","variant":false},{"created_by":{"user_id":"5d9aa3ca5acdcb33fdcc8472","username":"piyushsinha_fynd_external_com_34090"},"created_on":"2022-04-13T13:35:53.611000Z","departments":["men-s-fashion"],"details":{"display_type":"text"},"filters":{"indexing":false},"id":"6256d1b9635e136dc2cb9a02","modified_by":{"user_id":"5d9aa3ca5acdcb33fdcc8472","username":"piyushsinha_fynd_external_com_34090"},"modified_on":"2022-04-13T13:35:53.611000Z","name":"White","schema":{"allowed_values":[],"format":"title case","multi":false,"range":{},"type":"str"},"slug":"white","variant":false},{"created_by":{"user_id":"f6fccadda27e6b365b87c027","username":"jagadeshsahadevan_gofynd_com_66706"},"created_on":"2022-03-24T07:16:59.998000Z","departments":["men-s-fashion"],"description":"Hello World","details":{"display_type":"text"},"filters":{"indexing":false},"id":"623c1aecb9e8edcfeb8d076a","modified_by":{"user_id":"f6fccadda27e6b365b87c027","username":"jagadeshsahadevan_gofynd_com_66706"},"modified_on":"2022-03-24T07:16:59.998000Z","name":"Test Attributes","schema":{"allowed_values":["A","B"],"format":"","multi":true,"range":{},"type":"str"},"slug":"test-attributes","variant":false},{"created_by":{"user_id":"59ad6a452775bfd63674f0a5","username":"rockypatro_gofynd_com_32787"},"created_on":"2022-03-17T14:54:41.251000Z","departments":["men-s-fashion"],"description":"Any specific care instruction note or Safety instructions that needs to be followed","details":{"display_type":"text"},"enabled_for_end_consumer":true,"filters":{"indexing":true,"priority":9},"id":"62334bb1d6b144588682e1c0","modified_by":{"user_id":"59ad6a452775bfd63674f0a5","username":"rockypatro_gofynd_com_32787"},"modified_on":"2022-03-17T14:54:41.251000Z","name":"Care Instructions","schema":{"allowed_values":[],"format":"","multi":false,"range":{},"type":"str"},"slug":"care-instructions","variant":false},{"created_by":{"user_id":"59ad6a452775bfd63674f0a5","username":"rockypatro_gofynd_com_32787"},"created_on":"2022-03-17T14:53:45.700000Z","departments":["men-s-fashion"],"description":"Specify the length of the sleeve. Select the value from the dropdown","details":{"display_type":"text"},"enabled_for_end_consumer":true,"filters":{"indexing":true,"priority":8},"id":"62334b79d6b144588682e1bf","modified_by":{"user_id":"59ad6a452775bfd63674f0a5","username":"rockypatro_gofynd_com_32787"},"modified_on":"2022-03-17T14:53:45.700000Z","name":"Sleeve Length","schema":{"allowed_values":["Sleeveless","Short","Long"],"format":"","multi":false,"range":{},"type":"str"},"slug":"sleeve-length","variant":false},{"created_by":{"user_id":"59ad6a452775bfd63674f0a5","username":"rockypatro_gofynd_com_32787"},"created_on":"2022-03-17T14:52:12.367000Z","departments":["men-s-fashion","women-s-fashion"],"description":"A repeated form or design on the product, Select the values from the dropdown.","details":{"display_type":"text"},"enabled_for_end_consumer":true,"filters":{"indexing":true,"priority":7},"id":"62334b1cd6b144588682e1be","modified_by":{"user_id":"f6fccadda27e6b365b87c027","username":"jagadeshsahadevan_gofynd_com_66706"},"modified_on":"2022-03-24T07:23:32.752000Z","name":"Pattern","schema":{"allowed_values":["Solid","Printed","Ripped","Checked"],"format":"","multi":false,"range":{},"type":"str"},"slug":"pattern","variant":false},{"created_by":{"user_id":"59ad6a452775bfd63674f0a5","username":"rockypatro_gofynd_com_32787"},"created_on":"2022-03-17T14:50:30.717000Z","departments":["men-s-fashion","beauty-and-personal-care","electronics"],"description":"Specify the Material name or Material composition of the product","details":{"display_type":"text"},"enabled_for_end_consumer":true,"filters":{"indexing":true,"priority":6},"id":"62334ab6d6b144588682e1bd","modified_by":{"user_id":"59ad6a452775bfd63674f0a5","username":"rockypatro_gofynd_com_32787"},"modified_on":"2022-03-17T14:50:30.717000Z","name":"Material","schema":{"allowed_values":[],"format":"","multi":false,"range":{},"type":"str"},"slug":"material","variant":false},{"created_by":{"user_id":"59ad6a452775bfd63674f0a5","username":"rockypatro_gofynd_com_32787"},"created_on":"2022-03-17T14:49:43.160000Z","departments":["men-s-fashion","beauty-and-personal-care","electronics"],"description":"Specify the colour of the product, if you have any customized colour name Specify in this column.","details":{"display_type":"text"},"enabled_for_end_consumer":true,"filters":{"indexing":true,"priority":5},"id":"62334a87d6b144588682e1bc","modified_by":{"user_id":"59ad6a452775bfd63674f0a5","username":"rockypatro_gofynd_com_32787"},"modified_on":"2022-03-17T14:49:43.160000Z","name":"Colour","schema":{"allowed_values":[],"format":"","multi":false,"range":{},"type":"str"},"slug":"colour","variant":false}]},"schema":{"$ref":"#/components/schemas/ProductAttributesResponse"}}},"description":"Size guide object. See example below or refer `ProductAttributesResponseSchema` for details"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"getProductAttributes | Get list of all the attributes by their l3_categories","tags":["Catalog"]}},"/service/platform/catalog/v1.0/company/{company_id}/product-attributes/{attribute_slug}":{"get":{"description":"This API allows to view the gender attribute details.","parameters":[{"description":"company for which you want to view the genders","in":"path","name":"company_id","required":true,"schema":{"type":"integer"}},{"description":"slug of the attribute for which you want to view the genders","in":"path","name":"attribute_slug","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"departments":["men-s-fashion","kids","women-s-fashion","beauty-personal-care"],"description":"Clothing department needs gener attribute","details":{"display_type":"text"},"enabled_for_end_consumer":true,"filters":{"indexing":true,"priority":2},"id":"5ed11eb0be8d5e00016f0335","is_nested":true,"logo":"https://hdn-1.addsale.com/x0/products/pictures/attribute/logo/original/Rhv89tqRo-brand-website-logo.png","meta":{"enriched":false,"mandatory_details":{"l3_keys":[]}},"name":"Gender","schema":{"enum":["Men","Women","Boy","Girl","more","men"],"format":"","mandatory":false,"multi":true,"type":"str"},"slug":"gender"},"schema":{"$ref":"#/components/schemas/GenderDetail"}}},"description":"Size guide object. See example below or refer `GenderDetailSchema` for details"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"getGenderAttribute | Get gender attribute details","tags":["Catalog"]}},"/service/platform/catalog/v1.0/company/{company_id}/product-bundle/":{"get":{"description":"Get all product bundles for a particular company","parameters":[{"description":"A `company_id` is a unique identifier for a particular seller account.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"A search string that is searched with product bundle name.","in":"query","name":"q","required":false,"schema":{"type":"string"}},{"description":"slugs of bundles to be retrieved.","in":"query","name":"slug","required":false,"schema":{"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"example":{"items":[{"choice":"multi","company_id":1,"created_by":{"uid":"123","username":"917827311650_22960"},"created_on":"2021-02-19 16:40:26.310007","id":"602f9ca2a596ce312f5956f9","is_active":true,"logo":"http://g.com/poo.png/","meta":{},"modified_by":{"uid":"123","username":"917827311650_22960"},"modified_on":"2021-02-19 16:40:26.310027","name":"Bag","page_visibility":["pdp"],"products":[{"allow_remove":true,"auto_add_to_cart":false,"auto_select":false,"max_quantity":1,"min_quantity":1,"product_uid":7500001}],"same_store_assignment":true,"slug":"bag"},{"choice":"multi","company_id":1,"created_by":{"uid":"123","username":"917827311650_22960"},"created_on":"2021-02-19 16:21:35.091512","id":"602f9837a596ce2edf9868e2","is_active":true,"logo":"http://g.com/poo.png/","meta":{},"modified_by":{"uid":"123","username":"917827311650_22960"},"modified_on":"2021-02-19 16:21:35.091540","name":"Bag","page_visibility":["pdp"],"products":[{"allow_remove":true,"auto_add_to_cart":false,"auto_select":false,"max_quantity":1,"min_quantity":1,"product_uid":7500001}],"same_store_assignment":true,"slug":"bag"},{"choice":"multi","company_id":1,"created_by":{"uid":"123","username":"917827311650_22960"},"created_on":"2021-02-19 16:20:24.605207","id":"602f97f0a596ce2ead47cd0b","is_active":true,"logo":"http://g.com/poo.png/","meta":{},"modified_by":{"uid":"123","username":"917827311650_22960"},"modified_on":"2021-02-19 16:20:24.605230","name":"Bag","page_visibility":["pdp"],"products":[{"allow_remove":true,"auto_add_to_cart":false,"auto_select":false,"max_quantity":1,"min_quantity":1,"product_uid":7500001}],"same_store_assignment":true,"slug":"bag"},{"choice":"multi","company_id":1,"created_by":{"uid":"123","username":"917827311650_22960"},"created_on":"2021-02-19 16:16:46.196449","id":"602f9716a596ce2e415196df","is_active":true,"logo":"http://g.com/poo.png/","meta":{},"modified_by":{"uid":"123","username":"917827311650_22960"},"modified_on":"2021-02-19 16:16:46.196467","name":"Bag","page_visibility":["pdp"],"products":[{"allow_remove":true,"auto_add_to_cart":false,"auto_select":false,"max_quantity":1,"min_quantity":1,"product_uid":7500001}],"same_store_assignment":true,"slug":"bag"}],"page":{"current":1,"has_next":false,"has_previous":false,"total":1,"total_item_count":4,"type":"number"}},"schema":{"$ref":"#/components/schemas/GetProductBundleListingResponse"}}},"description":"List of bundle configured for a company. See example below or refer `GetProductBundleListingResponse` for details"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"getProductBundle | List all Product Bundles","tags":["Catalog"]},"post":{"description":"Create Product Bundle. See `ProductBundleRequest` for the request body parameter need to create a product bundle. On successful request, returns in `ProductBundleRequest` with id","parameters":[{"description":"A `company_id` is a unique identifier for a particular seller account.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductBundleRequest"}}},"description":"A bundle object that needs to be added","required":true},"responses":{"200":{"content":{"application/json":{"example":{"choice":"multi","company_id":1,"created_by":{"uid":"123","username":"917827311650_22960"},"created_on":"2021-02-19 16:40:26.310007","id":"602f9ca2a596ce312f5956f9","is_active":true,"logo":"http://g.com/poo.png/","meta":{},"modified_by":{"uid":"123","username":"917827311650_22960"},"modified_on":"2021-02-19 16:40:26.310027","name":"Bag","page_visibility":["pdp"],"products":[{"allow_remove":true,"auto_add_to_cart":false,"auto_select":false,"max_quantity":1,"min_quantity":1,"product_uid":7500001}],"same_store_assignment":true,"slug":"bag"},"schema":{"$ref":"#/components/schemas/GetProductBundleCreateResponse"}}},"description":"Get bundle with id that is added. See example below or refer `GetProductBundleCreateResponse` for details"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"createProductBundle | Create Product Bundle","tags":["Catalog"]}},"/service/platform/catalog/v1.0/company/{company_id}/product-bundle/{id}/":{"get":{"description":"Get a particular Bundle details by its `id`. If successful, returns a Product bundle resource in the response body specified in `GetProductBundleResponse`","parameters":[{"description":"A `company_id` is a unique identifier for a particular seller account.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"A `id` is a unique identifier for a particular detail. Pass the `id` of the keywords which you want to retrieve.","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"choice":"multi","company_id":1,"logo":"http://g.com/poo.png/","meta":{},"name":"Bag","page_visibility":["pdp"],"products":[{"allow_remove":true,"auto_add_to_cart":false,"auto_select":false,"max_quantity":1,"min_quantity":1,"product_details":{"attributes":{"brand_name":"brand 2"},"country_of_origin":"India","images":["https://hdn-1.addsale.com/x0/media/pictures/tagged_items/original/random_code_4/FE6DUR_000000.png"],"item_code":"760B3BFF-4905-44B8-A50E-082829E7107F","name":"Some Phone","slug":"slug-1","uid":7500001},"product_uid":7500001}],"same_store_assignment":true,"slug":"bag"},"schema":{"$ref":"#/components/schemas/GetProductBundleResponse"}}},"description":"The Collection object. See example below or refer `GetProductBundleResponse` for details"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"getProductBundleDetail | Get a particular Product Bundle details","tags":["Catalog"]},"put":{"description":"Update a Product Bundle by its id. On successful request, returns the updated product bundle","parameters":[{"description":"A `company_id` is a unique identifier for a particular seller account.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"A `id` is a unique identifier for a particular detail. Pass the `id` of the keywords which you want to delete.","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductBundleUpdateRequest"}}},"description":"A bundle object that needs to be updated","required":true},"responses":{"200":{"content":{"application/json":{"example":{"choice":"multi","company_id":1,"created_by":{"uid":"123","username":"917827311650_22960"},"created_on":"2021-02-19 16:40:26.310007","id":"602f9ca2a596ce312f5956f9","is_active":true,"logo":"http://g.com/poo.png/","meta":{},"modified_by":{"uid":"123","username":"917827311650_22960"},"modified_on":"2021-02-19 16:40:26.310027","name":"Bag","page_visibility":["pdp"],"products":[{"allow_remove":true,"auto_add_to_cart":false,"auto_select":false,"max_quantity":1,"min_quantity":1,"product_uid":7500001}],"same_store_assignment":true,"slug":"bag"},"schema":{"$ref":"#/components/schemas/GetProductBundleCreateResponse"}}},"description":"The Collection object. See example below or refer `GetProductBundleCreateResponse` for details."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"updateProductBundle | Update a Product Bundle","tags":["Catalog"]}},"/service/platform/catalog/v1.0/company/{company_id}/products/assets/bulk/":{"get":{"description":"This API helps to get bulk asset jobs data associated to a particular company.","parameters":[{"description":"Company Id of the product size.","in":"path","name":"company_id","required":true,"schema":{"type":"integer"}},{"description":"The page number to navigate through the given set of results","in":"query","name":"page_no","required":false,"schema":{"type":"integer"}},{"description":"Number of items to retrieve in each page. Default is 12.","in":"query","name":"page_size","required":false,"schema":{"default":12,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"example":{"items":[{"cancelled":0,"cancelled_records":[],"company_id":61,"created_by":{"full_name":"nikhil mhatre","user_id":"23175373","username":"nikhilmhatre_gofynd_com_28085_23175373"},"created_on":"2021-02-25T16:45:22.425000Z","failed":0,"failed_records":[],"file_path":"https://hdn-1.fynd.com/company/61/self/documents/product-import/free/original/ZUSmmXHmZ-U8mTYx3KR-Nike-hoddie.zip","id":"6037d422aa879600015c6d1d","is_active":true,"modified_by":{"user_id":"23175373","username":"nikhilmhatre_gofynd_com_28085_23175373"},"modified_on":"2021-02-25T16:47:24.551000Z","retry":1,"stage":"completed","succeed":1,"total":1,"tracking_url":"https://api.fynd.com/common/assets/v1/asset/status/extract-zips/3296"}],"page":{"current":1,"has_next":false,"has_previous":false,"item_total":1,"size":3,"type":"number"}},"schema":{"$ref":"#/components/schemas/BulkAssetResponse"}}},"description":"List of bulk asset jobs List. See `BulkUtil.modify_batch_response` for details"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"getProductAssetsInBulk | Get a list of all bulk asset jobs.","tags":["Catalog"]},"post":{"description":"This API helps to create a bulk asset upload job.","parameters":[{"description":"Company Id in which assets to be uploaded.","in":"path","name":"company_id","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductBulkAssets"}}},"description":"Product Bulk asset upload object.","required":true},"responses":{"200":{"content":{"application/json":{"example":{"success":true},"schema":{"$ref":"#/components/schemas/SuccessResponse"}}},"description":"Returns a success response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"createProductAssetsInBulk | Create a Bulk asset upload Job.","tags":["Catalog"]}},"/service/platform/catalog/v1.0/company/{company_id}/products/bulk":{"get":{"description":"This API helps to get bulk product upload jobs data.","parameters":[{"description":"Company Id of of which Product Bulk Upload History to be obtained.","in":"path","name":"company_id","required":true,"schema":{"type":"integer"}},{"description":"Search string to filter the results by batch id","in":"query","name":"search","required":false,"schema":{"type":"string"}},{"description":"The page number to navigate through the given set of results","in":"query","name":"page_no","required":false,"schema":{"type":"integer"}},{"description":"Number of items to retrieve in each page. Default is 12.","in":"query","name":"page_size","required":false,"schema":{"default":12,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"example":{"items":[{"cancelled":0,"cancelled_records":[],"company_id":61,"created_by":{"full_name":"Anuja Yadav","user_id":"23218433","username":"yadavanuja039_gmail_com_82948"},"created_on":"2021-03-12T08:11:06.848000Z","failed":0,"failed_records":[],"file_path":"https://hdn-1.fynd.com/company/61/self/documents/product-import/free/original/mkX5ApRmw-sample_bulk_products_footwear.xlsx","id":"604b221a73bfa20001cb00e8","is_active":true,"modified_by":{"user_id":"0","username":"Silverbolt"},"modified_on":"2021-03-12T08:11:08.646000Z","stage":"completed","succeed":1,"template":{"banner":"https://hdn-1.fynd.com/seller/pictures/landscape-banner/original/nFPtXR_Beauty_&_Personal_Care_L.jpgf30455a5-d265-4382-b513-65afb9240320/nFPtXR_Beauty_and_Personal_Care_L.jpg","departments":["men","women","kids","fashion"],"description":"Footwear is a garment worn on the feet to protect against environmental adversities like heat or ground textures. Example: Sports Shoes","is_expirable":true,"is_physical":true,"logo":"https://hdn-1.fynd.com/seller/pictures/logo/original/9Y2UEp_ssssss.jpg7359e4c6-4c53-4dbe-a920-ef8ac658afb1/9Y2UEp_ssssss.jpg","name":"Footwear","slug":"footwear"},"template_tag":"footwear","total":1}],"page":{"current":1,"has_next":true,"has_previous":false,"item_total":251,"size":26,"type":"number"}},"schema":{"$ref":"#/components/schemas/ProductBulkRequestList"}}},"description":"List of bulk product upload jobs. See `BulkRequestGetSchema` for details"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"getProductBulkUploadHistory | Get a list of all bulk product upload jobs.","tags":["Catalog"]},"post":{"description":"This API helps to create a bulk products upload job.","parameters":[{"description":"Company Id in which assets to be uploaded.","in":"path","name":"company_id","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkJob"}}},"description":"Bulk Product Upload data that needs to be uploaded","required":true},"responses":{"200":{"content":{"application/json":{"example":{"batch_id":"507f1f77bcf86cd799439011","created_on":"2021-04-02T15:43:59.410000Z"},"schema":{"$ref":"#/components/schemas/BulkResponse"}}},"description":"Returns a success response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"createBulkProductUploadJob | Create a Bulk product to upload job.","tags":["Catalog"]}},"/service/platform/catalog/v1.0/company/{company_id}/products/bulk/{batch_id}":{"delete":{"description":"This API allows to delete bulk product job associated with company.","parameters":[{"description":"Company Id of the company associated to size that is to be deleted.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"Batch Id of the bulk product job to be deleted.","in":"path","name":"batch_id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"example":{"success":true},"schema":{"$ref":"#/components/schemas/SuccessResponse"}}},"description":"Returns a success response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"deleteProductBulkJob | Delete Bulk product job.","tags":["Catalog"]},"post":{"description":"This API helps to create products in bulk push to kafka for approval/creation.","parameters":[{"description":"Company Id in which assets to be uploaded.","in":"path","name":"company_id","required":true,"schema":{"type":"integer"}},{"description":"Batch Id in which assets to be uploaded.","in":"path","name":"batch_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkProductRequest"}}},"description":"Bulk Product Upload data that needs to be uploaded","required":true},"responses":{"200":{"content":{"application/json":{"example":{"success":true},"schema":{"$ref":"#/components/schemas/SuccessResponse"}}},"description":"Returns a success response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"createProductsInBulk | Create products in bulk associated with given batch Id.","tags":["Catalog"]}},"/service/platform/catalog/v1.0/company/{company_id}/products/downloads/":{"get":{"description":"Can view details including trigger data, task id , etc.","parameters":[{"description":"A `company_id` is a unique identifier for a particular seller account.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"items":[{"completed_on":"2020-12-23T07:23:41.031000Z","created_by":{"user_id":"5646","username":"917972410891_48194"},"data":{"brand":["ruosh"],"templates":["mobile-phones-and-tablet"],"type":"csv"},"id":"5fe2f077516d980001880943","seller_id":3,"status":"success","task_id":"c4b54ace-44ef-11eb-9806-1ef9bc4a2da1","template_tags":{"mobile-phones-and-tablet":{"display":"Mobile Phones & Tablet","logo":"https://hdn-1.jiox0.de/jiox0/seller/pictures/logo/original/Oda39B_99946594-portable-devices-with-tablet-and-mobile-phone-vector-icon-for-apps-and-websites.jpgcc2dff44-7fae-4002-9ebe-d2b59c8bee91/Oda39B_99946594-portable-devices-with-tablet-and-mobile-phone-vector-icon-for-apps-and-websites.jpg"}},"trigger_on":"2020-12-23T07:23:35.302000Z","url":"https://regrowth.s3.amazonaws.com/slingshot-catalogues/seller-catalog/3/c4b54ace-44ef-11eb-9806-1ef9bc4a2da1/c4b54ace-44ef-11eb-9806-1ef9bc4a2da1.zip"}],"page":{}},"schema":{"$ref":"#/components/schemas/ProductDownloadsResponse"}}},"description":"List of Product Downloads Data. See example below or refer `ProductDownloadsResponse` for details"},"4XX":{"content":{"application/json":{"example":{"code":"400","message":"Company not found."},"schema":{"$ref":"#/components/schemas/PTErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"listProductTemplateExportDetails | Allows you to list all product templates export list details","tags":["Catalog"]}},"/service/platform/catalog/v1.0/company/{company_id}/products/hsn/":{"get":{"description":"Allows you to list all hsn Codes","parameters":[{"description":"A `company_id` is a unique identifier for a particular seller account.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"country_of_origin":["India"],"hsn_code":["11111111"]},"message":"Success"},"schema":{"$ref":"#/components/schemas/HSNCodesResponse"}}},"description":"List of all HSN Codes. See example below or refer `HSNCodesResponse` for details"},"4XX":{"content":{"application/json":{"example":{"code":"400","message":"Company not found."},"schema":{"$ref":"#/components/schemas/PTErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"listHSNCodes | List HSN Codes","tags":["Catalog"]}},"/service/platform/catalog/v1.0/company/{company_id}/products/tags":{"get":{"description":"This API helps to get tags data associated to a particular company.","parameters":[{"description":"Company Id for which tags to be fetched.","in":"path","name":"company_id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"example":{"items":["demo","custom"]},"schema":{"$ref":"#/components/schemas/ProductTagsViewResponse"}}},"description":"Tag List. See example below for details"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"getProductTags | Get a list of all tags associated with company.","tags":["Catalog"]}},"/service/platform/catalog/v1.0/company/{company_id}/products/templates/":{"get":{"description":"Allows you to list all product templates, also can filter by department","parameters":[{"description":"A `company_id` is a unique identifier for a particular seller account.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"A `department` is the name of a particular department.","in":"query","name":"department","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"items":{"attributes":["gender","fragile","manufacturer-packer-importer-name","manufacturer-packer-importer-address"],"banner":"https://hdn-1.fynd.com/seller/pictures/landscape-banner/original/F4W6Pd_DEFAULT-BANNER_LANDSCAPE.jpgd54cb24d-dd2c-441c-bca0-8f65ea3b101c/F4W6Pd_DEFAULT-BANNER_LANDSCAPE.jpg","categories":["accessories-adornments","socks","toric-contact-lenses","daily-disposable","monthly-reusable","multifocal-varifocal","solutions-accessories","coloured-lenses"],"departments":["electronics","men","women","kids","toys"],"description":"This is the file validation template for the fashion department and accessories category.","id":"5f04a23544a2e5404274bc07","is_expirable":true,"is_physical":true,"logo":"https://hdn-1.fynd.com/seller/pictures/logo/original/hkE1dC_0DEFAULT-LOGO.jpgfb5b1b31-9449-43db-9049-435fec88ee77/hkE1dC_0DEFAULT-LOGO.jpg","name":"Accessories","slug":"accessories"},"page":{"current":1,"has_next":true,"has_previous":false,"item_total":36,"size":3,"type":"number"}},"schema":{"$ref":"#/components/schemas/TemplatesResponse"}}},"description":"List of product templates. See example below or refer `TemplatesResponse` for details"},"4XX":{"content":{"application/json":{"example":{"code":"400","message":"Company not found."},"schema":{"$ref":"#/components/schemas/PTErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"listProductTemplate | List all Templates","tags":["Catalog"]}},"/service/platform/catalog/v1.0/company/{company_id}/products/templates/categories/":{"get":{"description":"Allows you to list all product categories values for the departments specified","parameters":[{"description":"A `company_id` is a unique identifier for a particular seller account.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"A `department` is name of a departments whose category needs to be listed. Can specify multiple departments.","in":"query","name":"departments","required":true,"schema":{"type":"string"}},{"description":"An `item_type` is the type of item, it can be `set`, `standard`, `digital`, etc.","in":"query","name":"item_type","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"items":[],"page":{"type":""}},"schema":{"$ref":"#/components/schemas/ProdcutTemplateCategoriesResponse"}}},"description":"List of all categories attached to departments specified. See example below or refer `ProdcutTemplateCategoriesResponse` for details"},"4XX":{"content":{"application/json":{"example":{"code":"400","message":"Company not found."},"schema":{"$ref":"#/components/schemas/PTErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"listProductTemplateCategories | List Department specifiec product categories","tags":["Catalog"]}},"/service/platform/catalog/v1.0/company/{company_id}/products/templates/{slug}/download/":{"get":{"description":"Allows you to download product template data","parameters":[{"description":"A `company_id` is a unique identifier for a particular seller account.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"A `slug` is a unique identifier for a particular template.","in":"path","name":"slug","required":true,"schema":{"type":"string"}},{"description":"An `item_type` defines the type of item. The default value is standard.","in":"query","name":"item_type","schema":{"type":"string"}},{"description":"Format type of the sample file. The default value is excel.","in":"query","name":"type","schema":{"type":"string"}}],"responses":{"200":{"content":{"text/csv":{"schema":{"format":"binary","type":"string"}}},"description":"CSV File of product template data. See example below or refer `TemplatesResponse` for details"},"4XX":{"content":{"application/json":{"example":{"code":"400","message":"Company not found."},"schema":{"$ref":"#/components/schemas/PTErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"downloadProductTemplateViews | Download Product Template View","tags":["Catalog"]}},"/service/platform/catalog/v1.0/company/{company_id}/products/templates/{slug}/validation/schema/":{"get":{"description":"Allows you to list all product templates validation values for all the fields present in the database","parameters":[{"description":"A `company_id` is a unique identifier for a particular seller account.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"A `slug` is a unique identifier for a particular template.","in":"path","name":"slug","required":true,"schema":{"type":"string"}},{"description":"An `item_type` defines the type of item. The default value is standard.","in":"query","name":"item_type","schema":{"type":"string"}},{"description":"This specification determines the schema type to be retrieved. When set to true, it will return the schema for bulk data; when set to false, it will provide the schema for a single product. The default value is false.","in":"query","name":"bulk","schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"global_validation":{"properties":{},"required":[]}},"template_details":{"attributes":[],"categories":[],"departments":[],"is_expirable":true,"is_physical":true,"slug":""}},"schema":{"$ref":"#/components/schemas/TemplatesValidationResponse"}}},"description":"List of fields and validation values fro each. See example below or refer `TemplatesValidationResponse` for details"},"4XX":{"content":{"application/json":{"example":{"code":"400","errors":{"departments":["Invalid value."]},"message":"Invalid request"},"schema":{"$ref":"#/components/schemas/PTErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"validateProductTemplate | Validate Product Template Schema","tags":["Catalog"]}},"/service/platform/catalog/v1.0/company/{company_id}/products/validation/":{"get":{"description":"This API validates product data.","parameters":[{"description":"Validates data against given company","in":"path","name":"company_id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"example":{"valid":true},"schema":{"$ref":"#/components/schemas/ValidateProduct"}}},"description":"Validate Meta. See example below for details"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"getProductValidation | Validate product/size data","tags":["Catalog"]}},"/service/platform/catalog/v1.0/company/{company_id}/products/{item_id}/inventory/{size_identifier}":{"get":{"description":"This API allows get Inventory data for particular company grouped by size and store.","parameters":[{"description":"Id of the company associated to product that is to be viewed.","in":"path","name":"company_id","required":true,"schema":{"type":"integer"}},{"description":"Item code of the product of which size is to be get.","in":"path","name":"item_id","required":true,"schema":{"type":"integer"}},{"description":"Size Identifier (Seller Identifier or Primary Identifier) of which inventory is to get.","in":"path","name":"size_identifier","required":true,"schema":{"type":"string"}},{"description":"The page number to navigate through the given set of results","in":"query","name":"page_no","required":false,"schema":{"type":"integer"}},{"description":"Number of items to retrieve in each page. Default is 12.","in":"query","name":"page_size","required":false,"schema":{"default":12,"type":"integer"}},{"description":"Search with help of store code.","in":"query","name":"q","required":false,"schema":{"type":"string"}},{"description":"Search by store ids.","in":"query","name":"location_ids","required":false,"schema":{"items":{"type":"integer"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"example":{"items":[{"brand":{"id":1,"name":"ab"},"company":{"id":1},"country_of_origin":"","currency":"INR","dimension":{"height":13.1,"is_default":true,"length":1.3,"unit":"cm","width":23.4},"fragile":false,"fynd_article_code":"","fynd_item_code":"","identifier":{},"identifiers":[{"gtin_type":"sku_code","gtin_value":"RTYUIDSDFV","primary":true}],"inventory_updated_on":"2021-04-06T03:30:01.487000","item_id":7500651,"manufacturer":{"address":"ab","is_default":true,"name":"ab"},"price":{"currency":"USD","effective":79.99,"marked":99.99,"transfer":89.99},"price_effective":1234,"price_transfer":0,"quantity":10,"sellable_quantity":10,"seller_identifier":"RTYUIDSDFV","size":"AAX1 (1 PCS)","store":{"id":1},"total_quantity":1,"uid":"59_RTYUIDSDFV","weight":{"is_default":true,"shipping":1.5,"unit":"kg"}},{"brand":{"id":1,"name":"ab"},"company":{"id":1},"country_of_origin":"","currency":"INR","dimension":{"height":13.1,"is_default":true,"length":1.3,"unit":"cm","width":23.4},"fragile":false,"fynd_article_code":"","fynd_item_code":"","identifier":{},"identifiers":[{"gtin_type":"sku_code","gtin_value":"RTYUIDSDFV","primary":true}],"inventory_updated_on":"2021-04-06T03:29:35.291000","item_id":7500651,"manufacturer":{"address":"ab","is_default":true,"name":"ab"},"price":{"currency":"USD","effective":79.99,"marked":99.99,"transfer":89.99},"price_effective":1234,"price_transfer":0,"quantity":10,"sellable_quantity":10,"seller_identifier":"RTYUIDSDFV","size":"AAX1 (1 PCS)","store":{"id":1},"total_quantity":1,"uid":"10_RTYUIDSDFV","weight":{"is_default":true,"shipping":1.5,"unit":"kg"}},{"brand":{"id":1,"name":"ab"},"company":{"id":1},"country_of_origin":"","currency":"INR","dimension":{"height":13.1,"is_default":true,"length":1.3,"unit":"cm","width":23.4},"fragile":false,"fynd_article_code":"","fynd_item_code":"","identifier":{},"identifiers":[{"gtin_type":"sku_code","gtin_value":"RTYUIDSDFV","primary":true}],"inventory_updated_on":"2021-03-17T12:35:29.992000","item_id":7500651,"manufacturer":{"address":"ab","is_default":true,"name":"ab"},"order_committed_quantity":0,"price":{"currency":"USD","effective":79.99,"marked":99.99,"transfer":89.99},"price_effective":1234,"price_transfer":0,"quantity":10000000,"sellable_quantity":10000000,"seller_identifier":"RTYUIDSDFV","size":"AAX1 (1 PCS)","store":{"id":1},"total_quantity":1,"uid":"11061_RTYUIDSDFV","weight":{"is_default":true,"shipping":1.5,"unit":"kg"}},{"brand":{"id":1,"name":"ab"},"company":{"id":1},"country_of_origin":"","currency":"INR","damaged_quantity":0,"dimension":{"height":13.1,"is_default":true,"length":1.3,"unit":"cm","width":23.4},"fragile":false,"fynd_article_code":"","fynd_item_code":"","identifier":{},"identifiers":[{"gtin_type":"sku_code","gtin_value":"RTYUIDSDFV","primary":true}],"inventory_updated_on":"2021-03-31T19:00:10.943000","item_id":7500651,"manufacturer":{"address":"ab","is_default":true,"name":"ab"},"not_available_quantity":0,"order_committed_quantity":7,"price":{"currency":"USD","effective":79.99,"marked":99.99,"transfer":89.99},"price_effective":1234,"price_transfer":0,"quantity":39,"sellable_quantity":18,"seller_identifier":"RTYUIDSDFV","size":"AAX1 (1 PCS)","store":{"id":1},"total_quantity":1,"uid":"1_RTYUIDSDFV","weight":{"is_default":true,"shipping":1.5,"unit":"kg"}},{"brand":{"id":1,"name":"ab"},"company":{"id":1},"country_of_origin":"","currency":"INR","dimension":{"height":13.1,"is_default":true,"length":1.3,"unit":"cm","width":23.4},"fragile":false,"fynd_article_code":"","fynd_item_code":"","identifier":{},"identifiers":[{"gtin_type":"sku_code","gtin_value":"RTYUIDSDFV","primary":true}],"inventory_updated_on":"2020-07-07T10:37:06.146000","item_id":7500651,"manufacturer":{"address":"ab","is_default":true,"name":"ab"},"order_committed_quantity":39,"price":{"currency":"USD","effective":79.99,"marked":99.99,"transfer":89.99},"price_effective":1234,"price_transfer":0,"quantity":39,"sellable_quantity":0,"seller_identifier":"RTYUIDSDFV","size":"AAX1 (1 PCS)","store":{"id":1},"total_quantity":1,"uid":"1_rtyuidsdfv","weight":{"is_default":true,"shipping":1.5,"unit":"kg"}}],"page":{"current":1,"has_next":false,"has_previous":false,"item_total":5,"size":1,"type":"number"}},"schema":{"$ref":"#/components/schemas/InventorySellerIdentifierResponsePaginated"}}},"description":"returns a list of all inventory grouped by size and store"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"getInventoryBySizeIdentifier | Get Inventory for company","tags":["Catalog"]}},"/service/platform/catalog/v1.0/company/{company_id}/products/{item_id}/sizes/":{"get":{"description":"This API helps to get data associated to a particular product size.","parameters":[{"description":"Item code of the product size.","in":"query","name":"item_code","required":false,"schema":{"type":"string"}},{"description":"Company Id of the product size.","in":"path","name":"company_id","required":true,"schema":{"type":"integer"}},{"description":"Item Id of the product size.","in":"path","name":"item_id","required":true,"schema":{"type":"integer"}},{"description":"Brand Id of the product size.","in":"query","name":"brand_uid","required":false,"schema":{"type":"integer"}},{"description":"Id of the product size.","in":"query","name":"uid","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"example":{"all_sizes":["3XL"],"attributes":{"color":"Red","created_by":{"company_id":1181,"user_id":"-1","username":"silverbolt"},"created_on":"2020-07-23T04:20:43.810000Z","essential":"Yes","gender":["Men"],"image_nature":"standard","is_image_less_product":false,"l3_mapping":["men>casual_tees","women>casual_tees","girls>casual_tees","more>casual_tees"],"material":"cotton","meta_nature":"standard","modified_by":{"company_id":61,"user_id":"-1","username":"silverbolt"},"modified_on":"2020-07-23T04:20:44.185000Z","neck_type":"Round Neck","pattern":"Printed","primary_color":"Red","primary_material":"Others","product_fit":"Regular","sleeve_length":"Short","stage":"verified","verified_by":{"user_id":"0","username":"Silverbolt"},"verified_on":1595478044},"brand":{"logo":{"aspect_ratio":"1:1","aspect_ratio_f":1,"secure_url":"https://hdn-1.fynd.com/brands/pictures/square-logo/50x0/zjt4-wU8Lk-VQYu0pcokb-r6yteuannoorjkq9f4tk.jpg","url":"https://hdn-1.fynd.com/brands/pictures/square-logo/50x0/zjt4-wU8Lk-VQYu0pcokb-r6yteuannoorjkq9f4tk.jpg"},"name":"play clan","uid":85},"category_slug":"t-shirts","company_id":61,"country_of_origin":"India","currency":"INR","departments":[1],"description":"","highlights":null,"hsn_code":"61099090","id":"5f19101b99ee0500011dc896","images":[],"is_active":false,"is_dependent":false,"is_set":false,"item_code":"ACTESTCREATELISTING1","item_type":"standard","media":[],"multi_size":true,"name":"SQUADMTGIVESPACE","product_publish":{"is_set":false,"product_online_date":1595478043},"size_guide":"play-clan-men-casual-tees","sizes":[{"currency":"INR","identifiers":[{"gtin_type":"sku_code","gtin_value":"ACTESTCREATELISTING1_3XL","primary":true}],"is_set":false,"price":10000,"price_effective":10000,"price_transfer":0,"size":"3XL"}],"slug":"play-clan-squadmtgivespace-857587-e928b0","template_tag":"topwear","uid":857587},"schema":{"$ref":"#/components/schemas/ProductListingResponse"}}},"description":"Product object. See example below for details"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"getProductSize | Get a single product size.","tags":["Catalog"]}},"/service/platform/catalog/v1.0/company/{company_id}/products/{item_id}/sizes/{size}":{"delete":{"description":"This API allows to delete size associated with product.","parameters":[{"description":"Company Id of the company associated to size that is to be deleted.","in":"path","name":"company_id","required":true,"schema":{"type":"integer"}},{"description":"Item Id of the product associated with size to be deleted.","in":"path","name":"item_id","required":true,"schema":{"type":"integer"}},{"description":"size to be deleted.","in":"path","name":"size","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"company_id":1,"item_id":114,"size":"3"},"success":true},"schema":{"$ref":"#/components/schemas/ProductSizeDeleteResponse"}}},"description":"Returns a success response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"deleteSize | Delete a Size associated with product.","tags":["Catalog"]},"get":{"description":"This API allows get Inventory data for particular company grouped by size and store.","parameters":[{"description":"Id of the company associated to product that is to be viewed.","in":"path","name":"company_id","required":true,"schema":{"type":"integer"}},{"description":"Item code of the product of which size is to be get.","in":"path","name":"item_id","required":true,"schema":{"type":"integer"}},{"description":"Size of which inventory is to get.","in":"path","name":"size","required":true,"schema":{"type":"string"}},{"description":"The page number to navigate through the given set of results","in":"query","name":"page_no","required":false,"schema":{"type":"integer"}},{"description":"Number of items to retrieve in each page. Default is 12.","in":"query","name":"page_size","required":false,"schema":{"default":12,"type":"integer"}},{"description":"Search with help of store code.","in":"query","name":"q","required":false,"schema":{"type":"string"}},{"description":"Filter on whether product is in stock or not.","in":"query","name":"sellable","required":false,"schema":{"default":false,"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"example":{"items":[{"currency":"INR","identifiers":{"gtin_type":"sku_code","gtin_value":"RTYUIDSDFV","primary":true},"inventory_updated_on":"2021-04-06T03:30:01.487000","item_id":7500651,"price":1234,"price_effective":1234,"price_transfer":0,"quantity":10,"sellable_quantity":10,"seller_identifier":"RTYUIDSDFV","size":"AAX1 (1 PCS)","store":{"_custom_json":{},"address":{"address1":"A/204, SAI VANDAN, NARAYAN NAGAR, TULINJ ROAD","address2":"","city":"MUMBAI","country":"INDIA","landmark":"","lat_long":{"coordinates":[72.8231511,19.4232024],"type":"Point"},"pincode":401209,"state":"MAHARASHTRA"},"integration_type":{"inventory":"browntape","order":"browntape"},"manager":{"email":"a@b.com","mobile_no":{"country_code":91,"number":"2382634324"},"name":"abc"},"name":"yosss sdd dsdyo","store_code":"sanic6sdfsf7","uid":59},"uid":"59_RTYUIDSDFV"},{"currency":"INR","identifiers":{"gtin_type":"sku_code","gtin_value":"RTYUIDSDFV","primary":true},"inventory_updated_on":"2021-04-06T03:29:35.291000","item_id":7500651,"price":1234,"price_effective":1234,"price_transfer":0,"quantity":10,"sellable_quantity":10,"seller_identifier":"RTYUIDSDFV","size":"AAX1 (1 PCS)","store":{"_custom_json":{},"address":{"address1":"NO","address2":"","city":"MUMBAI","country":"INDIA","lat_long":{"coordinates":[1,1],"type":"Point"},"pincode":400072,"state":"MAHA"},"integration_type":{"inventory":"browntape","order":"browntape"},"manager":{"email":"rehman@cashkart.com","mobile_no":{"country_code":91,"number":"9167943983"},"name":"abc"},"name":"Saran Ledonne","store_code":"af6198fe-2c23-4441-bbf4-e694c96e255c","uid":10},"uid":"10_RTYUIDSDFV"},{"currency":"INR","identifiers":{"gtin_type":"sku_code","gtin_value":"RTYUIDSDFV","primary":true},"inventory_updated_on":"2021-03-17T12:35:29.992000","item_id":7500651,"order_committed_quantity":0,"price":1234,"price_effective":1234,"price_transfer":0,"quantity":10000000,"sellable_quantity":10000000,"seller_identifier":"RTYUIDSDFV","size":"AAX1 (1 PCS)","store":{"_custom_json":{},"address":{"address1":"14/1, VINOBHA BHAVE NAGAR","address2":"VINOBHA BHAVE NAGAR, KURLA WEST, KURLA, ","city":"MUMBAI","country":"INDIA","lat_long":{"coordinates":[1,1],"type":"Point"},"pincode":400070,"state":"MAHARASHTRA"},"integration_type":{"inventory":"browntape","order":"browntape"},"manager":{"email":"fahimsakri@gofynd.com","mobile_no":{"country_code":91,"number":"9594495254"},"name":"Fahim"},"name":"ABC-1-17","store_code":"ABC-1-17","uid":11061},"uid":"11061_RTYUIDSDFV"},{"currency":"INR","damaged_quantity":0,"identifiers":{"gtin_type":"sku_code","gtin_value":"RTYUIDSDFV","primary":true},"inventory_updated_on":"2021-03-31T19:00:10.943000","item_id":7500651,"not_available_quantity":0,"order_committed_quantity":7,"price":1234,"price_effective":1234,"price_transfer":0,"quantity":39,"sellable_quantity":18,"seller_identifier":"RTYUIDSDFV","size":"AAX1 (1 PCS)","store":{"_custom_json":{},"address":{"address1":"SHOPSENSE RETAIL TECHNOLOGIES PRIVATE LIMITED 1ST FLOOR WEWORK VIJAY DIAMOND, CROSS RD B, AJIT NAGAR,","address2":"KONDIVITA, ANDHERI EAST, MUMBAI, MAHARASHTRA 400069","city":"MUMBAI","country":"INDIA","lat_long":{"coordinates":[72.8691788,19.1174114],"type":"Point"},"pincode":400059,"state":"MAHARASHTRA"},"integration_type":{"inventory":"browntape","order":"browntape"},"manager":{"email":"ASHISHCHANDORKAR@FYND.COM","mobile_no":{"country_code":91,"number":"8369782851"},"name":"ASHISH CHANDORKAR"},"name":"RRL01","store_code":"WH_8513","uid":1},"uid":"1_RTYUIDSDFV"},{"currency":"INR","identifiers":{"gtin_type":"sku_code","gtin_value":"RTYUIDSDFV","primary":true},"inventory_updated_on":"2020-07-07T10:37:06.146000","item_id":7500651,"order_committed_quantity":39,"price":1234,"price_effective":1234,"price_transfer":0,"quantity":39,"sellable_quantity":0,"seller_identifier":"RTYUIDSDFV","size":"AAX1 (1 PCS)","store":{"_custom_json":{},"address":{"address1":"SHOPSENSE RETAIL TECHNOLOGIES PRIVATE LIMITED 1ST FLOOR WEWORK VIJAY DIAMOND, CROSS RD B, AJIT NAGAR,","address2":"KONDIVITA, ANDHERI EAST, MUMBAI, MAHARASHTRA 400069","city":"MUMBAI","country":"INDIA","lat_long":{"coordinates":[72.8691788,19.1174114],"type":"Point"},"pincode":400059,"state":"MAHARASHTRA"},"integration_type":{"inventory":"browntape","order":"browntape"},"manager":{"email":"ASHISHCHANDORKAR@FYND.COM","mobile_no":{"country_code":91,"number":"8369782851"},"name":"ASHISH CHANDORKAR"},"name":"RRL01","store_code":"WH_8513","uid":1},"uid":"1_rtyuidsdfv"}],"page":{"current":1,"has_next":false,"has_previous":false,"item_total":5,"size":1,"type":"number"}},"schema":{"$ref":"#/components/schemas/InventoryResponsePaginated"}}},"description":"returns a list of all inventory grouped by size and store"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"getInventoryBySize | Get Inventory for company","tags":["Catalog"]},"post":{"description":"This API allows add Inventory for particular size and store.","parameters":[{"description":"Id of the company associated to product that is to be viewed.","in":"path","name":"company_id","required":true,"schema":{"type":"integer"}},{"description":"Item code of the product of which size is to be get.","in":"path","name":"item_id","required":true,"schema":{"type":"integer"}},{"description":"Size in which inventory is to be added.","in":"path","name":"size","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InventoryRequest"}}},"description":"Product object that needs to be created.","required":true},"responses":{"200":{"content":{"application/json":{"example":{"success":true},"schema":{"$ref":"#/components/schemas/SuccessResponse"}}},"description":"Returns a success response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"addInventory | Add Inventory for particular size and store.","tags":["Catalog"]}},"/service/platform/catalog/v1.0/company/{company_id}/products/{item_id}/variants/{variant_type}":{"get":{"description":"This API gets meta associated to products.","parameters":[{"description":"Get list of products filtered by company Id","in":"path","name":"company_id","required":true,"schema":{"type":"integer"}},{"description":"Get list of variants of item Id","in":"path","name":"item_id","required":true,"schema":{"type":"integer"}},{"description":"Get multiple products filtered by variant type","in":"path","name":"variant_type","required":true,"schema":{"type":"string"}},{"description":"The page number to navigate through the given set of results","in":"query","name":"page_no","required":false,"schema":{"type":"integer"}},{"description":"Number of items to retrieve in each page. Default is 10.","in":"query","name":"page_size","required":false,"schema":{"default":10,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"example":{"page":{"current":1,"has_next":false,"has_previous":false,"item_total":1,"size":1,"type":"number"},"variants":[{"brand_uid":401,"category_uid":3938,"item_code":"TEST-MSA-6","media":[{"type":"image","url":"https://hdn-1.jiox0.de/jiox0/products/pictures/item/free/original/7cGLXZLpO-iN3Jd9uro-Wiv-7J9qC-product.png"}],"name":"test-msa-6","slug":"test-msa-6","uid":7526471}]},"schema":{"$ref":"#/components/schemas/ProductVariantsResponse"}}},"description":"Product Meta. See example below for details"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"getVariantsOfProducts | Get product list","tags":["Catalog"]}},"/service/platform/catalog/v1.0/company/{company_id}/sizeguide":{"get":{"description":"This API allows to view all the size guides associated to the seller.","parameters":[{"description":"Id of the company for which the size guides are to be fetched.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"filter size guide on basis of active, in-active","in":"query","name":"active","required":false,"schema":{"type":"boolean"}},{"description":"Query that is to be searched.","in":"query","name":"q","required":false,"schema":{"type":"string"}},{"description":"to filter size guide on basis of tag.","in":"query","name":"tag","required":false,"schema":{"type":"string"}},{"description":"The page number to navigate through the given set of results","in":"query","name":"page_no","required":false,"schema":{"type":"integer"}},{"description":"Number of items to retrieve in each page. Default is 10.","in":"query","name":"page_size","required":false,"schema":{"default":10,"type":"integer"}},{"description":"Brand id that is to be searched.","in":"query","name":"brand_id","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"example":{"items":[{"active":true,"brand_id":2,"company_id":12,"created_by":{"user_id":"-1","username":"silverbolt"},"created_on":"2021-02-24T17:46:04.146000Z","guide":{"meta":{"headers":{"col_1":{"convertable":false,"value":"Head"},"col_2":{"convertable":true,"value":"Shoulder"}},"unit":"cm","values":[{"col_1":"10","col_2":"20"},{"col_1":"12","col_2":"22"},{"col_1":"14","col_2":"24"}]}},"id":"60364384f08385bee776f83d","modified_by":{"user_id":"-1","username":"silverbolt"},"modified_on":"2021-02-24T17:46:04.146000Z","name":"Demo","subtitle":"I am demo","tag":"demo","title":"Demo SG"}],"page":{"current":1,"has_next":false,"has_previous":false,"item_count":1,"size":1,"type":"number"}},"schema":{"$ref":"#/components/schemas/ListSizeGuide"}}},"description":"Size guide object. See example below or refer `ListSizeGuide` for details"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"getSizeGuides | Get list of size guides","tags":["Catalog"]},"post":{"description":"This API allows to create a size guide associated to a brand.","parameters":[{"description":"Id of the company inside which the size guide is to be created.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"active":true,"brand_id":1,"company_id":1,"guide":{"meta":{"headers":{"col_1":{"convertable":false,"value":"Head"},"col_2":{"convertable":true,"value":"Shoulder"}},"unit":"cm","values":[{"col_1":"10","col_2":"20"},{"col_1":"12","col_2":"22"},{"col_1":"14","col_2":"24"}]}},"name":"Demo","subtitle":"I am demo","title":"Demo SG"},"schema":{"$ref":"#/components/schemas/ValidateSizeGuide"}}},"description":"Size guide object that needs to be added.","required":true},"responses":{"200":{"content":{"application/json":{"example":{"success":true},"schema":{"$ref":"#/components/schemas/SuccessResponse"}}},"description":"Returns a success response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"createSizeGuide | Create a size guide.","tags":["Catalog"]}},"/service/platform/catalog/v1.0/company/{company_id}/sizeguide/{id}/":{"get":{"description":"This API helps to get data associated to a size guide.","parameters":[{"description":"Id of the company associated to size guide.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"Id of the size guide to be viewed.","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"active":true,"brand_id":1,"company_id":1,"created_by":{"user_id":"-1","username":"silverbolt"},"created_on":"2021-02-24T17:46:04.146000Z","guide":{"meta":{"headers":{"col_1":{"convertable":false,"value":"Head"},"col_2":{"convertable":true,"value":"Shoulder"}},"unit":"cm","values":[{"col_1":"10","col_2":"20"},{"col_1":"12","col_2":"22"},{"col_1":"14","col_2":"24"}]}},"id":"60364384f08385bee776f83d","modified_by":{"user_id":"123","username":"917827311650_22960"},"modified_on":"2021-02-25T15:19:30.822000Z","name":"edited size guide","subtitle":"I am demo","tag":"demo","title":"Demo SG"},"schema":{"$ref":"#/components/schemas/SizeGuideResponse"}}},"description":"Brand object. See example below or refer `SizeGuideResponseSchema` for details"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"getSizeGuide | Get a single size guide.","tags":["Catalog"]},"put":{"description":"This API allows to edit a size guide.","parameters":[{"description":"Id of the company.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"Mongo id of the size guide to be edited","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"active":true,"brand_id":1,"company_id":1,"guide":{"meta":{"headers":{"col_1":{"convertable":false,"value":"Head"},"col_2":{"convertable":true,"value":"Shoulder"}},"unit":"cm","values":[{"col_1":"10","col_2":"20"},{"col_1":"12","col_2":"22"},{"col_1":"14","col_2":"24"}]}},"name":"Demo","subtitle":"I am demo","title":"Demo SG"},"schema":{"$ref":"#/components/schemas/ValidateSizeGuide"}}},"description":"Onboard object that needs to be added.","required":true},"responses":{"200":{"content":{"application/json":{"example":{"success":true},"schema":{"$ref":"#/components/schemas/SuccessResponse"}}},"description":"Returns a success response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"updateSizeGuide | Edit a size guide.","tags":["Catalog"]}},"/service/platform/catalog/v2.0/company/{company_id}/application/{application_id}/product-configuration/filter/allow_single":{"post":{"description":"Update allow single flag for filters of the application.","parameters":[{"description":"A `company_id` is a unique identifier for a particular seller account.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"A `application_id` is a unique identifier for a particular sale channel.","in":"path","name":"application_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AllowSingleRequest"}}},"description":"The allow single flag. See details below","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigSuccessResponse"}}},"description":"success message will tell whether the operation was successful."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"updateAllowSingle | Update allow single flag for filters of the application.","tags":["Catalog"]}},"/service/platform/catalog/v2.0/company/{company_id}/application/{application_id}/product-configuration/sort/default_key":{"post":{"description":"Update the default sort key configuration for the application.","parameters":[{"description":"A `company_id` is a unique identifier for a particular seller account.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"A `application_id` is a unique identifier for a particular sale channel.","in":"path","name":"application_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"default_key":"popular"},"schema":{"$ref":"#/components/schemas/DefaultKeyRequest"}}},"description":"The default sort key. See details below","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigSuccessResponse"}}},"description":"success message will tell whether the operation was successful."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"updateDefaultSort | Update the default sort key configuration for the application.","tags":["Catalog"]}},"/service/platform/catalog/v2.0/company/{company_id}/application/{application_id}/product-configuration/{config_type}/":{"get":{"description":"Get the details of the application configured configurations of listing config types.","parameters":[{"description":"A `company_id` is a unique identifier for a particular seller account.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"A `application_id` is a unique identifier for a particular sale channel.","in":"path","name":"application_id","required":true,"schema":{"type":"string"}},{"description":"A `config_type` is an identifier that defines a specific type of configuration.","in":"path","name":"config_type","required":true,"schema":{"enum":["filter","sort","brands","categories","variant","similar"],"type":"string"}},{"description":"The page number to navigate through the given set of results.","in":"query","name":"page_no","required":false,"schema":{"type":"integer"}},{"description":"Number of items to retrieve in each page. Default is 12.","in":"query","name":"page_size","required":false,"schema":{"type":"integer"}},{"description":"Get configuration list filtered by `search` string.","in":"query","name":"search","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"app_id":"5d65089e031f9029f8e8dc2f","attributes":[{"display_type":"text","is_active":true,"key":"item_code","name":"Item Code","priority":1,"slug":"item_code"},{"display_type":"text","is_active":true,"key":"brand","name":"Brand","priority":2,"slug":"brand"}],"id":"62a84b90bd43c0fe4cf53574","is_active":true,"is_default":false,"name":"Test Group12 ","priority":1,"slug":"test-group12-31","template_slugs":["atesttemplate"]},{"app_id":"5d65089e031f9029f8e8dc2f","attributes":[{"display_type":"text","is_active":true,"key":"item_code","name":"Item Code","priority":1,"slug":"item_code"},{"display_type":"text","is_active":true,"key":"brand","name":"Brand","priority":2,"slug":"brand"},{"display_type":"text","is_active":true,"key":"country_of_origin","name":"Country Of Origin","priority":3,"slug":"country_of_origin"},{"display_type":"text","is_active":true,"key":"image_nature","name":"Image Type","priority":4,"slug":"image_nature"},{"display_type":"text","is_active":true,"key":"discount","name":"Discount","priority":5,"slug":"discount"}],"id":"62a84b9ebd43c0fe4cf53576","is_active":true,"is_default":false,"name":"ET","priority":2,"slug":"et14","template_slugs":["atesttemplate"]}],"page":{"current":1,"has_next":false,"next":2,"total_count":2,"type":"number"}},"schema":{"$ref":"#/components/schemas/GetConfigResponse"}}},"description":"configuration details for catalog. See example below or refer `GetConfigResponseSchema` for details"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"getListingConfigurations | Get the details of the application configured configurations of listing config types.","tags":["Catalog"]},"post":{"description":"Add configuration for listing.","parameters":[{"description":"A `company_id` is a unique identifier for a particular seller account.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"A `application_id` is a unique identifier for a particular sale channel.","in":"path","name":"application_id","required":true,"schema":{"type":"string"}},{"description":"A `config_type` is a unique identifier for a particular listing configuration type.","in":"path","name":"config_type","required":true,"schema":{"enum":["filter","sort","variant","similar"],"type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"app_id":"5d64e3500bcad8693a821c0d","default_key":"","is_active":true,"is_default":false,"key":"discount_dsc","logo":"https://hdn-1.fynd.com/products/pictures/attribute/logo/original/iG82Qjay9X-Popularity.png","name":"Discount High to Low","priority":4},"schema":{"$ref":"#/components/schemas/AppConfigurationsSort"}}},"description":"The configuration for listings. See details below","required":true},"responses":{"200":{"content":{"application/json":{"example":{"app_id":"5d64e3500bcad8693a821c0d","default_key":"","id":"62b1ccb815c88fa867ee4dab","is_active":true,"is_default":false,"key":"discount_dsc","logo":"https://hdn-1.fynd.com/products/pictures/attribute/logo/original/iG82Qjay9X-Popularity.png","name":"Discount High to Low","priority":4},"schema":{"$ref":"#/components/schemas/AppConfigurationsSort"}}},"description":"success flag will tell whether the operation was successful."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"createListingConfiguration | Add configuration for listings","tags":["Catalog"]}},"/service/platform/catalog/v2.0/company/{company_id}/application/{application_id}/product-configuration/{config_type}/groups":{"get":{"description":"Get the details of the application configured configurations of group config types.","parameters":[{"description":"A `company_id` is a unique identifier for a particular seller account.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"A `application_id` is a unique identifier for a particular sale channel.","in":"path","name":"application_id","required":true,"schema":{"type":"string"}},{"description":"A `config_type` is an identifier that defines a specific type of configuration.","in":"path","name":"config_type","required":true,"schema":{"enum":["comparisons_groups","details_groups","seller_groups"],"type":"string"}},{"description":"The page number to navigate through the given set of results.","in":"query","name":"page_no","required":false,"schema":{"type":"integer"}},{"description":"Number of items to retrieve in each page. Default is 12.","in":"query","name":"page_size","required":false,"schema":{"type":"integer"}},{"description":"Get configuration list filtered by `search` string.","in":"query","name":"search","required":false,"schema":{"type":"string"}},{"description":"Get configuration list filtered by `template_slug` string. This is for the details and comparision groups.","in":"query","name":"template_slug","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"app_id":"5d65089e031f9029f8e8dc2f","attributes":[{"display_type":"text","is_active":true,"key":"item_code","name":"Item Code","priority":1,"slug":"item_code"},{"display_type":"text","is_active":true,"key":"brand","name":"Brand","priority":2,"slug":"brand"}],"id":"62a84b90bd43c0fe4cf53574","is_active":true,"is_default":false,"name":"Test Group12 ","priority":1,"slug":"test-group12-31","template_slugs":["atesttemplate"]},{"app_id":"5d65089e031f9029f8e8dc2f","attributes":[{"display_type":"text","is_active":true,"key":"item_code","name":"Item Code","priority":1,"slug":"item_code"},{"display_type":"text","is_active":true,"key":"brand","name":"Brand","priority":2,"slug":"brand"},{"display_type":"text","is_active":true,"key":"country_of_origin","name":"Country Of Origin","priority":3,"slug":"country_of_origin"},{"display_type":"text","is_active":true,"key":"image_nature","name":"Image Type","priority":4,"slug":"image_nature"},{"display_type":"text","is_active":true,"key":"discount","name":"Discount","priority":5,"slug":"discount"}],"id":"62a84b9ebd43c0fe4cf53576","is_active":true,"is_default":false,"name":"ET","priority":2,"slug":"et14","template_slugs":["atesttemplate"]}],"page":{"current":1,"has_next":false,"next":2,"total_count":2}},"schema":{"$ref":"#/components/schemas/GetConfigResponse"}}},"description":"configuration details for catalog. See example below or refer `GetConfigResponseSchema` for details"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"getGroupConfigurations | Get the details of the application configured configurations of group config types.","tags":["Catalog"]},"post":{"description":"Create configuration for Group config types.","parameters":[{"description":"A `company_id` is a unique identifier for a particular seller account.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"A `application_id` is a unique identifier for a particular sale channel.","in":"path","name":"application_id","required":true,"schema":{"type":"string"}},{"description":"A `config_type` is a unique identifier for a particular group configuration type.","in":"path","name":"config_type","required":true,"schema":{"enum":["comparisons_groups","details_groups","seller_groups"],"type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"app_id":"5d64e3500bcad8693a821c0d","attributes":[{"display_type":"text","is_active":true,"key":"features","name":"Features","priority":1,"slug":"features"}],"is_active":true,"is_default":false,"name":"test","priority":1,"slug":"test15","template_slugs":["bags"]},"schema":{"$ref":"#/components/schemas/AppConfigurationDetail"}}},"description":"The configuration for groups. See details below","required":true},"responses":{"200":{"content":{"application/json":{"example":{"app_id":"5d64e3500bcad8693a821c0d","attributes":[{"display_type":"text","is_active":true,"key":"features","name":"Features","priority":1,"slug":"features"}],"id":"62b1cdab15c88fa867ee4dac","is_active":true,"is_default":false,"name":"test","priority":1,"slug":"test15","template_slugs":["bags"]},"schema":{"$ref":"#/components/schemas/AppConfigurationDetail"}}},"description":"success flag will tell whether the operation was successful."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"createGroupConfiguration | Create configuration for Group config types.","tags":["Catalog"]}},"/service/platform/catalog/v2.0/company/{company_id}/application/{application_id}/product-configuration/{config_type}/groups/{group_slug}":{"delete":{"description":"Delete configuration of the product config type of the application.","parameters":[{"description":"A `company_id` is a unique identifier for a particular seller account.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"A `application_id` is a unique identifier for a particular sale channel.","in":"path","name":"application_id","required":true,"schema":{"type":"string"}},{"description":"A `config_type` is a unique identifier for a particular group configuration type.","in":"path","name":"config_type","required":true,"schema":{"enum":["comparisons_groups","details_groups","seller_groups"],"type":"string"}},{"description":"A `group_slug` is a unique identifier of a particular configuration.","in":"path","name":"group_slug","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"message":"Config Item deleted successfully."},"schema":{"$ref":"#/components/schemas/ConfigSuccessResponse"}}},"description":"success message will tell whether the operation was successful."},"4XX":{"content":{"application/json":{"example":{"message":"Config Item do not exist."},"schema":{"$ref":"#/components/schemas/ConfigErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"deleteGroupConfiguration | Delete configuration of the product config type of the application.","tags":["Catalog"]},"put":{"description":"Update the group configurations for the application.","parameters":[{"description":"A `company_id` is a unique identifier for a particular seller account.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"A `application_id` is a unique identifier for a particular sale channel.","in":"path","name":"application_id","required":true,"schema":{"type":"string"}},{"description":"A `config_type` is a unique identifier for a particular group configuration type.","in":"path","name":"config_type","required":true,"schema":{"enum":["comparisons_groups","details_groups","seller_groups"],"type":"string"}},{"description":"A `group_slug` is a unique identifier of a particular configuration.","in":"path","name":"group_slug","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"app_id":"5d64e3500bcad8693a821c0d","attributes":[{"display_type":"text","is_active":true,"key":"features","name":"Features","priority":1,"slug":"features"}],"is_active":true,"is_default":false,"name":"test","priority":1,"slug":"test15","template_slugs":["bags"]},"schema":{"$ref":"#/components/schemas/AppConfigurationDetail"}}},"description":"The configuration for groups. See details below","required":true},"responses":{"200":{"content":{"application/json":{"example":{"app_id":"5d64e3500bcad8693a821c0d","attributes":[{"display_type":"text","is_active":true,"key":"features","name":"Features","priority":1,"slug":"features"}],"id":"62b1cdab15c88fa867ee4dac","is_active":true,"is_default":false,"name":"test","priority":1,"slug":"test15","template_slugs":["bags"]},"schema":{"$ref":"#/components/schemas/AppConfigurationDetail"}}},"description":"success flag will tell whether the operation was successful."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"updateGroupConfiguration | Update the group configurations for the application.","tags":["Catalog"]}},"/service/platform/catalog/v2.0/company/{company_id}/application/{application_id}/product-configuration/{config_type}/item/{config_id}/":{"delete":{"description":"Delete configuration for listing.","parameters":[{"description":"A `company_id` is a unique identifier for a particular seller account.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"A `application_id` is a unique identifier for a particular sale channel.","in":"path","name":"application_id","required":true,"schema":{"type":"string"}},{"description":"A `config_type` is a unique identifier for a particular listing configuration type.","in":"path","name":"config_type","required":true,"schema":{"enum":["filter","sort","variant","similar"],"type":"string"}},{"description":"A `config_id` is a unique identifier of a particular configuration.","in":"path","name":"config_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"message":"Config Item deleted successfully."},"schema":{"$ref":"#/components/schemas/ConfigSuccessResponse"}}},"description":"success message will tell whether the operation was successful."},"4XX":{"content":{"application/json":{"example":{"message":"Config Item do not exist."},"schema":{"$ref":"#/components/schemas/ConfigErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"deleteListingConfiguration | Delete configuration for listings","tags":["Catalog"]},"put":{"description":"Update configuration for listing.","parameters":[{"description":"A `company_id` is a unique identifier for a particular seller account.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"A `application_id` is a unique identifier for a particular sale channel.","in":"path","name":"application_id","required":true,"schema":{"type":"string"}},{"description":"A `config_type` is a unique identifier for a particular listing configuration type.","in":"path","name":"config_type","required":true,"schema":{"enum":["filter","sort","brands","categories","variant","similar"],"type":"string"}},{"description":"A `config_id` is a unique identifier of a particular configuration.","in":"path","name":"config_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"app_id":"5d64e3500bcad8693a821c0d","default_key":"latest","id":"6250568de404abd533db571d","is_active":true,"is_default":false,"key":"latest","name":"Latest","priority":1},"schema":{"$ref":"#/components/schemas/AppConfigurationsSort"}}},"description":"The configuration for listings. See details below","required":true},"responses":{"200":{"content":{"application/json":{"example":{"app_id":"5d64e3500bcad8693a821c0d","default_key":"latest","id":"6250568de404abd533db571d","is_active":true,"is_default":false,"key":"latest","name":"Latest","priority":1},"schema":{"$ref":"#/components/schemas/AppConfigurationsSort"}}},"description":"success flag will tell whether the operation was successful."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"updateListingConfiguration | Update configuration for listings","tags":["Catalog"]}},"/service/platform/catalog/v2.0/company/{company_id}/application/{application_id}/product-configuration/{config_type}/metadata/":{"get":{"description":"Get the configuraion metadata details for catalog.","parameters":[{"description":"A `company_id` is a unique identifier for a particular seller account.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"A `application_id` is a unique identifier for a particular sale channel.","in":"path","name":"application_id","required":true,"schema":{"type":"string"}},{"description":"A `config_type` is an identifier that defines a specific type of configuration.","in":"path","name":"config_type","required":true,"schema":{"enum":["filter","sort","details_groups","comparisons_groups","variant","similar","brands","categories","seller_groups"],"type":"string"}},{"description":"Get configuration list filtered by `template_slug` string. This is for the details and comparision groups.","in":"query","name":"template_slug","required":false,"schema":{"type":"string"}},{"in":"query","name":"page_no","description":"The page number to navigate through the given set of results.","schema":{"type":"integer"},"required":false},{"in":"query","name":"page_size","description":"Number of items to retrieve in each page.","schema":{"type":"integer"},"required":false},{"in":"query","name":"q","description":"Get configuration list filtered by `q` string.","schema":{"type":"string"},"required":false}],"responses":{"200":{"content":{"application/json":{"example":{"condition":[{"display":"OR","key":"OR"},{"display":"AND","key":"AND"}],"data":[{"compatible_units":[],"display":"Screen Size","filter_types":["multivalued"],"key":"screen_size_filter"},{"compatible_units":[],"display":"Primary Camera (duplicate)","filter_types":["multivalued"],"key":"primary_camera_filter"},{"compatible_units":[],"display":"Selfie Camera (Duplicate)","filter_types":["multivalued"],"key":"selfie_camera_filter"},{"compatible_units":[],"display":"Weight Group","filter_types":["multivalued"],"key":"weight_group"},{"compatible_units":[],"display":"pallet","filter_types":["multivalued"],"key":"pallet"},{"compatible_units":[],"display":"General Information","filter_types":["multivalued"],"key":"general_information"},{"compatible_units":[],"display":"brand","filter_types":["multivalued"],"key":"brand_name"},{"compatible_units":[],"display":"Gender","filter_types":["multivalued"],"key":"gender"},{"compatible_units":[],"display":"Socks Length","filter_types":["multivalued"],"key":"socks_length"},{"compatible_units":[],"display":"Sub-brand","filter_types":["multivalued"],"key":"sub_brand"},{"compatible_units":[],"display":"Colour","filter_types":["multivalued"],"key":"color"},{"compatible_units":[],"display":"Boot Length","filter_types":["multivalued"],"key":"boot_length"},{"compatible_units":[],"display":"Bottomwear Length","filter_types":["multivalued"],"key":"bottomwear_length"},{"compatible_units":[],"display":"Thread Count","filter_types":["multivalued"],"key":"thread_count"},{"compatible_units":[],"display":"Sleeve Type","filter_types":["multivalued"],"key":"sleeve_type"},{"compatible_units":[],"display":"Collar Type","filter_types":["multivalued"],"key":"collar_type"},{"compatible_units":[],"display":"Food Preference","filter_types":["multivalued"],"key":"food-preference"},{"compatible_units":[],"display":"Guitar Types","filter_types":["multivalued"],"key":"guitar-types"},{"compatible_units":[],"display":"Storage","filter_types":["multivalued"],"key":"storage"},{"compatible_units":[],"display":"Quality","filter_types":["multivalued"],"key":"quality"},{"compatible_units":[],"display":"Material","filter_types":["multivalued"],"key":"material"},{"compatible_units":[],"display":"Arch Type","filter_types":["multivalued"],"key":"arch_type"},{"compatible_units":[],"display":"Like & Dislike","filter_types":["multivalued"],"key":"like-dislike"},{"compatible_units":[],"display":"Dietary preference","filter_types":["multivalued"],"key":"dietary-preference"},{"compatible_units":[],"display":"organic","filter_types":["multivalued"],"key":"organic"},{"compatible_units":[],"display":"Utility","filter_types":["multivalued"],"key":"utility"},{"compatible_units":[],"display":"Dial Shape","filter_types":["multivalued"],"key":"dial_shape"},{"compatible_units":[],"display":"Sheet Size","filter_types":["multivalued"],"key":"sheet_size"},{"compatible_units":[],"display":"Strap Type","filter_types":["multivalued"],"key":"strap_type"},{"compatible_units":[],"display":"Movement Type","filter_types":["multivalued"],"key":"movement_type"},{"compatible_units":[],"display":"Sleeve Length","filter_types":["multivalued"],"key":"sleeve_length"},{"compatible_units":[],"display":"Neck Type","filter_types":["multivalued"],"key":"neck_type"},{"compatible_units":[],"display":"Denim Type","filter_types":["multivalued"],"key":"denim_type"},{"compatible_units":[],"display":"Bed Size","filter_types":["multivalued"],"key":"bed_size"},{"compatible_units":[],"display":"Pattern","filter_types":["multivalued"],"key":"pattern"},{"compatible_units":[],"display":"Topwear Length","filter_types":["multivalued"],"key":"topwear_length"},{"compatible_units":[],"display":"Closure Type","filter_types":["multivalued"],"key":"closure_type"},{"compatible_units":[],"display":"Product Fit","filter_types":["multivalued"],"key":"product_fit"},{"compatible_units":[],"display":"Clasp Type","filter_types":["multivalued"],"key":"clasp_type"},{"compatible_units":[],"display":"Toe Type","filter_types":["multivalued"],"key":"toe_type"},{"compatible_units":[],"display":"Memory (RAM)","filter_types":["multivalued"],"key":"ram"},{"compatible_units":[],"display":"Stone Type","filter_types":["multivalued"],"key":"stone_type"},{"compatible_units":[],"display":"Hair Type","filter_types":["multivalued"],"key":"hair_type"},{"compatible_units":[],"display":"Care Instructions","filter_types":["multivalued"],"key":"care_instructions"},{"compatible_units":[],"display":"Warranty","filter_types":["multivalued"],"key":"warranty"},{"compatible_units":[],"display":"Spf","filter_types":["multivalued"],"key":"spf"},{"compatible_units":[],"display":"Fragrance Type","filter_types":["multivalued"],"key":"fragrance_type"},{"compatible_units":[],"display":"Primary Colour","filter_types":["multivalued"],"key":"primary-colour"},{"compatible_units":[],"display":"Fretboard Material","filter_types":["multivalued"],"key":"fretboard-material"},{"compatible_units":[],"display":"Cleaning Type","filter_types":["multivalued"],"key":"cleaning-type"},{"compatible_units":[],"display":"Lens Material","filter_types":["multivalued"],"key":"lens_material"},{"compatible_units":[],"display":"Maximum Shelf Life","filter_types":["multivalued"],"key":"maximum-shelf-life"},{"compatible_units":[],"display":"Base Flavour","filter_types":["multivalued"],"key":"base-flavour"},{"compatible_units":[],"display":"Battery","filter_types":["multivalued"],"key":"battery"},{"compatible_units":[],"display":"Net Quantity","filter_types":["multivalued"],"key":"net-quantity"},{"compatible_units":[],"display":"Marketer Address","filter_types":["multivalued"],"key":"marketer-address"},{"compatible_units":[],"display":"Marketer Name","filter_types":["multivalued"],"key":"marketer-name"},{"compatible_units":[],"display":"Import Month & Year","filter_types":["multivalued"],"key":"import-month-and-year"},{"compatible_units":[],"display":"Name of the commodity","filter_types":["multivalued"],"key":"name-of-the-commodity"},{"compatible_units":[],"display":"Date first available","filter_types":["multivalued"],"key":"date-first-available"},{"compatible_units":[],"display":"iron_attribute","filter_types":["multivalued"],"key":"iron"},{"compatible_units":[],"display":"iron-template2","filter_types":["multivalued"],"key":"iron-template2"},{"compatible_units":["mg","g","oz","kg","lb"],"display":"Mg","filter_types":["multivalued"],"key":"mg"},{"compatible_units":[],"display":"Name","filter_types":["multivalued"],"key":"name"},{"compatible_units":["mm","cm","in","ft","m","km"],"display":"Sassy Level","filter_types":["multivalued"],"key":"sassy-level"},{"compatible_units":[],"display":"Test Attribute","filter_types":["multivalued"],"key":"test-attribute"},{"compatible_units":[],"display":"Filter Type","filter_types":["multivalued"],"key":"filter-type"},{"compatible_units":[],"display":"L3 Category","filter_types":["multivalued"],"key":"l3-category"},{"compatible_units":[],"display":"Country of Origin","filter_types":["multivalued"],"key":"country_of_origin"},{"compatible_units":[],"display":"Item Code","filter_types":["multivalued"],"key":"item_code"},{"display":"Item Code","filter_types":["multivalued"],"key":"item_code","units":[]},{"display":"Brand","filter_types":["multivalued"],"key":"brand","units":[]},{"display":"Country Of Origin","filter_types":["multivalued"],"key":"country_of_origin","units":[]},{"display":"Image Type","filter_types":["multivalued"],"key":"image_nature"},{"display":"Sizes","filter_types":["multivalued"],"key":"sizes"},{"display":"Discount","filter_types":["range","intervals","multivalued"],"key":"discount"},{"display":"Price","filter_types":["range","intervals","multivalued"],"key":"min_price_effective"},{"display":"Department","filter_types":["multivalued"],"key":"departments"},{"display":"Category","filter_types":["multivalued"],"key":"l3_category_slugs"},{"display":"Brand","filter_types":["multivalued"],"key":"brand_slug"},{"display":"Size Depth","filter_types":["multivalued","range"],"key":"size_depth"},{"display":"Set","filter_types":["multivalued"],"key":"is_set"},{"display":"Country of Origin","filter_types":["multivalued"],"key":"country_of_origin"},{"display":"Item Code","filter_types":["multivalued"],"key":"item_code"},{"display":"Available","filter_types":["singlevalued"],"key":"is_available"},{"display":"Rating","filter_types":["range","intervals","multivalued"],"key":"rating"}],"page":[{"current":1},{"type":"number"},{"size":1},{"has_previous":false},{"has_next":false},{"item_total":3}],"values":[{"sort":[{"display":"Product Count","key":"count"},{"display":"Ascending","key":"ascending"},{"display":"Descending","key":"descending"}],"type":[{"display":"Range Bar","key":"range"},{"display":"Bucket Values","key":"intervals"},{"display":"Single","key":"multivalued"},{"display":"Single","key":"singlevalued"}]}]},"schema":{"$ref":"#/components/schemas/GetConfigMetadataResponse"}}},"description":"configuration details for catalog. See example below or refer `GetConfigMetadataResponseSchema` for details"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"getConfigurationMetadata | Get configuration metadata details for catalog for admin panel","tags":["Catalog"]}},"/service/platform/catalog/v2.0/company/{company_id}/hsn/":{"get":{"description":"Hsn Code List.","parameters":[{"description":"page no","in":"query","name":"page_no","required":false,"schema":{"default":1,"type":"integer"}},{"description":"page size","in":"query","name":"page_size","required":false,"schema":{"default":12,"type":"integer"}},{"description":"search using hsn code, description, reporting_hsn","in":"query","name":"q","required":false,"schema":{"type":"string"}},{"description":"search using type","in":"query","name":"type","required":false,"schema":{"type":"string"}},{"description":"Company Id for which HSN codes needs to be fetched","in":"path","name":"company_id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"example":{"items":[{"country_code":"INDIA","description":"final test updated","hs2_code":"26","hsn_code":"123fght3","id":"619e17925e3d3ea77d6fe8cf","modified_on":"2021-11-25T06:37:00.880000Z","reporting_hsn":"12345678","slabs":[{"effective_date":"2021-11-18T10:00:31.798000+00:00","tax":10,"threshold":100},{"effective_date":"2022-11-18T10:00:31.798000+00:00","tax":20,"threshold":200}],"tax_on_esp":true,"tax_on_mrp":false,"taxes":[{"effective_date":"2021-04-02T15:43:59.410000Z","rate":0,"threshold":0.5}],"type":"goods","uid":"123fgh43-1"}],"page":{"current":"1","has_next":true,"has_previous":false,"item_total":8,"size":8,"type":"number"}},"schema":{"$ref":"#/components/schemas/HsnCodesListingResponseSchemaV2"}}},"description":"List of all HSN Codes. See example below or refer `HsnCodesListingResponseSchema` for details"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request."}},"summary":"getAllProductHsnCodes | Hsn Code List.","tags":["Catalog"]}},"/service/platform/catalog/v2.0/company/{company_id}/hsn/{reporting_hsn}":{"get":{"description":"Hsn Code List.","parameters":[{"description":"reporting_hsn","in":"path","name":"reporting_hsn","required":true,"schema":{"type":"string"}},{"description":"Company Id for which HSN codes needs to be fetched","in":"path","name":"company_id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"example":{"country_code":"IN","created_by":{"user_id":-1,"username":"silverbolt"},"created_on":"2022-02-24T09:14:03Z","description":"Data for HSN Code","hsn_code":"89787179","id":"6216ff0378da3f906fc82544","modified_by":{"user_id":-1,"username":"silverbolt"},"modified_on":"2022-02-24T09:14:03Z","reporting_hsn":"89787179H29","taxes":[{"cess":23,"effective_date":"2022-02-11T15:00:00","rate":5,"threshold":10000},{"effective_date":"2022-02-11T15:00:00","rate":12,"threshold":12000},{"effective_date":"2022-02-12T15:00:00","rate":18,"threshold":5000}],"type":"goods"},"schema":{"$ref":"#/components/schemas/HSNDataInsertV2"}}},"description":"Get specific HSN details. See example below or refer `HsnCodesListingResponseSchema` for details"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request."}},"summary":"getSingleProductHSNCode | Hsn Code List.","tags":["Catalog"]}},"/service/platform/catalog/v2.0/company/{company_id}/inventory/":{"post":{"description":"This API allows add Inventory for particular size and store.","parameters":[{"description":"Id of the company associated to product that is to be viewed.","in":"path","name":"company_id","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InventoryRequestSchemaV2"}}},"description":"Product object that needs to be created.","required":true},"responses":{"200":{"content":{"application/json":{"example":{"items":[{"data":{"expiration_date":"9998-01-30T23:59:00","price_effective":109.01,"price_marked":130,"seller_identifier":"SELLER123","store_id":124,"total_quantity":34},"reason":{"message":"Product not found","reason_code":2005}},{"data":{"expiration_date":"9998-01-30T23:59:00","price_effective":109.01,"price_marked":130,"seller_identifier":"SELLER123","store_id":124,"total_quantity":34},"reason":{"message":"Size not found","reason_code":2004}}],"message":"Partially Successful"},"schema":{"$ref":"#/components/schemas/InventoryUpdateResponse"}}},"description":"Returns a success or partial success response"},"400":{"content":{"application/json":{"example":{"items":[{"data":{"expiration_date":"9998-01-30T23:59:00","price_effective":109.01,"price_marked":130,"seller_identifier":"SELLER123","store_id":124,"total_quantity":34},"reason":{"message":"Product not found","reason_code":2005}},{"data":{"expiration_date":"9998-01-30T23:59:00","price_effective":109.01,"price_marked":130,"seller_identifier":"SELLER123","store_id":124,"total_quantity":34},"reason":{"message":"Size not found","reason_code":2004}}],"message":"Failed"},"schema":{"$ref":"#/components/schemas/InventoryUpdateResponse"}}},"description":"Returns a failed response"}},"summary":"updateInventories | Add Inventory for particular size and store.","tags":["Catalog"]}},"/service/platform/catalog/v2.0/company/{company_id}/inventory/download/":{"get":{"description":"This API helps you the get the history of inventory jobs depending on the filtered criteria.","parameters":[{"description":"It is the unique identifier of the company.","in":"path","name":"company_id","required":true,"schema":{"type":"integer"}},{"description":"Status of the export job.","in":"query","name":"status","required":false,"schema":{"type":"string"}},{"description":"Inventory export history filtered according to from_date.","in":"query","name":"from_date","required":false,"schema":{"type":"string"}},{"description":"Inventory export history filtered according to from_date.","in":"query","name":"to_date","required":false,"schema":{"type":"string"}},{"description":"Inventory export history filtered according to task ID.","in":"query","name":"q","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"items":{"_id":"6401bd972a2e6c3d508c9203","completed_on":"2023-03-03T09:33:11.416000Z","created_by":{"user_id":"5e199e6998cfe1776f1385dc","username":"rohanshah@fynd.com"},"created_on":"2023-03-03T09:27:51.262000Z","filters":{"brand_ids":[2751],"brands":["Puma"],"store_ids":[3622],"stores":["Vikings Cbs"]},"id":"6401bd972a2e6c3d508c9203","modified_on":"2023-03-03T09:27:51.262000","notification_emails":[],"seller_id":577,"status":"success","task_id":"ab469da4-b9a5-11ed-955a-d6fb21611540","type":"excel","url":"https://regrowth.s3.amazonaws.com/slingshot-catalogues/seller-catalog/577/ab469da4-b9a5-11ed-955a-d6fb21611540/ab469da4-b9a5-11ed-955a-d6fb21611540.zip"}},"schema":{"$ref":"#/components/schemas/InventoryExportJobListResponse"}}},"description":"Returns a list of inventory export jobs"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"listInventoryExport | Get the history of the inventory export.","tags":["Catalog"]},"post":{"description":"This API helps to create a Inventory export job.","parameters":[{"description":"Company Id in which assets to be uploaded.","in":"path","name":"company_id","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"example":{"filters":{"brand_ids":[2751],"store_ids":[3622]},"type":"excel"},"schema":{"$ref":"#/components/schemas/InventoryCreateRequest"}}},"description":"Inventory export job object.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InventoryExportResponse"}}},"description":"Returns a success response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"createInventoryExport | Create an inventory export job.","tags":["Catalog"]}},"/service/platform/catalog/v2.0/company/{company_id}/products/":{"get":{"description":"This API gets meta associated to products.","parameters":[{"description":"Get list of products filtered by company Id","in":"path","name":"company_id","required":true,"schema":{"type":"integer"}},{"description":"Get multiple products filtered by Brand Ids","in":"query","name":"brand_ids","required":false,"schema":{"items":{"type":"integer"},"type":"array"}},{"description":"Get multiple products filtered by Category Ids","in":"query","name":"category_ids","required":false,"schema":{"items":{"type":"integer"},"type":"array"}},{"description":"Get multiple products filtered by Item Ids","in":"query","name":"item_ids","required":false,"schema":{"items":{"type":"integer"},"type":"array"}},{"description":"Get multiple products filtered by Department Ids","in":"query","name":"department_ids","required":false,"schema":{"items":{"type":"integer"},"type":"array"}},{"description":"Get multiple products filtered by Item Code","in":"query","name":"item_code","required":false,"schema":{"items":{"type":"string"},"type":"array"}},{"description":"Get multiple products filtered by q string","in":"query","name":"q","required":false,"schema":{"type":"string"}},{"description":"Get multiple products filtered by tags","in":"query","name":"tags","required":false,"schema":{"items":{"type":"string"},"type":"array"}},{"description":"The page number to navigate through the given set of results","in":"query","name":"page_no","required":false,"schema":{"type":"integer"}},{"description":"Number of items to retrieve in each page. Default is 10.","in":"query","name":"page_size","required":false,"schema":{"default":10,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"example":{"items":[{"_custom_json":{},"all_company_ids":[1],"all_identifiers":["19WE100"],"all_sizes":[{"brand_uid":1,"company_id":1,"identifiers":[{"gtin_type":"ean","gtin_value":"HGS272727272","primary":true}],"item_code":"TVSET111","marked_price":35000,"seller_identifier":"HGS272727272","size":"XXLX23, MX11, LX67, XLX45 (146 PCS)"}],"brand":{"logo":{"aspect_ratio":"1:1","aspect_ratio_f":1,"secure_url":"https://hdn-1.jiox0.de/jioecomm/seller/pictures/logo/50x0/apple-7f951c/logo_apple.png","url":"https://hdn-1.jiox0.de/jioecomm/seller/pictures/logo/50x0/apple-7f951c/logo_apple.png"},"name":"Apple","uid":13},"brand_uid":1,"category_slug":"qled-television","category_uid":1,"country_of_origin":"India","created_by":{"user_id":"5","username":"919049753052_37528"},"created_on":"2021-04-02T15:43:59.410000Z","currency":"INR","custom_order":{"is_custom_order":true,"manufacturing_time":2,"manufacturing_time_unit":"days"},"departments":[1],"description":"Tv","highlights":["42 Inch"],"hsn_code":"11111111","id":"5f4f2f6371a5970001f13655","image_nature":"standard","images":[{"aspect_ratio":"16:25","aspect_ratio_f":0.64,"secure_url":"https://hdn-1.addsale.com/x0/products/pictures/item/free/135x0/dcizgsG_Y-Tv-Set.png","url":"https://hdn-1.addsale.com/x0/products/pictures/item/free/135x0/dcizgsG_Y-Tv-Set.png"}],"is_dependent":false,"is_image_less_product":false,"is_physical":true,"is_set":true,"item_code":"TVSET111","item_type":"set","l3_mapping":["electronics>qled_television"],"media":[{"type":"image","url":"https://hdn-1.addsale.com/x0/products/pictures/item/free/135x0/dcizgsG_Y-Tv-Set.png"}],"modified_by":{"user_id":"xxxxxxxxxxx","username":"xxxxxxxxxx"},"modified_on":"2021-04-02T15:43:59.410000Z","multi_size":true,"name":"TV Set","no_of_boxes":1,"price":{"effective":{"max":25000,"min":25000},"marked":{"max":35000,"min":35000}},"product_group_tag":[],"product_publish":{"is_set":false,"product_online_date":"2021-04-02T15:43:59.410000Z"},"return_config":{"returnable":false,"time":0,"unit":"days"},"short_description":"","size_guide":"slim-fit-shirts-for-men","sizes":[{"size":"FGX33, GHX33 (66 PCS)","store_count":1},{"size":"XSE WE23X100 (100 PCS)","store_count":2},{"size":"XSEX100 (100 PCS)","store_count":3},{"size":"XXLX23, MX11, LX67, XLX45 (146 PCS)","store_count":3}],"slug":"tv-set","stage":"verified","synonyms":[],"tags":[],"teaser_tag":{},"template_tag":"television","trader":[{"address":["sdfdsfsdf"],"name":"asdasd"}],"trader_type":"Packer","uid":7501547,"variants":{},"verification_status":"pending","verified_by":{"user_id":"0","username":"Silverbolt"},"verified_on":"2020-07-23T04:20:43.810000Z"}],"page":{"current":1,"has_next":false,"has_previous":false,"item_total":1,"size":1,"type":"number"}},"schema":{"$ref":"#/components/schemas/ProductListingResponseV2"}}},"description":"Product Meta. See example below for details"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"getProducts | Get product list","tags":["Catalog"]},"post":{"description":"This API allows to create product.","parameters":[{"description":"Id of the company associated to product that is to be viewed.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductCreateUpdateSchemaV2"}}},"description":"Product object that needs to be created.","required":true},"responses":{"200":{"content":{"application/json":{"example":{"success":true},"schema":{"$ref":"#/components/schemas/SuccessResponse1"}}},"description":"Returns a success response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"createProduct | Create a product.","tags":["Catalog"]}},"/service/platform/catalog/v2.0/company/{company_id}/products/bulk":{"post":{"description":"This API helps to create a bulk products upload job.","parameters":[{"description":"Company Id in which assets to be uploaded.","in":"path","name":"company_id","required":true,"schema":{"type":"integer"}},{"description":"Department of the product to be uploaded.","in":"query","name":"department","required":true,"schema":{"type":"string"}},{"description":"Product type of the product to be uploaded i.e. set, standard , digital.","in":"query","name":"product_type","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkJob"}}},"description":"Bulk Product Upload data that needs to be uploaded","required":true},"responses":{"200":{"content":{"application/json":{"example":{"batch_id":"507f1f77bcf86cd799439011","created_on":"2021-04-02T15:43:59.410000Z"},"schema":{"$ref":"#/components/schemas/BulkResponse"}}},"description":"Returns a success response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"uploadBulkProducts | Create a Bulk product to upload job.","tags":["Catalog"]}},"/service/platform/catalog/v2.0/company/{company_id}/products/downloads/":{"get":{"description":"Can view details including trigger data, task id , etc.","parameters":[{"description":"A `company_id` is a unique identifier for a particular seller account.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"This is a parameter used to find all the jobs with the specified status.","in":"query","name":"status","required":false,"schema":{"type":"string"}},{"description":"This is a parameter used to find the job from the date specified to the current date.","in":"query","name":"from_date","required":false,"schema":{"format":"date","type":"string"}},{"description":"This is a parameter used to find the job from the from_date specified to the to_date.","in":"query","name":"to_date","required":false,"schema":{"format":"date","type":"string"}},{"description":"It is a query parameter to search the export job with the task ID.","in":"query","name":"q","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"items":[{"completed_on":"2020-12-23T07:23:41.031000Z","created_by":{"user_id":"5646","username":"917972410891_48194"},"data":{"brand":["ruosh"],"templates":["mobile-phones-and-tablet"],"type":"csv"},"id":"5fe2f077516d980001880943","seller_id":3,"status":"success","task_id":"c4b54ace-44ef-11eb-9806-1ef9bc4a2da1","template_tags":{"mobile-phones-and-tablet":{"display":"Mobile Phones & Tablet","logo":"https://hdn-1.jiox0.de/jiox0/seller/pictures/logo/original/Oda39B_99946594-portable-devices-with-tablet-and-mobile-phone-vector-icon-for-apps-and-websites.jpgcc2dff44-7fae-4002-9ebe-d2b59c8bee91/Oda39B_99946594-portable-devices-with-tablet-and-mobile-phone-vector-icon-for-apps-and-websites.jpg"}},"trigger_on":"2020-12-23T07:23:35.302000Z","url":"https://regrowth.s3.amazonaws.com/slingshot-catalogues/seller-catalog/3/c4b54ace-44ef-11eb-9806-1ef9bc4a2da1/c4b54ace-44ef-11eb-9806-1ef9bc4a2da1.zip"}],"page":{}},"schema":{"$ref":"#/components/schemas/ProductDownloadsResponse"}}},"description":"List of Product Downloads Data. See example below or refer `ProductDownloadsResponse` for details"},"4XX":{"content":{"application/json":{"example":{"code":"400","message":"Company not found."},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"getProductExportJobs | Allows you to list all product templates export list details","tags":["Catalog"]},"post":{"description":"This API helps to create a Inventory export job.","parameters":[{"description":"A `company_id` is a unique identifier for a particular seller account.","in":"path","name":"company_id","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"example":{"filters":{"brands":[],"catalogue_types":["standard"],"templates":["activewear-accessories"]},"type":"excel"},"schema":{"$ref":"#/components/schemas/ProductTemplateDownloadsExport"}}},"description":"Product export job object.","required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"_id":"6401cb6729885c34aa30b0c6","created_by":{"user_id":"550fe8ce436ea332b9e4b4b0","username":"purvashukla_gofynd_com_44895"},"created_on":"2023-03-03T10:26:47.047171Z","filters":{"brands":[],"catalogue_types":["standard"],"templates":["footwear"]},"modified_on":"2023-03-03T10:26:47.047179","notification_emails":[],"seller_id":577,"stats":{},"status":"pending","task_id":"e6c47f1a-b9ad-11ed-b7a0-3ef7b700888d","type":"excel"}},"schema":{"$ref":"#/components/schemas/ProductDownloadsResponse"}}},"description":"Returns a success response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"createProductExportJob | Create a product export job.","tags":["Catalog"]}},"/service/platform/catalog/v2.0/company/{company_id}/products/{item_id}/":{"delete":{"description":"This API allows to delete product.","parameters":[{"description":"Company Id of the company associated to product that is to be deleted.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"Id of the product to be updated.","in":"path","name":"item_id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"example":{"success":true},"schema":{"$ref":"#/components/schemas/SuccessResponse"}}},"description":"Returns a success response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"deleteProduct | Delete a product.","tags":["Catalog"]},"get":{"description":"This API helps to get data associated to a particular product.","parameters":[{"description":"Company Id of the product.","in":"path","name":"company_id","required":true,"schema":{"type":"integer"}},{"description":"Item Id of the product.","in":"path","name":"item_id","required":true,"schema":{"type":"integer"}},{"description":"Brand Id of the product.","in":"query","name":"brand_uid","required":false,"schema":{"type":"integer"}},{"description":"Item code of the product.","in":"query","name":"item_code","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"_custom_json":{},"all_company_ids":[835],"all_identifiers":["TEST-015434"],"attributes":{"essential":"No","gender":["Men"],"marketer-address":"dfg","marketer-name":"gfdfd","pattern":"Printed","primary_color":"Black","primary_material":"Cotton Blend"},"brand":{"logo":{"aspect_ratio":"1:1","aspect_ratio_f":1,"secure_url":"","url":""},"name":"product1","uid":3272},"brand_uid":3272,"category":{"l1":{"name":"Ethnic Wear","slug":"ethnic-wear","uid":443},"l2":{"name":"Hijabs & Abayas","slug":"hijabs-abayas","uid":414},"l3":{"name":"Abayas","slug":"abayas","uid":441}},"category_slug":"abayas","category_uid":441,"country_of_origin":"India","created_by":{"super_user":false,"user_id":"757bf08ff5dd4ba95f8778cf","username":"mdnehalahmed_fynd_external_com_90136"},"created_on":"2023-02-16T09:37:31.304000","currency":"INR","custom_order":{"is_custom_order":false,"manufacturing_time":0,"manufacturing_time_unit":"days"},"departments":[21],"description":"","highlights":[],"id":"63edf95bf314486d44a6b361","is_active":true,"is_dependent":false,"is_expirable":false,"is_image_less_product":false,"is_set":false,"item_code":"TEST-01","item_type":"standard","media":[{"type":"image","url":"/x0/products/pictures/item/free/original/Hsw-U3Kut-Test-01.jpeg"}],"modified_by":{"super_user":false,"user_id":"757bf08ff5dd4ba95f8778cf","username":"mdnehalahmed_fynd_external_com_90136"},"modified_on":"2023-02-16T09:37:31.304000","multi_size":false,"name":"Test-01","net_quantity":{},"no_of_boxes":1,"product_group_tag":[],"product_publish":{"is_set":false,"product_online_date":"2023-02-16T09:37:29.620000Z"},"return_config":{"returnable":false,"time":0,"unit":"days"},"short_description":"","size_guide":"","sizes":[{"_custom_json":{},"brand_uid":3272,"company_id":835,"created_on":"2023-02-16T09:37:31.352000","currency":"INR","id":"63edf95bf314486d44a6b364","identifiers":[{"gtin_type":"ean","gtin_value":"TEST-015434","primary":true}],"is_set":false,"item_code":"TEST-01","item_dimensions_unit_of_measure":"cm","item_height":10,"item_length":10,"item_weight":10,"item_weight_unit_of_measure":"gram","item_width":10,"modified_on":"2023-02-16T09:37:31.352000","price":10,"price_effective":10,"price_transfer":0,"seller_identifier":"TEST-015434","size":"OS","track_inventory":true}],"slug":"test-01-7542894","stage":"pending","tags":[],"tax_identifier":{"hsn_code":"97211110","hsn_code_id":"63d78f483c1714abdd406766","reporting_hsn":"97211110H1"},"teaser_tag":{},"template_tag":"ethnicwear","trader":[{"address":["fdgh"],"name":"fgt","type":"Manufacturer"}],"uid":7542894,"variant_media":{},"variants":{}}},"schema":{"$ref":"#/components/schemas/SingleProductResponse"}}},"description":"Product object. See example below or refer `product.utils.format_product_response` for details"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"getProduct | Get a single product.","tags":["Catalog"]},"put":{"description":"This API allows to edit product.","parameters":[{"description":"Id of the company associated to product that is to be viewed.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"Id of the product to be updated.","in":"path","name":"item_id","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"example":{"attributes":{"essential":"Yes","gender":["Boys"],"marketer-address":"Nazarbagh","marketer-name":"Mazarbagh","primary_color":"Red","primary_material":"Canvas"},"brand":{"logo":{"aspect_ratio":"1:1","aspect_ratio_f":1,"secure_url":"https://hdn-1.fynd.com/brands/pictures/square-logo/50x0/mPBaWqGRnjR-RMOnlpdMPKm-yjn5mua63gfmzdpombb1.png","url":"https://hdn-1.fynd.com/brands/pictures/square-logo/50x0/mPBaWqGRnjR-RMOnlpdMPKm-yjn5mua63gfmzdpombb1.png"},"name":"RollUp","uid":1486},"brand_uid":1486,"category_slug":"printed-tape","company_id":884,"country_of_origin":"India","currency":"INR","departments":[11],"description":"FyndStore 4 inch Printed BOPP Tapes ","hsn_code":"48190000","id":"5f5a433c74f3f400017cdaa0","is_active":true,"is_dependent":false,"is_set":true,"item_code":"TP_FS_01","item_type":"set","media":[{"type":"image","url":"https://hdn-1.fynd.com/media/pictures/tagged_items/original/TPFS01/IMG20200624130956.jpg"}],"multi_size":true,"name":"Printed Fyndstore Packaging Tape (4inch X 6 Meter length) - Pack of 2","product_publish":{"is_set":false,"product_online_date":"2020-09-10T15:16:12.322000Z"},"return_config":{"returnable":true,"time":30,"unit":"days"},"sizes":[{"brand_uid":1486,"company_id":884,"currency":"INR","id":"5f5a433c74f3f400017cdaa1","identifiers":[{"gtin_type":"sku_code","gtin_value":"TP_FS_01","primary":true}],"is_set":true,"item_code":"TP_FS_01","item_dimensions_unit_of_measure":"cm","item_height":10.16,"item_length":10.16,"item_weight":0.15,"item_weight_unit_of_measure":"gram","item_width":10.16,"price":1000,"price_effective":999,"price_transfer":0,"seller_identifier":"TP_FS_01","set":{"quantity":1,"size_distribution":{"sizes":[{"pieces":1,"size":"OS"}]}},"size":"OS","store_count":1,"track_inventory":true}],"slug":"printed-fyndstore-packaging-tape-4inch-x-6-meter-length-pack-of-2-49d7343fc677","tax_identifier":{},"template_tag":"industrial-supplies","trader":[{"name":"ab"}],"uid":1282497,"variants":{}},"schema":{"$ref":"#/components/schemas/ProductCreateUpdateSchemaV2"}}},"description":"Product object that needs to be updated.","required":true},"responses":{"200":{"content":{"application/json":{"example":{"success":true},"schema":{"$ref":"#/components/schemas/SuccessResponse"}}},"description":"Returns a success response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"editProduct | Edit a product.","tags":["Catalog"]}},"/service/platform/catalog/v2.0/company/{company_id}/products/{item_id}/all_sizes":{"get":{"description":"This API allows to get  All Sizes for a given Product.","parameters":[{"description":"Id of the company associated to product that is to be viewed.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"Id of the product to be updated.","in":"path","name":"item_id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"example":{"all_sizes":[{"identifiers":[{"gtin_type":"ean","gtin_value":"74352323423","primary":true}],"item_dimensions_unit_of_measure":"cm","item_height":100,"item_length":1000,"item_weight":100,"item_weight_unit_of_measure":"gram","item_width":1000,"size":"OS"}]},"schema":{"$ref":"#/components/schemas/GetAllSizes"}}},"description":"List Product Sizes. See example below or refer `AllSizes` for details"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"allSizes | All Sizes for a given Product","tags":["Catalog"]}},"/service/platform/catalog/v2.0/company/{company_id}/products/{item_id}/inventory/{seller_identifier}":{"delete":{"description":"This API allows add Inventory for particular size and store.","parameters":[{"description":"Id of the company associated to product that is to be viewed.","in":"path","name":"company_id","required":true,"schema":{"type":"integer"}},{"description":"Item code of the product of which size is to be get.","in":"path","name":"item_id","required":true,"schema":{"type":"integer"}},{"description":"Size Identifier (Seller Identifier or Primary Identifier) of which inventory is to get.","in":"path","name":"seller_identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InventoryRequestSchemaV2"}}},"description":"Product object that needs to be created.","required":true},"responses":{"200":{"content":{"application/json":{"example":{"items":[{"data":{"expiration_date":"9998-01-30T23:59:00","price_effective":109.01,"price_marked":130,"seller_identifier":"SELLER123","store_id":124,"total_quantity":34},"reason":{"message":"Product not found","reason_code":2005}},{"data":{"expiration_date":"9998-01-30T23:59:00","price_effective":109.01,"price_marked":130,"seller_identifier":"SELLER123","store_id":124,"total_quantity":34},"reason":{"message":"Size not found","reason_code":2004}}],"message":"Partially Successful"},"schema":{"$ref":"#/components/schemas/InventoryUpdateResponse"}}},"description":"Returns a success response"},"400":{"content":{"application/json":{"example":{"items":[{"data":{"expiration_date":"9998-01-30T23:59:00","price_effective":109.01,"price_marked":130,"seller_identifier":"SELLER123","store_id":124,"total_quantity":34},"reason":{"message":"Product not found","reason_code":2005}},{"data":{"expiration_date":"9998-01-30T23:59:00","price_effective":109.01,"price_marked":130,"seller_identifier":"SELLER123","store_id":124,"total_quantity":34},"reason":{"message":"Size not found","reason_code":2004}}],"message":"Failed"},"schema":{"$ref":"#/components/schemas/InventoryUpdateResponse"}}},"description":"Returns a failed response"}},"summary":"deleteRealtimeInventory | Add Inventory for particular size and store.","tags":["Catalog"]},"post":{"description":"This API allows add Inventory for particular size and store.","parameters":[{"description":"Id of the company associated to product that is to be viewed.","in":"path","name":"company_id","required":true,"schema":{"type":"integer"}},{"description":"Item code of the product of which size is to be get.","in":"path","name":"item_id","required":true,"schema":{"type":"integer"}},{"description":"Size Identifier (Seller Identifier or Primary Identifier) of which inventory is to get.","in":"path","name":"seller_identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InventoryRequestSchemaV2"}}},"description":"Product object that needs to be created.","required":true},"responses":{"200":{"content":{"application/json":{"example":{"items":[{"data":{"expiration_date":"9998-01-30T23:59:00","price_effective":109.01,"price_marked":130,"seller_identifier":"SELLER123","store_id":124,"total_quantity":34},"reason":{"message":"Product not found","reason_code":2005}},{"data":{"expiration_date":"9998-01-30T23:59:00","price_effective":109.01,"price_marked":130,"seller_identifier":"SELLER123","store_id":124,"total_quantity":34},"reason":{"message":"Size not found","reason_code":2004}}],"message":"Partially Successful"},"schema":{"$ref":"#/components/schemas/InventoryUpdateResponse"}}},"description":"Returns a success response"},"400":{"content":{"application/json":{"example":{"items":[{"data":{"expiration_date":"9998-01-30T23:59:00","price_effective":109.01,"price_marked":130,"seller_identifier":"SELLER123","store_id":124,"total_quantity":34},"reason":{"message":"Product not found","reason_code":2005}},{"data":{"expiration_date":"9998-01-30T23:59:00","price_effective":109.01,"price_marked":130,"seller_identifier":"SELLER123","store_id":124,"total_quantity":34},"reason":{"message":"Size not found","reason_code":2004}}],"message":"Failed"},"schema":{"$ref":"#/components/schemas/InventoryUpdateResponse"}}},"description":"Returns a failed response"}},"summary":"updateRealtimeInventory | Add Inventory for particular size and store.","tags":["Catalog"]}},"/service/platform/catalog/v1.0/company/{company_id}/channel":{"get":{"description":"This API allows to get marketplace information.","parameters":[{"description":"Id of the company associated to the marketplace.","in":"path","name":"company_id","schema":{"type":"integer"},"required":true}],"responses":{"200":{"content":{"application/json":{"example":{"items":[{"brand_ids":[],"app_id":"000000000000000000000001","enabled":true,"created_by":{"username":"test@gofynd.com","user_id":"ef56cde2dc3227c44bcb73fd"},"created_on":"2023-07-11T18:27:10.477000","opt_level":"company","company_id":1,"modified_by":{"username":"test@gofynd.com","user_id":"ef56cde2dc3227c44bcb73fd"},"store_ids":[],"modified_on":"2023-07-11T18:27:10.477000","platform":"fynd","_id":"64ad9efe8069f0f413265003"}],"page":{"current":1,"has_next":false,"has_previous":false,"item_total":6,"size":1,"type":"number"}},"schema":{"$ref":"#/components/schemas/GetAllMarketplaces"}}},"description":"List all Marketplace details."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"getMarketplaces | List all marketplaces","tags":["Catalog"]}},"/service/platform/catalog/v1.0/company/{company_id}/channel/{marketplace_slug}/opt-in":{"put":{"description":"This API allows to update marketplace optin for a company.","parameters":[{"description":"Id of the company associated to the marketplace.","in":"path","name":"company_id","schema":{"type":"integer"},"required":true},{"description":"Slug of the marketplace .","in":"path","name":"marketplace_slug","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMarketplaceOptinRequest"}}},"description":"Marketplace object that needs to be created.","required":true},"responses":{"200":{"content":{"application/json":{"example":{"items":null,"-data":{"brand_ids":[],"app_id":"000000000000000000000001","enabled":true,"created_by":{"username":"test@gofynd.com","user_id":"ef56cde2dc3227c44bcb73fd"},"opt_level":"company","company_id":1,"modified_by":{"username":"test@gofynd.com","user_id":"ef56cde2dc3227c44bcb73fd"},"store_ids":[],"platform":"fynd"}},"schema":{"$ref":"#/components/schemas/UpdateMarketplaceOptinResponse"}}},"description":"Update marketplace optin config."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body for specific reason"}},"summary":"updateMarketplaceOptin | Update marketplace optin","tags":["Catalog"]}},"/service/common/configuration/v1.0/application/search-application":{"get":{"description":"Provide application name or domain url","summary":"searchApplication | Search Application","parameters":[{"in":"header","name":"authorization","schema":{"type":"string"}},{"in":"query","name":"query","schema":{"type":"string"},"description":"Provide application name"}],"tags":["Common"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationResponse"},"example":{"application":{"website":{"enabled":true,"basepath":"/"},"cors":{"domains":[]},"auth":{"enabled":true},"description":"test","channel_type":"store","cache_ttl":-1,"internal":false,"is_active":true,"mode":"live","_id":"620b931ee7bfb11f910bf4a3","company_id":2,"name":"test","owner":"5b9b98150df588546aaea6d2","logo":{"secure_url":"https://hdn-1.addsale.com/x0/company/164/applications/5efc9913f474c329718e3690/application/pictures/free-logo/original/olqHM8LNr-JioMart-Groceries.png"},"favicon":{"secure_url":"https://hdn-1.addsale.com/x0/company/164/applications/5efc9913f474c329718e3690/application/pictures/free-logo/original/olqHM8LNr-JioMart-Groceries.png"},"banner":{"secure_url":"https://hdn-1.addsale.com/x0/company/164/applications/5efc9913f474c329718e3690/application/pictures/landscape-banner/original/D2fr98CUH-JioMart-Groceries.png"},"token":"tPQv0nc23","tokens":[{"token":"tPQv0nc23","created_at":"2022-02-15T11:48:46.909Z"}],"domains":[{"verified":true,"is_primary":true,"is_shortlink":true,"_id":"620b931ee7bfb11f910bf4a4","name":"qckvv5lhp.hostfynd.dev"}],"redirections":[],"meta":[],"created_at":"2022-02-15T11:48:46.909Z","modified_at":"2022-02-15T11:48:46.909Z","__v":0,"domain":{"verified":true,"is_primary":true,"is_shortlink":true,"_id":"620b931ee7bfb11f910bf4a4","name":"qckvv5lhp.hostfynd.dev"},"id":"620b931ee7bfb11f910bf4a3"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"value":{"message":"Invalid application domain or id."}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"value":{"message":"No application found"}}}}}}}},"/service/common/configuration/v1.0/location":{"get":{"tags":["Common"],"summary":"getLocations | Get countries, states, cities","description":"Retrieve a list of countries, states, or cities based on the provided location_type and id parameters.","parameters":[{"in":"query","name":"location_type","schema":{"type":"string","enum":["country","state","city"]}},{"in":"query","name":"id","schema":{"type":"string"},"description":"Field is optional when location_type is country. If querying for state, provide id of the country. If querying for city, provide id of the state."}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Locations"}}}}}}},"/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/app-provider/get-provider":{"get":{"description":"Using this API will return a list of application providers.","summary":"getAppProviders | Get app providers","tags":["Communication"],"parameters":[{"in":"path","name":"company_id","description":"Company id","required":true,"schema":{"type":"string","example":"13741"}},{"in":"path","name":"application_id","description":"Application id","required":true,"schema":{"type":"string","example":"637b6355dc65337da9b5c951"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppProvider"},"examples":{"default":{"$ref":"#/components/examples/AppProvider"}}}}}}}},"/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/app-provider/update-provider":{"post":{"description":"Using this API will update the application providers.","summary":"updateAppProviders | update app providers","tags":["Communication"],"parameters":[{"in":"path","name":"company_id","description":"Company id","required":true,"schema":{"type":"string","example":"13741"}},{"in":"path","name":"application_id","description":"Application id","required":true,"schema":{"type":"string","example":"637b6355dc65337da9b5c951"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppProviderReq"},"examples":{"default":{"$ref":"#/components/examples/AppProviderReq"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppProvider"},"examples":{"default":{"$ref":"#/components/examples/AppProvider"}}}}}}}},"/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/app-provider/global-providers":{"get":{"description":"Using this API, will retrieve a list of global providers.","summary":"getGlobalProviders | Get global providers","tags":["Communication"],"parameters":[{"in":"path","name":"company_id","description":"Company id","required":true,"schema":{"type":"string","example":"13741"}},{"in":"path","name":"application_id","description":"Application id","required":true,"schema":{"type":"string","example":"637b6355dc65337da9b5c951"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalProviders"},"examples":{"default":{"$ref":"#/components/examples/GlobalProviders"}}}}}}}},"/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/email/providers":{"get":{"description":"Get email providers","summary":"getEmailProviders | Get email providers","tags":["Communication"],"parameters":[{"in":"path","name":"company_id","description":"Company id","required":true,"schema":{"type":"string","example":"13741"}},{"in":"path","name":"application_id","description":"Application id","required":true,"schema":{"type":"string","example":"637b6355dc65337da9b5c951"}},{"in":"query","name":"page_no","description":"Current page no","required":false,"schema":{"type":"integer","minimum":1,"exclusiveMinimum":false,"example":1}},{"in":"query","name":"page_size","description":"Current request items count","required":false,"schema":{"type":"integer","example":10}},{"in":"query","name":"sort","description":"To sort based on created_at","required":false,"schema":{"type":"object","example":{"created_at":-1}}},{"in":"query","name":"query","description":"To search based on plain text","required":false,"schema":{"type":"object","example":{"$or":[{"name":{"$regex":"mk","$options":"i"}},{"tags":{"$regex":"mk","$options":"i"}}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailProviders"},"examples":{"default":{"$ref":"#/components/examples/EmailProviders"}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericError"},"examples":{"default":{"$ref":"#/components/examples/GenericError"}}}}}}},"post":{"description":"Create email provider","summary":"createEmailProvider | Create email provider","tags":["Communication"],"parameters":[{"in":"path","name":"company_id","description":"Company id","required":true,"schema":{"type":"string","example":"13741"}},{"in":"path","name":"application_id","description":"Application id","required":true,"schema":{"type":"string","example":"637b6355dc65337da9b5c951"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailProviderReq"},"examples":{"default":{"$ref":"#/components/examples/EmailProviderReq"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailProvider"},"examples":{"default":{"$ref":"#/components/examples/EmailProvider"}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericError"},"examples":{"default":{"$ref":"#/components/examples/GenericError"}}}}}}}},"/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/email/providers/{id}":{"get":{"description":"Get email provider by id","summary":"getEmailProviderById | Get email provider by id","tags":["Communication"],"parameters":[{"in":"path","name":"company_id","description":"Company id","required":true,"schema":{"type":"string","example":"13741"}},{"in":"path","name":"application_id","description":"Application id","required":true,"schema":{"type":"string","example":"637b6355dc65337da9b5c951"}},{"in":"path","name":"id","description":"Email provider id","required":true,"schema":{"type":"string","example":"5fd9fd44c474a7e3d5d376d6"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailProvider"},"examples":{"default":{"$ref":"#/components/examples/EmailProvider"}}}}},"404":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericError"},"examples":{"default":{"$ref":"#/components/examples/GenericError"}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericError"},"examples":{"default":{"$ref":"#/components/examples/GenericError"}}}}}}},"put":{"description":"Update email provider by id","summary":"updateEmailProviderById | Update email provider by id","tags":["Communication"],"parameters":[{"in":"path","name":"company_id","description":"Company id","required":true,"schema":{"type":"string","example":"13741"}},{"in":"path","name":"application_id","description":"Application id","required":true,"schema":{"type":"string","example":"637b6355dc65337da9b5c951"}},{"in":"path","name":"id","description":"Email provider id","required":true,"schema":{"type":"string","example":"5fd9fd44c474a7e3d5d376d6"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailProviderReq"},"examples":{"default":{"$ref":"#/components/examples/EmailProviderReq"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailProvider"},"examples":{"default":{"$ref":"#/components/examples/EmailProvider"}}}}},"404":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericError"},"examples":{"default":{"$ref":"#/components/examples/GenericError"}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericError"},"examples":{"default":{"$ref":"#/components/examples/GenericError"}}}}}}},"delete":{"description":"Delete email provider by id","summary":"deleteEmailProviderById | Delete email provider by id","tags":["Communication"],"parameters":[{"in":"path","name":"company_id","description":"Company id","required":true,"schema":{"type":"string","example":"13741"}},{"in":"path","name":"application_id","description":"Application id","required":true,"schema":{"type":"string","example":"637b6355dc65337da9b5c951"}},{"in":"path","name":"id","description":"Email provider id","required":true,"schema":{"type":"string","example":"5fd9fd44c474a7e3d5d376d6"}}],"responses":{"200":{"description":"Refer `GenericDelete` schema for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericDelete"},"examples":{"default":{"$ref":"#/components/examples/GenericDelete"}}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericError"},"examples":{"default":{"$ref":"#/components/examples/GenericError"}}}}},"404":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericError"},"examples":{"default":{"$ref":"#/components/examples/GenericError"}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericError"},"examples":{"default":{"$ref":"#/components/examples/GenericError"}}}}}}}},"/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sms/providers":{"get":{"description":"Get sms providers","summary":"getSmsProviders | Get sms providers","tags":["Communication"],"parameters":[{"in":"path","name":"company_id","description":"Company id","required":true,"schema":{"type":"string","example":"13741"}},{"in":"path","name":"application_id","description":"Application id","required":true,"schema":{"type":"string","example":"637b6355dc65337da9b5c951"}},{"in":"query","name":"page_no","description":"Current page no","required":false,"schema":{"type":"integer","minimum":1,"exclusiveMinimum":false,"example":1}},{"in":"query","name":"page_size","description":"Current request items count","required":false,"schema":{"type":"integer","example":10}},{"in":"query","name":"sort","description":"To sort based on created_at","required":false,"schema":{"type":"object","example":{"created_at":-1}}},{"in":"query","name":"query","description":"To search based on plain text","required":false,"schema":{"type":"object","example":{"$or":[{"name":{"$regex":"mk","$options":"i"}},{"tags":{"$regex":"mk","$options":"i"}}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{}},"examples":{"default":{"$ref":"#/components/examples/SmsProviders"}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericError"},"examples":{"default":{"$ref":"#/components/examples/GenericError"}}}}}}},"post":{"description":"Create sms provider","summary":"createSmsProvider | Create sms provider","tags":["Communication"],"parameters":[{"in":"path","name":"company_id","description":"Company id","required":true,"schema":{"type":"string","example":"13741"}},{"in":"path","name":"application_id","description":"Application id","required":true,"schema":{"type":"string","example":"637b6355dc65337da9b5c951"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmsProviderReq"},"examples":{"default":{"$ref":"#/components/examples/SmsProviderReq"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{}},"examples":{"default":{"$ref":"#/components/examples/SmsProvider"}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericError"},"examples":{"default":{"$ref":"#/components/examples/GenericError"}}}}}}}},"/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sms/default-providers":{"get":{"description":"Get default sms providers","summary":"getDefaultSmsProviders | Get default sms providers","tags":["Communication"],"parameters":[{"in":"path","name":"company_id","description":"Company id","required":true,"schema":{"type":"string","example":"13741"}},{"in":"path","name":"application_id","description":"Application id","required":true,"schema":{"type":"string","example":"637b6355dc65337da9b5c951"}}],"responses":{"200":{"description":"Successful retrieval of the default SMS providers list","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DefaultSmsProviders"}},"examples":{"default":{"$ref":"#/components/examples/DefaultSmsProviders"}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericError"},"examples":{"default":{"$ref":"#/components/examples/GenericError"}}}}}}}},"/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sms/providers/{id}":{"get":{"description":"Get sms provider by id","summary":"getSmsProviderById | Get sms provider by id","tags":["Communication"],"parameters":[{"in":"path","name":"company_id","description":"Company id","required":true,"schema":{"type":"string","example":"13741"}},{"in":"path","name":"application_id","description":"Application id","required":true,"schema":{"type":"string","example":"637b6355dc65337da9b5c951"}},{"in":"path","name":"id","description":"Sms provider id","required":true,"schema":{"type":"string","example":"5fd9fd07c474a7710dd376d5"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{}},"examples":{"default":{"$ref":"#/components/examples/SmsProvider"}}}}},"404":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericError"},"examples":{"default":{"$ref":"#/components/examples/GenericError"}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericError"},"examples":{"default":{"$ref":"#/components/examples/GenericError"}}}}}}},"put":{"description":"Update sms provider by id","summary":"updateSmsProviderById | Update sms provider by id","tags":["Communication"],"parameters":[{"in":"path","name":"company_id","description":"Company id","required":true,"schema":{"type":"string","example":"13741"}},{"in":"path","name":"application_id","description":"Application id","required":true,"schema":{"type":"string","example":"637b6355dc65337da9b5c951"}},{"in":"path","name":"id","description":"Sms provider id","required":true,"schema":{"type":"string","example":"5fd9fd07c474a7710dd376d5"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmsProviderReq"},"examples":{"default":{"$ref":"#/components/examples/SmsProviderReq"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{}},"examples":{"default":{"$ref":"#/components/examples/SmsProvider"}}}}},"404":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericError"},"examples":{"default":{"$ref":"#/components/examples/GenericError"}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericError"},"examples":{"default":{"$ref":"#/components/examples/GenericError"}}}}}}},"delete":{"description":"Delete sms provider by id","summary":"deleteSmsProviderById | Delete sms provider by id","tags":["Communication"],"parameters":[{"in":"path","name":"company_id","description":"Company id","required":true,"schema":{"type":"string","example":"13741"}},{"in":"path","name":"application_id","description":"Application id","required":true,"schema":{"type":"string","example":"637b6355dc65337da9b5c951"}},{"in":"path","name":"id","description":"Sms provider id","required":true,"schema":{"type":"string","example":"5fd9fd07c474a7710dd376d5"}}],"responses":{"200":{"description":"Refer `GenericDelete` schema for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericDelete"},"examples":{"default":{"$ref":"#/components/examples/GenericDelete"}}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericError"},"examples":{"default":{"$ref":"#/components/examples/GenericError"}}}}},"404":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericError"},"examples":{"default":{"$ref":"#/components/examples/GenericError"}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericError"},"examples":{"default":{"$ref":"#/components/examples/GenericError"}}}}}}}},"/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/campaigns/campaigns":{"get":{"description":"Get campaigns","summary":"getCampaigns | Get campaigns","tags":["Communication"],"parameters":[{"in":"path","name":"company_id","description":"Company id","required":true,"schema":{"type":"string","example":"13741"}},{"in":"path","name":"application_id","description":"Application id","required":true,"schema":{"type":"string","example":"637b6355dc65337da9b5c951"}},{"in":"query","name":"query","description":"To search based on plain text","required":false,"schema":{"type":"object","example":{"$or":[{"name":{"$regex":"mk","$options":"i"}},{"tags":{"$regex":"mk","$options":"i"}}]}}},{"name":"page_no","in":"query","schema":{"type":"integer"},"description":"Current page no"},{"name":"page_size","in":"query","schema":{"type":"integer"},"description":"Current request items count"},{"name":"sort","in":"query","schema":{"type":"object","properties":{"created_at":{"type":"integer"}}},"description":"To sort based on created_at"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Campaigns"},"examples":{"default":{"$ref":"#/components/examples/Campaigns"}}}}}}},"post":{"description":"Create campaign","summary":"createCampaign | Create campaign","tags":["Communication"],"parameters":[{"in":"path","name":"company_id","description":"Company id","required":true,"schema":{"type":"string","example":"13741"}},{"in":"path","name":"application_id","description":"Application id","required":true,"schema":{"type":"string","example":"637b6355dc65337da9b5c951"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignReq"},"examples":{"default":{"$ref":"#/components/examples/CampaignReq"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Campaign"},"examples":{"default":{"$ref":"#/components/examples/Campaign"}}}}}}}},"/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/campaigns/campaigns/{id}":{"get":{"description":"Get campaign by id","summary":"getCampaignById | Get campaign by id","tags":["Communication"],"parameters":[{"in":"path","name":"company_id","description":"Company id","required":true,"schema":{"type":"string","example":"13741"}},{"in":"path","name":"application_id","description":"Application id","required":true,"schema":{"type":"string","example":"637b6355dc65337da9b5c951"}},{"in":"path","name":"id","description":"Campaign id","required":true,"schema":{"type":"string","example":"6009a1ea1f6a61d88e80a867"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Campaign"},"examples":{"default":{"$ref":"#/components/examples/Campaign"}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"Not found"}}}}}},"put":{"description":"Update campaign by id","summary":"updateCampaignById | Update campaign by id","tags":["Communication"],"parameters":[{"in":"path","name":"company_id","description":"Company id","required":true,"schema":{"type":"string","example":"13741"}},{"in":"path","name":"application_id","description":"Application id","required":true,"schema":{"type":"string","example":"637b6355dc65337da9b5c951"}},{"in":"path","name":"id","description":"Campaign id","required":true,"schema":{"type":"string","example":"6009a1ea1f6a61d88e80a867"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignReq"},"examples":{"default":{"$ref":"#/components/examples/CampaignReq"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Campaign"},"examples":{"default":{"$ref":"#/components/examples/Campaign"}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"Not found"}}}}}}},"/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/campaigns/get-stats/{id}":{"get":{"description":"Get stats of campaign by id","summary":"getStatsOfCampaignById | Get stats of campaign by id","tags":["Communication"],"parameters":[{"in":"path","name":"company_id","description":"Company id","required":true,"schema":{"type":"string","example":"13741"}},{"in":"path","name":"application_id","description":"Application id","required":true,"schema":{"type":"string","example":"637b6355dc65337da9b5c951"}},{"in":"path","name":"id","description":"Campaign id","required":true,"schema":{"type":"string","example":"6009a1ea1f6a61d88e80a867"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetStats"},"examples":{"default":{"$ref":"#/components/examples/GetStats"}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestSchema"},"example":{"message":"campaign id not provided"}}}}}}},"/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sources/bigquery-row-count/{id}":{"get":{"description":"Get big query row count by id","summary":"getBigQueryRowCountById | Get big query row count by id","deprecated":true,"tags":["Communication"],"parameters":[{"in":"path","name":"company_id","description":"Company id","required":true,"schema":{"type":"string","example":"13741"}},{"in":"path","name":"application_id","description":"Application id","required":true,"schema":{"type":"string","example":"637b6355dc65337da9b5c951"}},{"in":"path","name":"id","description":"Audience id","required":true,"schema":{"type":"string","example":"5fb6675c09fd901023917a5f"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"default":{"value":{}}}}}}}}},"/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sources/bigquery-row-count":{"post":{"description":"Create big query row count","summary":"createBigQueryRowCount | Create big query row count","deprecated":true,"tags":["Communication"],"parameters":[{"in":"path","name":"company_id","description":"Company id","required":true,"schema":{"type":"string","example":"13741"}},{"in":"path","name":"application_id","description":"Application id","required":true,"schema":{"type":"string","example":"637b6355dc65337da9b5c951"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"default":{"value":{}}}}}}}}},"/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sources/bigquery-headers/{id}":{"get":{"description":"Get big query headers by id","summary":"getBigQueryHeadersById | Get big query headers by id","deprecated":true,"tags":["Communication"],"parameters":[{"in":"path","name":"company_id","description":"Company id","required":true,"schema":{"type":"string","example":"13741"}},{"in":"path","name":"application_id","description":"Application id","required":true,"schema":{"type":"string","example":"637b6355dc65337da9b5c951"}},{"in":"path","name":"id","description":"Audience id","required":true,"schema":{"type":"string","example":"5fb6675c09fd901023917a5f"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"default":{"value":{}}}}}}}}},"/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sources/bigquery-n-records":{"post":{"description":"Create big query n count","summary":"createBigQueryNCount | Create big query n count","deprecated":true,"tags":["Communication"],"parameters":[{"in":"path","name":"company_id","description":"Company id","required":true,"schema":{"type":"string","example":"13741"}},{"in":"path","name":"application_id","description":"Application id","required":true,"schema":{"type":"string","example":"637b6355dc65337da9b5c951"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"default":{"value":{}}}}}}}}},"/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sources/bigquery-headers":{"post":{"description":"Create big query headers","summary":"createBigQueryHeaders | Create big query headers","deprecated":true,"tags":["Communication"],"parameters":[{"in":"path","name":"company_id","description":"Company id","required":true,"schema":{"type":"string","example":"13741"}},{"in":"path","name":"application_id","description":"Application id","required":true,"schema":{"type":"string","example":"637b6355dc65337da9b5c951"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"default":{"value":{}}}}}}}}},"/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sources/system-datasources":{"get":{"description":"Get system audiences","summary":"getSystemAudiences | Get system audiences","deprecated":true,"tags":["Communication"],"parameters":[{"in":"path","name":"company_id","description":"Company id","required":true,"schema":{"type":"string","example":"13741"}},{"in":"path","name":"application_id","description":"Application id","required":true,"schema":{"type":"string","example":"637b6355dc65337da9b5c951"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"default":{"value":{}}}}}}}}},"/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sources/datasources":{"get":{"description":"Audience is used to import CSV files containing emails, phone numbers, and other variables in order to populate email/SMS templates for bulk delivery via a Campaign. Use this API to get audiences.","summary":"getAudiences | Get audiences","tags":["Communication"],"parameters":[{"in":"path","name":"company_id","description":"Company id","required":true,"schema":{"type":"string","example":"13741"}},{"in":"path","name":"application_id","description":"Application id","required":true,"schema":{"type":"string","example":"637b6355dc65337da9b5c951"}},{"in":"query","name":"page_no","description":"Current page no","required":false,"schema":{"type":"integer","minimum":1,"exclusiveMinimum":false,"example":1}},{"in":"query","name":"page_size","description":"Current request items count","required":false,"schema":{"type":"integer","example":10}},{"in":"query","name":"sort","description":"To sort based on created_at","required":false,"schema":{"type":"object","example":{"created_at":-1}}},{"in":"query","name":"query","description":"To search based on plain text","required":false,"schema":{"type":"object","example":{"$or":[{"name":{"$regex":"mk","$options":"i"}},{"tags":{"$regex":"mk","$options":"i"}}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Audiences"},"examples":{"default":{"$ref":"#/components/examples/Audiences"}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericError"},"examples":{"default":{"$ref":"#/components/examples/GenericError"}}}}}}},"post":{"description":"Audience is used to import CSV files containing emails, phone numbers, and other variables in order to populate email/SMS templates for bulk delivery via a Campaign. Use this API to create audience.","summary":"createAudience | Create audience","tags":["Communication"],"parameters":[{"in":"path","name":"company_id","description":"Company id","required":true,"schema":{"type":"string","example":"13741"}},{"in":"path","name":"application_id","description":"Application id","required":true,"schema":{"type":"string","example":"637b6355dc65337da9b5c951"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AudienceReq"},"examples":{"default":{"$ref":"#/components/examples/AudienceReq"}}}}},"responses":{"200":{"description":"Refer `Audience` schema for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Audience"},"examples":{"default":{"$ref":"#/components/examples/Audience"}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericError"},"examples":{"default":{"$ref":"#/components/examples/GenericError"}}}}}}}},"/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sources/datasources/{id}":{"get":{"description":"Audience is used to import CSV files containing emails, phone numbers, and other variables in order to populate email/SMS templates for bulk delivery via a Campaign. Use this API to get audiences by Id.","summary":"getAudienceById | Get audience by id","tags":["Communication"],"parameters":[{"in":"path","name":"company_id","description":"Company id","required":true,"schema":{"type":"string","example":"13741"}},{"in":"path","name":"application_id","description":"Application id","required":true,"schema":{"type":"string","example":"637b6355dc65337da9b5c951"}},{"in":"path","name":"id","description":"Audience id","required":true,"schema":{"type":"string","example":"5fb6675c09fd901023917a5f"}}],"responses":{"200":{"description":"Refer `Audience` schema for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Audience"},"examples":{"default":{"$ref":"#/components/examples/Audience"}}}}},"404":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericError"},"examples":{"default":{"$ref":"#/components/examples/GenericError"}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericError"},"examples":{"default":{"$ref":"#/components/examples/GenericError"}}}}}}},"put":{"description":"Audience is used to import CSV files containing emails, phone numbers, and other variables in order to populate email/SMS templates for bulk delivery via a Campaign. Use this API to update audience by id.","summary":"updateAudienceById | Update audience by id","tags":["Communication"],"parameters":[{"in":"path","name":"company_id","description":"Company id","required":true,"schema":{"type":"string","example":"13741"}},{"in":"path","name":"application_id","description":"Application id","required":true,"schema":{"type":"string","example":"637b6355dc65337da9b5c951"}},{"in":"path","name":"id","description":"Audience id","required":true,"schema":{"type":"string","example":"5fb6675c09fd901023917a5f"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AudienceReq"},"examples":{"default":{"$ref":"#/components/examples/AudienceReq"}}}}},"responses":{"200":{"description":"Refer `Audience` schema for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Audience"},"examples":{"default":{"$ref":"#/components/examples/Audience"}}}}},"404":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericError"},"examples":{"default":{"$ref":"#/components/examples/GenericError"}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericError"},"examples":{"default":{"$ref":"#/components/examples/GenericError"}}}}}}},"delete":{"description":"Audience is used to import CSV files containing emails, phone numbers, and other variables in order to populate email/SMS templates for bulk delivery via a Campaign. Use this API to delete audience by id.","summary":"deleteAudienceById | Delete audience by id","tags":["Communication"],"parameters":[{"in":"path","name":"company_id","description":"Company id","required":true,"schema":{"type":"string","example":"13741"}},{"in":"path","name":"application_id","description":"Application id","required":true,"schema":{"type":"string","example":"637b6355dc65337da9b5c951"}},{"in":"path","name":"id","description":"Audience id","required":true,"schema":{"type":"string","example":"5fb6675c09fd901023917a5f"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AudienceReq"},"examples":{"default":{"$ref":"#/components/examples/AudienceReq"}}}}},"responses":{"200":{"description":"Refer `Audience` schema for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Audience"},"examples":{"default":{"$ref":"#/components/examples/Audience"}}}}},"404":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericError"},"examples":{"default":{"$ref":"#/components/examples/GenericError"}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericError"},"examples":{"default":{"$ref":"#/components/examples/GenericError"}}}}}}}},"/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sources/datasources/dummy-data-sources":{"get":{"description":"Audience is used to import CSV files containing emails, phone numbers, and other variables in order to populate email/SMS templates for bulk delivery via a Campaign. Use this API to get dummy data sources.","summary":"getDummyDatasources | Get dummy data sources","tags":["Communication"],"parameters":[{"in":"path","name":"company_id","description":"Company id","required":true,"schema":{"type":"string","example":"13741"}},{"in":"path","name":"application_id","description":"Application id","required":true,"schema":{"type":"string","example":"637b6355dc65337da9b5c951"}}],"responses":{"200":{"description":"Refer `DummyDatasources` schema for more details.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DummyDatasources"}},"examples":{"default":{"$ref":"#/components/examples/DummyDatasources"}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericError"},"examples":{"default":{"$ref":"#/components/examples/GenericError"}}}}}}}},"/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sources/datasources/dummy-data-sources-meta/{id}":{"get":{"description":"Audience is used to import CSV files containing emails, phone numbers, and other variables in order to populate email/SMS templates for bulk delivery via a Campaign. Use this API to get dummy data sources meta.","summary":"getDummyDatasourcesMeta | Get dummy data sources meta","tags":["Communication"],"parameters":[{"in":"path","name":"company_id","description":"Company id","required":true,"schema":{"type":"string","example":"13741"}},{"in":"path","name":"application_id","description":"Application id","required":true,"schema":{"type":"string","example":"637b6355dc65337da9b5c951"}},{"in":"path","name":"id","description":"Dummy datasources meta ID","required":true,"schema":{"type":"integer","format":"int32","example":2}}],"responses":{"200":{"description":"Refer `DummyDatasourcesMeta` schema for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DummyDatasourcesMeta"},"examples":{"default":{"$ref":"#/components/examples/DummyDatasourcesMeta"}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericError"},"examples":{"default":{"$ref":"#/components/examples/GenericError"}}}}}}}},"/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sources/get-n-records":{"get":{"description":"Audience is used to import CSV files containing emails, phone numbers, and other variables in order to populate email/SMS templates for bulk delivery via a Campaign. Use this API to get n sample records from csv.","summary":"getNSampleRecordsFromCsvByGet | Get n sample records from csv","tags":["Communication"],"parameters":[{"in":"path","name":"company_id","description":"Company id","required":true,"schema":{"type":"string","example":"13741"}},{"in":"path","name":"application_id","description":"Application id","required":true,"schema":{"type":"string","example":"637b6355dc65337da9b5c951"}}],"responses":{"200":{"description":"Refer `GetNRecordsCsvRes` schema for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetNRecordsCsvRes"},"examples":{"default":{"$ref":"#/components/examples/GetNRecordsCsvRes"}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericError"},"examples":{"default":{"$ref":"#/components/examples/GenericError"}}}}}}},"post":{"description":"Audience is used to import CSV files containing emails, phone numbers, and other variables in order to populate email/SMS templates for bulk delivery via a Campaign. Use this API to get n sample records from csv","summary":"getNSampleRecordsFromCsv | Get n sample records from csv","tags":["Communication"],"parameters":[{"in":"path","name":"company_id","description":"Company id","required":true,"schema":{"type":"string","example":"13741"}},{"in":"path","name":"application_id","description":"Application id","required":true,"schema":{"type":"string","example":"637b6355dc65337da9b5c951"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetNRecordsCsvReq"},"examples":{"default":{"$ref":"#/components/examples/GetNRecordsCsvReq"}}}}},"responses":{"200":{"description":"Refer `GetNRecordsCsvRes` schema for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetNRecordsCsvRes"},"examples":{"default":{"$ref":"#/components/examples/GetNRecordsCsvRes"}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericError"},"examples":{"default":{"$ref":"#/components/examples/GenericError"}}}}}}}},"/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/email/templates":{"get":{"description":"Email templates are predefined formats linked to various events for delivering messages to users. Use this API to get all email templates.","summary":"getEmailTemplates | Get email templates","tags":["Communication"],"parameters":[{"in":"path","name":"company_id","description":"Company id","required":true,"schema":{"type":"string","example":"13741"}},{"in":"path","name":"application_id","description":"Application id","required":true,"schema":{"type":"string","example":"637b6355dc65337da9b5c951"}},{"in":"query","name":"page_no","description":"Current page no","required":false,"schema":{"type":"integer","minimum":1,"exclusiveMinimum":false,"example":1}},{"in":"query","name":"page_size","description":"Current request items count","required":false,"schema":{"type":"integer","example":10}},{"in":"query","name":"sort","description":"To sort based on created_at","required":false,"schema":{"type":"object","example":{"created_at":-1}}},{"in":"query","name":"query","description":"To search based on plain text","required":false,"schema":{"type":"object","example":{"$or":[{"name":{"$regex":"mk","$options":"i"}},{"tags":{"$regex":"mk","$options":"i"}}]}}}],"responses":{"200":{"description":"Refer `EmailTemplates` schema for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailTemplates"},"examples":{"default":{"$ref":"#/components/examples/EmailTemplates"}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericError"},"examples":{"default":{"$ref":"#/components/examples/GenericError"}}}}}}},"post":{"description":"Email templates are predefined formats linked to various events for delivering messages to users. Use this API to create an email template.","summary":"createEmailTemplate | Create email template","tags":["Communication"],"parameters":[{"in":"path","name":"company_id","description":"Company id","required":true,"schema":{"type":"string","example":"13741"}},{"in":"path","name":"application_id","description":"Application id","required":true,"schema":{"type":"string","example":"637b6355dc65337da9b5c951"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailTemplateReq"},"examples":{"default":{"$ref":"#/components/examples/EmailTemplateReq"}}}}},"responses":{"200":{"description":"Refer `EmailTemplate` schema for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailTemplate"},"examples":{"default":{"$ref":"#/components/examples/EmailTemplate"}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericError"},"examples":{"default":{"$ref":"#/components/examples/GenericError"}}}}}}}},"/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/email/system-templates":{"get":{"description":"Email templates are predefined formats linked to various events for delivering messages to users. Use this API to get all system email templates.","summary":"getSystemEmailTemplates | Get system email templates","tags":["Communication"],"parameters":[{"in":"path","name":"company_id","description":"Company id","required":true,"schema":{"type":"string","example":"13741"}},{"in":"path","name":"application_id","description":"Application id","required":true,"schema":{"type":"string","example":"637b6355dc65337da9b5c951"}}],"responses":{"200":{"description":"Refer `SystemEmailTemplates` schema for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SystemEmailTemplates"},"examples":{"default":{"$ref":"#/components/examples/SystemEmailTemplates"}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericError"},"examples":{"default":{"$ref":"#/components/examples/GenericError"}}}}}}}},"/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/email/templates/{id}":{"get":{"description":"Email templates are predefined formats linked to various events for delivering messages to users. Use this API to get an email template by id.","summary":"getEmailTemplateById | Get email template by id","tags":["Communication"],"parameters":[{"in":"path","name":"company_id","description":"Company id","required":true,"schema":{"type":"string","example":"13741"}},{"in":"path","name":"application_id","description":"Application id","required":true,"schema":{"type":"string","example":"637b6355dc65337da9b5c951"}},{"in":"path","name":"id","description":"Email template id","required":true,"schema":{"type":"string","example":"5ef42a49c8b67d279c27a980"}}],"responses":{"200":{"description":"Refer `EmailTemplate` schema for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailTemplate"},"examples":{"default":{"$ref":"#/components/examples/EmailTemplate"}}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericError"},"examples":{"default":{"$ref":"#/components/examples/GenericError"}}}}},"404":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericError"},"examples":{"default":{"$ref":"#/components/examples/GenericError"}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericError"},"examples":{"default":{"$ref":"#/components/examples/GenericError"}}}}}}},"put":{"description":"Email templates are predefined formats linked to various events for delivering messages to users. Use this API to update an email template by id.","summary":"updateEmailTemplateById | Update email template by id","tags":["Communication"],"parameters":[{"in":"path","name":"company_id","description":"Company id","required":true,"schema":{"type":"string","example":"13741"}},{"in":"path","name":"application_id","description":"Application id","required":true,"schema":{"type":"string","example":"637b6355dc65337da9b5c951"}},{"in":"path","name":"id","description":"Email template id","required":true,"schema":{"type":"string","example":"5ef42a49c8b67d279c27a980"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailTemplateReq"},"examples":{"default":{"$ref":"#/components/examples/EmailTemplateReq"}}}}},"responses":{"200":{"description":"Refer `EmailTemplate` schema for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailTemplate"},"examples":{"default":{"$ref":"#/components/examples/EmailTemplate"}}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericError"},"examples":{"default":{"$ref":"#/components/examples/GenericError"}}}}},"404":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericError"},"examples":{"default":{"$ref":"#/components/examples/GenericError"}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericError"},"examples":{"default":{"$ref":"#/components/examples/GenericError"}}}}}}},"delete":{"description":"Email templates are predefined formats linked to various events for delivering messages to users. Use this API to delete an email template by id.","summary":"deleteEmailTemplateById | Delete email template by id","tags":["Communication"],"parameters":[{"in":"path","name":"company_id","description":"Company id","required":true,"schema":{"type":"string","example":"13741"}},{"in":"path","name":"application_id","description":"Application id","required":true,"schema":{"type":"string","example":"637b6355dc65337da9b5c951"}},{"in":"path","name":"id","description":"Email template id","required":true,"schema":{"type":"string","example":"5ef42a49c8b67d279c27a980"}}],"responses":{"200":{"description":"Refer `GenericDelete` schema for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericDelete"},"examples":{"default":{"$ref":"#/components/examples/GenericDelete"}}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericError"},"examples":{"default":{"$ref":"#/components/examples/GenericError"}}}}},"404":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericError"},"examples":{"default":{"$ref":"#/components/examples/GenericError"}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericError"},"examples":{"default":{"$ref":"#/components/examples/GenericError"}}}}}}}},"/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/email/subscribedTemplates":{"get":{"description":"Email templates are predefined formats linked to various events for delivering messages to users. Use this API to get all subscribed email templates.","summary":"getSubscribedEmailTemplates | Get subscribed email templates","tags":["Communication"],"parameters":[{"in":"path","name":"company_id","description":"Company id","required":true,"schema":{"type":"string","example":"13741"}},{"in":"path","name":"application_id","description":"Application id","required":true,"schema":{"type":"string","example":"637b6355dc65337da9b5c951"}},{"in":"query","name":"page_no","description":"Current page no","required":false,"schema":{"type":"integer","minimum":1,"exclusiveMinimum":false,"example":1}},{"in":"query","name":"page_size","description":"Current request items count","required":false,"schema":{"type":"integer","example":10}},{"in":"query","name":"query","description":"To search based on plain text","required":false,"schema":{"type":"object","example":{"$or":[{"name":{"$regex":"mk","$options":"i"}},{"tags":{"$regex":"mk","$options":"i"}}]}}}],"responses":{"200":{"description":"Refer `EmailTemplates` schema for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailTemplates"},"examples":{"default":{"$ref":"#/components/examples/EmailTemplates"}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericError"},"examples":{"default":{"$ref":"#/components/examples/GenericError"}}}}}}}},"/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sms/templates":{"get":{"description":"SMS templates are predefined message formats linked to various events for delivering messages to users. Use this API to get all sms templates.","summary":"getSmsTemplates | Get sms templates","tags":["Communication"],"parameters":[{"in":"path","name":"company_id","description":"Company id","required":true,"schema":{"type":"string","example":"13741"}},{"in":"path","name":"application_id","description":"Application id","required":true,"schema":{"type":"string","example":"637b6355dc65337da9b5c951"}},{"in":"query","name":"page_no","description":"Current page no","required":false,"schema":{"type":"integer","minimum":1,"exclusiveMinimum":false,"example":1}},{"in":"query","name":"page_size","description":"Current request items count","required":false,"schema":{"type":"integer","example":10}},{"in":"query","name":"sort","description":"To sort based on created_at","required":false,"schema":{"type":"object","example":{"created_at":-1}}},{"in":"query","name":"query","description":"To search based on plain text","required":false,"schema":{"type":"object","example":{"$or":[{"name":{"$regex":"mk","$options":"i"}},{"tags":{"$regex":"mk","$options":"i"}}]}}}],"responses":{"200":{"description":"Refer `SmsTemplates` schema for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmsTemplates"},"examples":{"default":{"$ref":"#/components/examples/SmsTemplates"}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericError"},"examples":{"default":{"$ref":"#/components/examples/GenericError"}}}}}}},"post":{"description":"SMS templates are predefined message formats linked to various events for delivering messages to users. Use this API to create an sms template.","summary":"createSmsTemplate | Create sms template","tags":["Communication"],"parameters":[{"in":"path","name":"company_id","description":"Company id","required":true,"schema":{"type":"string","example":"13741"}},{"in":"path","name":"application_id","description":"Application id","required":true,"schema":{"type":"string","example":"637b6355dc65337da9b5c951"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmsTemplateReq"},"examples":{"default":{"$ref":"#/components/examples/SmsTemplateReq"}}}}},"responses":{"200":{"description":"Refer `SmsTemplate` schema for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmsTemplate"},"examples":{"default":{"$ref":"#/components/examples/SmsTemplate"}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericError"},"examples":{"default":{"$ref":"#/components/examples/GenericError"}}}}}}}},"/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sms/system-templates":{"get":{"description":"SMS templates are predefined message formats linked to various events for delivering messages to users. Use this API to get all system sms templates.","summary":"getSystemSmsTemplates | Get system sms templates","tags":["Communication"],"parameters":[{"in":"path","name":"company_id","description":"Company id","required":true,"schema":{"type":"string","example":"13741"}},{"in":"path","name":"application_id","description":"Application id","required":true,"schema":{"type":"string","example":"637b6355dc65337da9b5c951"}}],"responses":{"200":{"description":"Refer `SystemSmsTemplates` schema for more details.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SystemSmsTemplates"}},"examples":{"default":{"$ref":"#/components/examples/SystemSmsTemplates"}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericError"},"examples":{"default":{"$ref":"#/components/examples/GenericError"}}}}}}}},"/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sms/templates/{id}":{"get":{"description":"SMS templates are predefined message formats linked to various events for delivering messages to users. Use this API to get an sms template by ID.","summary":"getSmsTemplateById | Get sms template by id","tags":["Communication"],"parameters":[{"in":"path","name":"company_id","description":"Company id","required":true,"schema":{"type":"string","example":"13741"}},{"in":"path","name":"application_id","description":"Application id","required":true,"schema":{"type":"string","example":"637b6355dc65337da9b5c951"}},{"in":"path","name":"id","description":"Sms template id","required":true,"schema":{"type":"string","example":"5ef42a49c8b67d279c27a980"}}],"responses":{"200":{"description":"Refer `SmsTemplate` schema for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmsTemplate"},"examples":{"default":{"$ref":"#/components/examples/SmsTemplate"}}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericError"},"examples":{"default":{"$ref":"#/components/examples/GenericError"}}}}},"404":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericError"},"examples":{"default":{"$ref":"#/components/examples/GenericError"}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericError"},"examples":{"default":{"$ref":"#/components/examples/GenericError"}}}}}}},"put":{"description":"SMS templates are predefined message formats linked to various events for delivering messages to users. Use this API to update an sms template by ID.","summary":"updateSmsTemplateById | Update sms template by id","tags":["Communication"],"parameters":[{"in":"path","name":"company_id","description":"Company id","required":true,"schema":{"type":"string","example":"13741"}},{"in":"path","name":"application_id","description":"Application id","required":true,"schema":{"type":"string","example":"637b6355dc65337da9b5c951"}},{"in":"path","name":"id","description":"Sms template id","required":true,"schema":{"type":"string","example":"5ef42a49c8b67d279c27a980"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmsTemplateReq"},"examples":{"default":{"$ref":"#/components/examples/SmsTemplateReq"}}}}},"responses":{"200":{"description":"Refer `SmsTemplate` schema for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmsTemplate"},"examples":{"default":{"$ref":"#/components/examples/SmsTemplate"}}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericError"},"examples":{"default":{"$ref":"#/components/examples/GenericError"}}}}},"404":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericError"},"examples":{"default":{"$ref":"#/components/examples/GenericError"}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericError"},"examples":{"default":{"$ref":"#/components/examples/GenericError"}}}}}}},"delete":{"description":"SMS templates are predefined message formats linked to various events for delivering messages to users. Use this API to delete an sms template by ID.","summary":"deleteSmsTemplateById | Delete sms template by id","tags":["Communication"],"parameters":[{"in":"path","name":"company_id","description":"Company id","required":true,"schema":{"type":"string","example":"13741"}},{"in":"path","name":"application_id","description":"Application id","required":true,"schema":{"type":"string","example":"637b6355dc65337da9b5c951"}},{"in":"path","name":"id","description":"Sms template id","required":true,"schema":{"type":"string","example":"5ef42a49c8b67d279c27a980"}}],"responses":{"200":{"description":"Refer `GenericDelete` schema for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericDelete"},"examples":{"default":{"$ref":"#/components/examples/GenericDelete"}}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericError"},"examples":{"default":{"$ref":"#/components/examples/GenericError"}}}}},"404":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericError"},"examples":{"default":{"$ref":"#/components/examples/GenericError"}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericError"},"examples":{"default":{"$ref":"#/components/examples/GenericError"}}}}}}}},"/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sms/subscribedTemplates":{"get":{"description":"SMS templates are predefined message formats linked to various events for delivering messages to users. Use this API to get all subscribed sms templates.","summary":"getSubscribedSmsTemplates | Get subscribed sms templates","tags":["Communication"],"parameters":[{"in":"path","name":"company_id","description":"Company id","required":true,"schema":{"type":"string","example":"13741"}},{"in":"path","name":"application_id","description":"Application id","required":true,"schema":{"type":"string","example":"637b6355dc65337da9b5c951"}},{"in":"query","name":"page_no","description":"Current page no","required":false,"schema":{"type":"integer","minimum":1,"exclusiveMinimum":false,"example":1}},{"in":"query","name":"page_size","description":"Current request items count","required":false,"schema":{"type":"integer","example":10}},{"in":"query","name":"query","description":"To search based on plain text","required":false,"schema":{"type":"object","example":{"$or":[{"name":{"$regex":"mk","$options":"i"}},{"tags":{"$regex":"mk","$options":"i"}}]}}}],"responses":{"200":{"description":"Refer `SmsTemplates` schema for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmsTemplates"},"examples":{"default":{"$ref":"#/components/examples/SmsTemplates"}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericError"},"examples":{"default":{"$ref":"#/components/examples/GenericError"}}}}}}}},"/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/engine/send-instant":{"post":{"description":"Send email or sms synchronously","summary":"sendCommunicationSynchronously | Send email or sms synchronously","tags":["Communication"],"parameters":[{"in":"path","name":"company_id","description":"Company id","required":true,"schema":{"type":"string","example":"13741"}},{"in":"path","name":"application_id","description":"Application id","required":true,"schema":{"type":"string","example":"637b6355dc65337da9b5c951"}}],"requestBody":{"required":true,"description":"Pass the api payload as shown below.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EngineRequest"},"examples":{"default":{"$ref":"#/components/examples/EngineRequest"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EngineResponse"},"examples":{"default":{"$ref":"#/components/examples/EngineResponse"}}}}}}}},"/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/engine/send-async":{"post":{"description":"Send email or sms asynchronously","summary":"sendCommunicationAsynchronously | Send email or sms asynchronously","tags":["Communication"],"parameters":[{"in":"path","name":"company_id","description":"Company id","required":true,"schema":{"type":"string","example":"13741"}},{"in":"path","name":"application_id","description":"Application id","required":true,"schema":{"type":"string","example":"637b6355dc65337da9b5c951"}}],"requestBody":{"required":true,"description":"Pass the api payload as shown below.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EngineRequest"},"examples":{"default":{"$ref":"#/components/examples/EngineRequest"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EngineResponse"},"examples":{"default":{"$ref":"#/components/examples/EngineResponse"}}}}}}}},"/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/event/event-subscriptions":{"get":{"description":"Get event subscriptions","summary":"getEventSubscriptions | Get event subscriptions","tags":["Communication"],"parameters":[{"in":"path","name":"company_id","description":"Company id","required":true,"schema":{"type":"string","example":"13741"}},{"in":"path","name":"application_id","description":"Application id","required":true,"schema":{"type":"string","example":"637b6355dc65337da9b5c951"}},{"in":"query","name":"page_no","description":"Current page no","required":false,"schema":{"type":"integer","minimum":1,"exclusiveMinimum":false,"example":1}},{"in":"query","name":"page_size","description":"Current request items count","required":false,"schema":{"type":"integer","example":10}},{"in":"query","name":"populate","description":"Populate Fields","required":false,"schema":{"type":"string","example":"template.sms.template"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventSubscriptions"},"examples":{"default":{"$ref":"#/components/examples/EventSubscriptions"}}}}},"404":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericError"},"examples":{"default":{"$ref":"#/components/examples/GenericError"}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericError"},"examples":{"default":{"$ref":"#/components/examples/GenericError"}}}}}}},"post":{"description":"Create event subscriptions","summary":"createEventSubscriptions | Create event subscriptions","tags":["Communication"],"parameters":[{"in":"path","name":"company_id","description":"Company id","required":true,"schema":{"type":"string","example":"13741"}},{"in":"path","name":"application_id","description":"Application id","required":true,"schema":{"type":"string","example":"637b6355dc65337da9b5c951"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionsObject"},"examples":{"default":{"$ref":"#/components/examples/SubscriptionsObject"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventSubscriptionsBulkUpdateResponse"},"examples":{"default":{"$ref":"#/components/examples/EventSubscriptionsBulkUpdateResponse"}}}}},"404":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericError"},"examples":{"default":{"$ref":"#/components/examples/GenericError"}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericError"},"examples":{"default":{"$ref":"#/components/examples/GenericError"}}}}}}}},"/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/event/event-subscriptions/{id}":{"get":{"description":"Get event subscriptions by id","summary":"getEventSubscriptionsById | Get event subscriptions by id","tags":["Communication"],"parameters":[{"in":"path","name":"company_id","description":"Company id","required":true,"schema":{"type":"string","example":"13741"}},{"in":"path","name":"application_id","description":"Application id","required":true,"schema":{"type":"string","example":"637b6355dc65337da9b5c951"}},{"in":"path","name":"id","description":"Event subscription id","required":true,"schema":{"type":"string","example":"5fd9fd44c474a7e3d5d376d6"}},{"in":"query","name":"populate","description":"Populate Fields","required":false,"schema":{"type":"string","example":"template.sms.template"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventSubscription"},"examples":{"default":{"$ref":"#/components/examples/EventSubscription"}}}}},"404":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericError"},"examples":{"default":{"$ref":"#/components/examples/GenericError"}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericError"},"examples":{"default":{"$ref":"#/components/examples/GenericError"}}}}}}},"put":{"description":"Create event subscriptions","summary":"editEventSubscriptions | Create event subscriptions","tags":["Communication"],"parameters":[{"in":"path","name":"company_id","description":"Company id","required":true,"schema":{"type":"string","example":"13741"}},{"in":"path","name":"application_id","description":"Application id","required":true,"schema":{"type":"string","example":"637b6355dc65337da9b5c951"}},{"in":"path","name":"id","description":"Event subscription id","required":true,"schema":{"type":"string","example":"5fd9fd44c474a7e3d5d376d6"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionsObject"},"examples":{"default":{"$ref":"#/components/examples/SubscriptionsObject"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventSubscriptionsBulkUpdateResponse"},"examples":{"default":{"$ref":"#/components/examples/EventSubscriptionsBulkUpdateResponse"}}}}},"404":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericError"},"examples":{"default":{"$ref":"#/components/examples/GenericError"}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericError"},"examples":{"default":{"$ref":"#/components/examples/GenericError"}}}}}}},"delete":{"description":"Create event subscriptions","summary":"deleteEventSubscriptionsById | Create event subscriptions","tags":["Communication"],"parameters":[{"in":"path","name":"company_id","description":"Company id","required":true,"schema":{"type":"string","example":"13741"}},{"in":"path","name":"application_id","description":"Application id","required":true,"schema":{"type":"string","example":"637b6355dc65337da9b5c951"}},{"in":"path","name":"id","description":"Event subscription id","required":true,"schema":{"type":"string","example":"5fd9fd44c474a7e3d5d376d6"}}],"responses":{"200":{"description":"Refer `GenericDelete` schema for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericDelete"},"examples":{"default":{"$ref":"#/components/examples/GenericDelete"}}}}},"404":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericError"},"examples":{"default":{"$ref":"#/components/examples/GenericError"}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericError"},"examples":{"default":{"$ref":"#/components/examples/GenericError"}}}}}}}},"/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/event/event-subscriptions/bulkUpdate":{"post":{"description":"Create event subscriptions by bulk","summary":"createEventSubscriptionsByBulk | Create event subscriptions by bulk","tags":["Communication"],"parameters":[{"in":"path","name":"company_id","description":"Company id","required":true,"schema":{"type":"string","example":"13741"}},{"in":"path","name":"application_id","description":"Application id","required":true,"schema":{"type":"string","example":"637b6355dc65337da9b5c951"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventSubscriptionsBulkUpdateRequest"},"examples":{"default":{"$ref":"#/components/examples/EventSubscriptionsBulkUpdateRequest"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EventSubscriptionsBulkUpdateResponse"}},"examples":{"default":{"$ref":"#/components/examples/EventSubscriptionsBulkUpdateResponse"}}}}},"404":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericError"},"examples":{"default":{"$ref":"#/components/examples/GenericError"}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericError"},"examples":{"default":{"$ref":"#/components/examples/GenericError"}}}}}}}},"/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/global-variables":{"get":{"description":"get global variables","summary":"getGlobalVariables | get global variables","tags":["Communication"],"parameters":[{"in":"path","name":"company_id","description":"Company id","required":true,"schema":{"type":"string","example":"13741"}},{"in":"path","name":"application_id","description":"Application id","required":true,"schema":{"type":"string","example":"637b6355dc65337da9b5c951"}}],"responses":{"200":{"description":"Refer `GlobalVariablesGetResponse` schema for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalVariablesGetResponse"},"examples":{"default":{"$ref":"#/components/examples/GlobalVariablesGetResponse"}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericError"},"examples":{"default":{"$ref":"#/components/examples/GenericError"}}}}}}},"post":{"description":"psot global variables","summary":"postGlobalVariables | post global variables","tags":["Communication"],"parameters":[{"in":"path","name":"company_id","description":"Company id","required":true,"schema":{"type":"string","example":"13741"}},{"in":"path","name":"application_id","description":"Application id","required":true,"schema":{"type":"string","example":"637b6355dc65337da9b5c951"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalVariablesReq"},"examples":{"default":{"$ref":"#/components/examples/GlobalVariablesReq"}}}}},"responses":{"200":{"description":"Refer `GlobalVariablesPostResponse` schema for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalVariablesPostResponse"},"examples":{"default":{"$ref":"#/components/examples/GlobalVariablesPostResponse"}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericError"},"examples":{"default":{"$ref":"#/components/examples/GenericError"}}}}}}}},"/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/jobs/jobs":{"get":{"description":"Get jobs","summary":"getJobs | Get jobs","tags":["Communication"],"parameters":[{"in":"path","name":"company_id","description":"Company id","required":true,"schema":{"type":"string","example":"13741"}},{"in":"path","name":"application_id","description":"Application id","required":true,"schema":{"type":"string","example":"637b6355dc65337da9b5c951"}},{"in":"query","name":"page_no","description":"Current page no","required":false,"schema":{"type":"integer","minimum":1,"exclusiveMinimum":false,"example":1}},{"in":"query","name":"page_size","description":"Current request items count","required":false,"schema":{"type":"integer","example":10}},{"in":"query","name":"sort","description":"To sort based on created_at","required":false,"schema":{"type":"object","example":{"created_at":-1}}},{"in":"query","name":"query","description":"To search based on plain text","required":false,"schema":{"type":"object","example":{"$or":[{"name":{"$regex":"mk","$options":"i"}},{"tags":{"$regex":"mk","$options":"i"}}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Jobs"},"examples":{"default":{"$ref":"#/components/examples/Jobs"}}}}}}},"post":{"description":"Create jobs","summary":"createJobs | Create jobs","tags":["Communication"],"parameters":[{"in":"path","name":"company_id","description":"Company id","required":true,"schema":{"type":"string","example":"13741"}},{"in":"path","name":"application_id","description":"Application id","required":true,"schema":{"type":"string","example":"637b6355dc65337da9b5c951"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateJobsReq"},"examples":{"default":{"$ref":"#/components/examples/CreateJobsReq"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateJobsRes"},"examples":{"default":{"$ref":"#/components/examples/CreateJobsRes"}}}}}}}},"/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/jobs/trigger-job":{"post":{"description":"Trigger campaign job","summary":"triggerCampaignJob | Trigger campaign job","tags":["Communication"],"parameters":[{"in":"path","name":"company_id","description":"Company id","required":true,"schema":{"type":"string","example":"13741"}},{"in":"path","name":"application_id","description":"Application id","required":true,"schema":{"type":"string","example":"637b6355dc65337da9b5c951"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TriggerJobRequest"},"examples":{"default":{"$ref":"#/components/examples/TriggerJobRequest"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TriggerJobResponse"},"examples":{"default":{"$ref":"#/components/examples/TriggerJobResponse"}}}}}}}},"/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/jobs/logs":{"get":{"description":"Get job logs","summary":"getJobLogs | Get job logs","tags":["Communication"],"parameters":[{"in":"path","name":"company_id","description":"Company id","required":true,"schema":{"type":"string","example":"13741"}},{"in":"path","name":"application_id","description":"Application id","required":true,"schema":{"type":"string","example":"637b6355dc65337da9b5c951"}},{"in":"query","name":"page_no","description":"Current page no","required":false,"schema":{"type":"integer","minimum":1,"exclusiveMinimum":false,"example":1}},{"in":"query","name":"page_size","description":"Current request items count","required":false,"schema":{"type":"integer","example":10}},{"in":"query","name":"sort","description":"To sort based on created_at","required":false,"schema":{"type":"object","example":{"created_at":-1}}},{"in":"query","name":"query","description":"To search based on plain text","required":false,"schema":{"type":"object","example":{"$or":[{"name":{"$regex":"mk","$options":"i"}},{"tags":{"$regex":"mk","$options":"i"}}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobLogs"},"examples":{"default":{"$ref":"#/components/examples/JobLogs"}}}}}}}},"/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/log":{"get":{"description":"Get communication logs","summary":"getCommunicationLogs | Get communication logs","tags":["Communication"],"parameters":[{"in":"path","name":"company_id","description":"Company id","required":true,"schema":{"type":"string","example":"13741"}},{"in":"path","name":"application_id","description":"Application id","required":true,"schema":{"type":"string","example":"637b6355dc65337da9b5c951"}},{"name":"page_id","in":"query","schema":{"type":"string"},"description":"Current page no"},{"name":"page_size","in":"query","schema":{"type":"integer"},"description":"Current request items count"},{"name":"sort","in":"query","schema":{"type":"object","properties":{"_id":{"type":"integer"}}},"description":"To sort based on _id"},{"name":"query","in":"query","schema":{"type":"object"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Logs"},"examples":{"default":{"$ref":"#/components/examples/Logs"}}}}}}}},"/service/platform/communication/v1.0/company/{company_id}/notification/system-notifications/":{"get":{"description":"Get system notifications","summary":"getSystemNotifications | Get system notifications","tags":["Communication"],"parameters":[{"in":"path","name":"company_id","description":"Company id","required":true,"schema":{"type":"string","example":"13741"}},{"in":"query","name":"page_no","schema":{"type":"integer","format":"int32","example":1}},{"in":"query","name":"page_size","schema":{"type":"integer","format":"int32","example":10}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SystemNotifications"},"examples":{"default":{"$ref":"#/components/examples/SystemNotifications"}}}}}}}},"/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/otp/send-otp-comms":{"post":{"description":"Send OTP Comms via email and sms","summary":"sendOtp | Send OTP using email and sms","tags":["Communication"],"parameters":[{"in":"path","name":"company_id","description":"Company id","required":true,"schema":{"type":"string","example":"13741"}},{"in":"path","name":"application_id","description":"Application id","required":true,"schema":{"type":"string","example":"637b6355dc65337da9b5c951"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendOtpCommsReq"},"examples":{"default":{"$ref":"#/components/examples/SendOtpCommsReq"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendOtpCommsRes"},"examples":{"default":{"$ref":"#/components/examples/SendOtpCommsRes"}}}}}}}},"/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/otp/verify-otp-comms":{"post":{"description":"Verify OTP sent via email and sms","summary":"verfiyOtp | Verify OTP sent via email and sms","tags":["Communication"],"parameters":[{"in":"path","name":"company_id","description":"Company id","required":true,"schema":{"type":"string","example":"13741"}},{"in":"path","name":"application_id","description":"Application id","required":true,"schema":{"type":"string","example":"637b6355dc65337da9b5c951"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerifyOtpCommsReq"},"examples":{"default":{"$ref":"#/components/examples/VerifyOtpCommsReq"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerifyOtpCommsSuccessRes"},"examples":{"default":{"$ref":"#/components/examples/VerifyOtpCommsSuccessRes"}}}}},"400":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerifyOtpCommsErrorRes"},"examples":{"default":{"$ref":"#/components/examples/VerifyOtpCommsErrorRes"}}}}}}}},"/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/otp/otp-configuration":{"get":{"description":"Get otp-configuration","summary":"getOtpConfiguration | Get otp-configuration, if not present in db then return default settings","tags":["Communication"],"parameters":[{"in":"path","name":"company_id","description":"Company id","required":true,"schema":{"type":"string","example":"13741"}},{"in":"path","name":"application_id","description":"Application id","required":true,"schema":{"type":"string","example":"637b6355dc65337da9b5c951"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OtpConfiguration"},"examples":{"default":{"$ref":"#/components/examples/OtpConfigurationRes"}}}}}}},"put":{"description":"Update otp-configuration","summary":"updateOtpConfiguration | Update/insert otp configurations","tags":["Communication"],"parameters":[{"in":"path","name":"company_id","description":"Company id","required":true,"schema":{"type":"string","example":"13741"}},{"in":"path","name":"application_id","description":"Application id","required":true,"schema":{"type":"string","example":"637b6355dc65337da9b5c951"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OtpConfiguration"},"examples":{"default":{"$ref":"#/components/examples/OtpConfigurationRes"}}}}}}}},"/service/platform/company-profile/v1.0/company/{company_id}":{"get":{"summary":"cbsOnboardGet | Get company profile","description":"This API allows to view the company profile of the seller account.","tags":["CompanyProfile"],"parameters":[{"in":"path","name":"company_id","description":"A `company_id` is a unique identifier for a particular seller account.","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Company profile object. See example below or refer `GetCompanyProfileSerializerResponse` for details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCompanyProfileSerializerResponse"},"example":{"documents":[{"verified":true,"legal_name":"SHOPSENSE RETAIL TECHNOLOGIES PRIVATE LIMITED","value":"AALCA0442L","type":"pan"}],"created_by":{"user_id":"123","username":"917827311650_22960"},"business_info":"I sell","franchise_enabled":true,"company_type":"mbo","warnings":{},"business_details":{"website":{"url":"https://www.google.com"}},"addresses":[{"country":"India","longitude":72.8231511,"state":"Maharashtra","address1":"A/204, Sai Vandan, Tulinj Road. Nallasopara East, ","country_code":"IN","latitude":19.4232024,"pincode":401209,"address_type":"office","city":"Mumbai"},{"country":"India","longitude":72.8231511,"state":"Maharashtra","address1":"A/204, Sai Vandan, Tulinj Road. Nallasopara East, ","country_code":"IN","latitude":19.4232024,"pincode":401209,"address_type":"registered","city":"Mumbai"}],"modified_by":{"user_id":"123","username":"917827311650_22960"},"notification_emails":["gaurangpatel@gofynd.com"],"business_type":"huf","name":"Cache Company","stage":"verified","uid":1,"business_country_info":{"country":"India","country_code":"IN","currency":{"code":"INR","symbol":"₹","name":"Indian Rupee"},"timezone":"Asia/Calcutta"}}}}},"4XX":{"description":"Bad request. See the error object in the response body for specific reason","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"BadRequestExample":{"value":{"message":"Invalid input data","code":"BAD_REQUEST","status":400,"meta":{}}},"NotFoundExample":{"value":{"message":"Resource not found","code":"NOT_FOUND","status":404,"meta":{}}}}}}}}},"patch":{"summary":"updateCompany | Edit company profile","description":"This API allows to edit the company profile of the seller account.","tags":["CompanyProfile"],"parameters":[{"in":"path","name":"company_id","description":"A `company_id` is a unique identifier for a particular seller account.","schema":{"type":"string"},"required":true}],"requestBody":{"description":"Onboard object that needs to be added.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCompany"},"example":{"name":"CBS edited","franchise_enabled":false,"business_type":"huf","company_type":"mbo","business_info":"I amkjhhkj ","warnings":{},"documents":[{"legal_name":"Rahul","verified":true,"value":"CUYPP9123J","type":"pan"}],"addresses":[{"pincode":400070,"state":"Maharashtra","address_type":"office","country_code":"IN","country":"India","city":"Mumbai Suburban","latitude":19.058461,"longitude":72.871395,"address1":"Chunabhatti Phatak, Maharashtra Nagar, Maharashtra Nagar, "},{"pincode":400070,"state":"Maharashtra","address_type":"registered","country_code":"IN","country":"India","city":"Mumbai Suburban","latitude":19.058461,"longitude":72.871395,"address1":"Chunabhatti Phatak, Maharashtra Nagar, Maharashtra Nagar, "}],"stage":"complete","business_country_info":{"country_code":"IN","country":"India"},"notification_emails":["rahul@gofynd.com"]}}}},"responses":{"200":{"description":"Returns a success message","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfileSuccessResponse"},"example":{"uid":1,"success":true}}}},"4XX":{"description":"Bad request. See the error object in the response body for specific reason","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/service/platform/company-profile/v1.0/company/{company_id}/metrics":{"get":{"summary":"getCompanyMetrics | Get company metrics","description":"This API allows to view the company metrics, i.e. the status of its brand and stores. Also its allows to view the number of products, company documents & store documents which are verified and unverified.","tags":["CompanyProfile"],"parameters":[{"in":"path","name":"company_id","description":"A `company_id` is a unique identifier for a particular seller account.","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Metrics response object. See example below or refer `MetricsSerializer` for details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetricsSerializer"},"example":{"uid":1,"stage":"complete","store":{"verified":1,"pending":1},"brand":{"verified":1,"pending":1},"product":{"verified":0,"pending":0},"company_documents":{"verified":1,"pending":0},"store_documents":{"verified":0,"pending":2}}}}},"4XX":{"description":"Bad request. See the error object in the response body for specific reason","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/service/platform/company-profile/v1.0/company/{company_id}/brand/{brand_id}":{"get":{"summary":"getBrand | Get a single company brand.","description":"This API helps to get data associated to a particular company brand.","tags":["CompanyProfile"],"parameters":[{"in":"path","name":"company_id","description":"Id of the company associated to brand that is to be viewed.","schema":{"type":"string"},"required":true},{"in":"path","name":"brand_id","description":"Id of the brand to be viewed.","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Brand object. See example below or refer `GetBrandResponseSerializer` for details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBrandResponseSerializer"},"example":{"stage":"verified","_custom_json":{},"uid":1,"logo":"http://cdn4.gofynd.com/media/logo/brand/original/4597_40d1ce44d61940d4829a3c54951bd9ee.jpg","warnings":{},"_locale_language":{},"name":"edited brand","slug_key":"brand-2","banner":{"portrait":"http://cdn4.gofynd.com/media/banner_portrait/brand/original/7021_16fc50205c40477daf419b64ec64c64c.jpg","landscape":"http://cdn4.gofynd.com/media/banner/brand/original/7020_f9e91f7d501c4f2985c09bd196ed304d.jpg"},"created_by":{"username":"silverbolt","user_id":"0"},"modified_by":{"username":"917827311650_22960","user_id":"123"},"verified_by":{"username":"917827311650_22960","user_id":"123"},"synonyms":["xyz"]}}}},"4XX":{"description":"Bad request. See the error object in the response body for specific reason","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"put":{"summary":"editBrand | Edit a brand.","description":"This API allows to edit meta of a brand.","tags":["CompanyProfile"],"parameters":[{"in":"path","name":"company_id","description":"Id of the company associated to brand that is to be viewed.","schema":{"type":"string"},"required":true},{"in":"path","name":"brand_id","description":"Id of the brand to be viewed.","schema":{"type":"string"},"required":true}],"requestBody":{"description":"Brand object that needs to be updated.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUpdateBrandRequestSerializer"},"example":{"name":"Brand edit","logo":"http://hdn-1.gofynd.com/media/logo/brand/original/4597_40d1ce44d61940d4829a3c54951bd9ee.jpg","banner":{"landscape":"http://hdn-1.gofynd.com/media/banner/brand/original/7020_f9e91f7d501c4f2985c09bd196ed304d.jpg","portrait":"http://hdn-1.gofynd.com/media/banner_portrait/brand/original/7021_16fc50205c40477daf419b64ec64c64c.jpg"},"synonyms":["brand"]}}}},"responses":{"200":{"description":"Returns a success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfileSuccessResponse"},"example":{"uid":1,"success":true}}}},"4XX":{"description":"Bad request. See the error object in the response body for specific reason","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/service/platform/company-profile/v1.0/company/{company_id}/brand/":{"post":{"summary":"createBrand | Create a Brand.","description":"This API allows to create a brand associated to a company.","tags":["CompanyProfile"],"parameters":[{"in":"path","name":"company_id","description":"Id of the company.","schema":{"type":"string"},"required":true}],"requestBody":{"description":"Brand object that needs to be added.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUpdateBrandRequestSerializer"},"example":{"name":"Brand","logo":"http://hdn-1.gofynd.com/media/logo/brand/original/4597_40d1ce44d61940d4829a3c54951bd9ee.jpg","banner":{"landscape":"http://hdn-1.gofynd.com/media/banner/brand/original/7020_f9e91f7d501c4f2985c09bd196ed304d.jpg","portrait":"http://hdn-1.gofynd.com/media/banner_portrait/brand/original/7021_16fc50205c40477daf419b64ec64c64c.jpg"},"synonyms":["brand"]}}}},"responses":{"200":{"description":"Returns a success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfileSuccessResponse"},"example":{"uid":1,"success":true}}}},"4XX":{"description":"Bad request. See the error object in the response body for specific reason","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/service/platform/company-profile/v1.0/company/{company_id}/company-brand":{"get":{"summary":"getBrands | Get brands associated to a company","description":"This API helps to get view brands associated to a particular company.","tags":["CompanyProfile"],"parameters":[{"in":"path","name":"company_id","description":"Id of the company.","schema":{"type":"string"},"required":true},{"in":"query","name":"page_no","description":"The page number to navigate through the given set of results","schema":{"type":"integer","default":1},"required":false},{"in":"query","name":"page_size","description":"Number of items to retrieve in each page. Default is 10.","schema":{"type":"integer","default":20},"required":false},{"in":"query","name":"q","description":"Search term for name.","schema":{"type":"string"},"required":false}],"responses":{"200":{"description":"Brand object. See example below or refer `CompanyBrandListSerializer` for details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyBrandListSerializer"},"example":{"items":[{"brand":{"stage":"complete","uid":2,"banner":{"portrait":"http://cdn4.gofynd.com/media/banner_portrait/brand/original/7021_16fc50205c40477daf419b64ec64c64c.jpg","landscape":"http://cdn4.gofynd.com/media/banner/brand/original/7020_f9e91f7d501c4f2985c09bd196ed304d.jpg"},"modified_by":{"user_id":"123","username":"917827311650_22960"},"slug_key":"test-post","synonyms":["xyz"],"created_on":"2021-02-25T15:21:57.666000+00:00","created_by":{"user_id":"123","username":"917827311650_22960"},"modified_on":"2021-02-25T15:21:57.666000+00:00","name":"test_post","logo":"http://cdn4.gofynd.com/media/logo/brand/original/4597_40d1ce44d61940d4829a3c54951bd9ee.jpg"},"stage":"complete","uid":2,"modified_by":{"user_id":"123","username":"917827311650_22960"},"company":{"business_type":"huf","stage":"complete","uid":1,"addresses":[{"city":"Mumbai Suburban","latitude":19.058461,"longitude":72.871395,"address1":"Chunabhatti Phatak, Maharashtra Nagar, Maharashtra Nagar, ","country_code":"IN","state":"Maharashtra","country":"India","pincode":400070,"address_type":"office"},{"city":"Mumbai Suburban","latitude":19.058461,"longitude":72.871395,"address1":"Chunabhatti Phatak, Maharashtra Nagar, Maharashtra Nagar, ","country_code":"IN","state":"Maharashtra","country":"India","pincode":400070,"address_type":"registered"}],"modified_by":{"user_id":"-1","username":"silverbolt"},"company_type":"mbo","created_on":"2021-02-25T15:21:51.526000+00:00","created_by":{"user_id":"123","username":"917827311650_22960"},"modified_on":"2021-02-25T17:44:55.722000+00:00","name":"Cache Company"},"created_by":{"user_id":"123","username":"917827311650_22960"}}],"page":{"type":"","current":1,"size":1,"has_previous":false,"has_next":false,"item_count":1}}}}},"4XX":{"description":"Bad request. See the error object in the response body for specific reason","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"post":{"summary":"createCompanyBrandMapping | Create a company brand mapping.","description":"This API allows to create a company brand mapping, for a already existing brand in the system.","tags":["CompanyProfile"],"parameters":[{"in":"path","name":"company_id","description":"Id of the company inside which the brand is to be mapped.","schema":{"type":"string"},"required":true}],"requestBody":{"description":"Companybrand object.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyBrandPostRequestSerializer"},"example":{"company":2,"brands":[1]}}}},"responses":{"200":{"description":"Returns a success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfileSuccessResponse"},"example":{"success":true}}}},"4XX":{"description":"Bad request. See the error object in the response body for specific reason","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/service/platform/company-profile/v1.0/company/{company_id}/location":{"get":{"summary":"getLocations | Get list of locations","description":"This API allows to view all the locations associated to a company.","tags":["CompanyProfile"],"parameters":[{"in":"path","name":"company_id","description":"Id of the company whose locations are to fetched","schema":{"type":"string"},"required":true},{"in":"query","name":"store_type","description":"Helps to sort the location list on the basis of location type.","schema":{"type":"string"},"required":false},{"in":"query","name":"q","description":"Query that is to be searched.","schema":{"type":"string"},"required":false},{"in":"query","name":"stage","description":"to filter companies on basis of verified or unverified companies.","schema":{"type":"string"},"required":false},{"in":"query","name":"page_no","description":"The page number to navigate through the given set of results","schema":{"type":"integer","default":1},"required":false},{"in":"query","name":"page_size","description":"Number of items to retrieve in each page. Default is 10.","schema":{"type":"integer","default":20},"required":false},{"in":"query","name":"location_ids","description":"Helps to filter stores on the basis of uids.","schema":{"type":"array","items":{"type":"integer"}},"required":false},{"in":"query","name":"types","description":"Helps to get the location list on the basis of multiple location type.","schema":{"type":"array","items":{"type":"string"}},"required":false},{"in":"query","name":"tags","description":"Helps to get the location list on the basis of multiple location tag.","schema":{"type":"array","items":{"type":"string"}},"required":false}],"responses":{"200":{"description":"Company profile object. See example below or refer `LocationListSerializer` for details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationListSerializer"},"example":{"items":[{"company":{"business_type":"huf","stage":"complete","uid":1,"addresses":[{"city":"Mumbai Suburban","latitude":19.058461,"longitude":72.871395,"address1":"Chunabhatti Phatak, Maharashtra Nagar, Maharashtra Nagar, ","country_code":"IN","state":"Maharashtra","country":"India","pincode":400070,"address_type":"office"},{"city":"Mumbai Suburban","latitude":19.058461,"longitude":72.871395,"address1":"Chunabhatti Phatak, Maharashtra Nagar, Maharashtra Nagar, ","country_code":"IN","state":"Maharashtra","country":"India","pincode":400070,"address_type":"registered"}],"modified_by":{"user_id":"-1","username":"silverbolt"},"company_type":"mbo","created_on":"2021-02-25T15:21:51.526000+00:00","created_by":{"user_id":"123","username":"917827311650_22960"},"modified_on":"2021-02-25T17:44:55.722000+00:00","name":"Cache Company"},"address":{"city":"MUMBAI","latitude":19.4232024,"longitude":72.8231511,"address1":"A/204, SAI VANDAN, NARAYAN NAGAR, TULINJ ROAD","state":"MAHARASHTRA","country":"INDIA","pincode":401209},"timing":[{"closing":{"minute":0,"hour":22},"opening":{"minute":0,"hour":11},"open":true,"weekday":"monday"},{"closing":{"minute":0,"hour":22},"opening":{"minute":0,"hour":11},"open":true,"weekday":"tuesday"},{"closing":{"minute":0,"hour":22},"opening":{"minute":0,"hour":11},"open":true,"weekday":"wednesday"},{"closing":{"minute":0,"hour":22},"opening":{"minute":0,"hour":11},"open":true,"weekday":"thursday"},{"closing":{"minute":0,"hour":22},"opening":{"minute":0,"hour":11},"open":true,"weekday":"friday"},{"closing":{"minute":0,"hour":22},"opening":{"minute":0,"hour":11},"open":true,"weekday":"saturday"},{"closing":{"minute":0,"hour":22},"opening":{"minute":0,"hour":11},"open":true,"weekday":"sunday"}],"documents":[],"display_name":"new store","manager":{"name":"Yrf","mobile_no":{"country_code":91,"number":"83456774567"},"email":"gbp@jkl.com"},"code":"code2","product_return_config":{"on_same_store":true},"created_on":"2021-02-25T15:22:04.913000+00:00","created_by":{"user_id":"123","username":"917827311650_22960"},"name":"location2","gst_credentials":{"e_invoice":{"enabled":false}},"store_type":"high_street","contact_numbers":[{"country_code":91,"number":"7208229698"}],"stage":"complete","uid":2,"notification_emails":[]}],"page":{"type":"","current":1,"size":1,"has_previous":false,"has_next":false,"item_count":1}}}}},"4XX":{"description":"Bad request. See the error object in the response body for specific reason","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"post":{"summary":"createLocation | Create a location associated to a company.","description":"This API allows to edit a location associated to a company.","tags":["CompanyProfile"],"parameters":[{"in":"path","name":"company_id","description":"Id of the company inside which the location is to be created.","schema":{"type":"string"},"required":true}],"requestBody":{"description":"Location object that needs to be added.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationSerializer"},"example":{"notification_emails":[],"address":{"longitude":72.8231511,"landmark":"","address2":"","address1":"A/204, New SAI VANDAN, NARAYAN NAGAR, TULINJ ROAD","latitude":19.4232024,"country":"INDIA","pincode":401209,"city":"MUMBAI","state":"MAHARASHTRA"},"documents":[],"gst_credentials":{"e_invoice":{"enabled":true,"password":"hello","username":"hello"}},"company":12,"name":"New Store","display_name":"new ","store_type":"high_street","code":"store","timing":[{"closing":{"minute":0,"hour":22},"opening":{"minute":0,"hour":11},"weekday":"monday","open":true},{"closing":{"minute":0,"hour":22},"opening":{"minute":0,"hour":11},"weekday":"tuesday","open":true},{"closing":{"minute":0,"hour":22},"opening":{"minute":0,"hour":11},"weekday":"wednesday","open":true},{"closing":{"minute":0,"hour":22},"opening":{"minute":0,"hour":11},"weekday":"thursday","open":true},{"closing":{"minute":0,"hour":22},"opening":{"minute":0,"hour":11},"weekday":"friday","open":true},{"closing":{"minute":0,"hour":22},"opening":{"minute":0,"hour":11},"weekday":"saturday","open":true},{"closing":{"minute":0,"hour":22},"opening":{"minute":0,"hour":11},"weekday":"sunday","open":true}],"manager":{"name":"Yrf","mobile_no":{"country_code":91,"number":"83456774567"},"email":"gbp@jkl.com"},"contact_numbers":[{"country_code":91,"number":"7208229698"}],"warnings":{},"product_return_config":{"on_same_store":false,"store_uid":11906}}}}},"responses":{"200":{"description":"Returns a success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfileSuccessResponse"},"example":{"uid":1,"success":true}}}},"4XX":{"description":"Bad request. See the error object in the response body for specific reason","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/service/platform/company-profile/v1.0/company/{company_id}/location/{location_id}":{"get":{"summary":"getLocationDetail | Get details of a specific location.","description":"This API helps to get data associated to a specific location.","tags":["CompanyProfile"],"parameters":[{"in":"path","name":"company_id","description":"Id of the company inside which the location lies.","schema":{"type":"string"},"required":true},{"in":"path","name":"location_id","description":"Id of the location which you want to view.","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Brand object. See example below or refer `GetLocationSerializer` for details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetLocationSerializer"},"example":{"verified_on":"2021-02-25T15:22:07.140000+00:00","company":{"business_type":"huf","stage":"complete","uid":1,"addresses":[{"city":"Mumbai Suburban","latitude":19.058461,"longitude":72.871395,"address1":"Chunabhatti Phatak, Maharashtra Nagar, Maharashtra Nagar, ","country_code":"IN","state":"Maharashtra","country":"India","pincode":400070,"address_type":"office"},{"city":"Mumbai Suburban","latitude":19.058461,"longitude":72.871395,"address1":"Chunabhatti Phatak, Maharashtra Nagar, Maharashtra Nagar, ","country_code":"IN","state":"Maharashtra","country":"India","pincode":400070,"address_type":"registered"}],"modified_by":{"user_id":"-1","username":"silverbolt"},"company_type":"mbo","created_by":{"user_id":"123","username":"917827311650_22960"},"name":"Cache Company"},"address":{"city":"MUMBAI","landmark":"","latitude":19.4232024,"longitude":72.8231511,"address2":"","address1":"A/204, SAI VANDAN, NARAYAN NAGAR, TULINJ ROAD","state":"MAHARASHTRA","country":"INDIA","pincode":401209},"timing":[{"closing":{"minute":0,"hour":22},"opening":{"minute":0,"hour":11},"open":true,"weekday":"monday"},{"closing":{"minute":0,"hour":22},"opening":{"minute":0,"hour":11},"open":true,"weekday":"tuesday"},{"closing":{"minute":0,"hour":22},"opening":{"minute":0,"hour":11},"open":true,"weekday":"wednesday"},{"closing":{"minute":0,"hour":22},"opening":{"minute":0,"hour":11},"open":true,"weekday":"thursday"},{"closing":{"minute":0,"hour":22},"opening":{"minute":0,"hour":11},"open":true,"weekday":"friday"},{"closing":{"minute":0,"hour":22},"opening":{"minute":0,"hour":11},"open":true,"weekday":"saturday"},{"closing":{"minute":0,"hour":22},"opening":{"minute":0,"hour":11},"open":true,"weekday":"sunday"}],"documents":[],"warnings":{},"display_name":"new store","manager":{"name":"Yrf","mobile_no":{"country_code":91,"number":"83456774567"},"email":"gbp@jkl.com"},"code":"store1","product_return_config":{"on_same_store":true},"modified_by":{"user_id":"-1","username":"silverbolt"},"created_by":{"user_id":"123","username":"917827311650_22960"},"name":"edited_store","gst_credentials":{"e_invoice":{"enabled":false}},"verified_by":{"user_id":"-1","username":"silverbolt"},"store_type":"high_street","contact_numbers":[{"country_code":91,"number":"7208229698"}],"stage":"verified","uid":1,"notification_emails":[]}}}},"4XX":{"description":"Bad request. See the error object in the response body for specific reason","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"put":{"summary":"updateLocation | Edit a location asscoiated to a company.","description":"This API allows to edit a location associated to a company.","tags":["CompanyProfile"],"parameters":[{"in":"path","name":"company_id","description":"Id of the company inside which the location is to be created.","schema":{"type":"string"},"required":true},{"in":"path","name":"location_id","description":"Id of the location which you want to edit.","schema":{"type":"string"},"required":true}],"requestBody":{"description":"Location object that needs to be added.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationSerializer"},"example":{"notification_emails":[],"address":{"longitude":72.8231511,"landmark":"","address2":"","address1":"A/204, New SAI VANDAN, NARAYAN NAGAR, TULINJ ROAD","latitude":19.4232024,"country":"INDIA","pincode":401209,"city":"MUMBAI","state":"MAHARASHTRA"},"documents":[],"gst_credentials":{"e_invoice":{"enabled":true,"password":"hello","username":"hello"}},"company":12,"name":"New Store","display_name":"new ","store_type":"high_street","code":"store","timing":[{"closing":{"minute":0,"hour":22},"opening":{"minute":0,"hour":11},"weekday":"monday","open":true},{"closing":{"minute":0,"hour":22},"opening":{"minute":0,"hour":11},"weekday":"tuesday","open":true},{"closing":{"minute":0,"hour":22},"opening":{"minute":0,"hour":11},"weekday":"wednesday","open":true},{"closing":{"minute":0,"hour":22},"opening":{"minute":0,"hour":11},"weekday":"thursday","open":true},{"closing":{"minute":0,"hour":22},"opening":{"minute":0,"hour":11},"weekday":"friday","open":true},{"closing":{"minute":0,"hour":22},"opening":{"minute":0,"hour":11},"weekday":"saturday","open":true},{"closing":{"minute":0,"hour":22},"opening":{"minute":0,"hour":11},"weekday":"sunday","open":true}],"manager":{"name":"Yrf","mobile_no":{"country_code":91,"number":"83456774567"},"email":"gbp@jkl.com"},"contact_numbers":[{"country_code":91,"number":"7208229698"}],"warnings":{},"product_return_config":{"on_same_store":false,"store_uid":11906}}}}},"responses":{"200":{"description":"Returns a success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfileSuccessResponse"},"example":{"uid":1,"success":true}}}},"4XX":{"description":"Bad request. See the error object in the response body for specific reason","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/service/platform/company-profile/v1.0/company/{company_id}/location/bulk":{"post":{"summary":"createLocationBulk | Create a location asscoiated to a company in bulk.","description":"This API allows to create a location associated to a company.","tags":["CompanyProfile"],"parameters":[{"in":"path","name":"company_id","description":"Id of the company inside which the location is to be created.","schema":{"type":"string"},"required":true}],"requestBody":{"description":"Location object that needs to be added.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkLocationSerializer"},"example":{"data":[{"notification_emails":[],"address":{"longitude":72.8231511,"landmark":"","address2":"","address1":"A/204, New SAI VANDAN, NARAYAN NAGAR, TULINJ ROAD","latitude":19.4232024,"country":"INDIA","pincode":401209,"city":"MUMBAI","state":"MAHARASHTRA"},"documents":[],"gst_credentials":{"e_invoice":{"enabled":true,"password":"hello","username":"hello"}},"company":12,"name":"New Store","display_name":"new ","store_type":"high_street","code":"store","timing":[{"closing":{"minute":0,"hour":22},"opening":{"minute":0,"hour":11},"weekday":"monday","open":true},{"closing":{"minute":0,"hour":22},"opening":{"minute":0,"hour":11},"weekday":"tuesday","open":true},{"closing":{"minute":0,"hour":22},"opening":{"minute":0,"hour":11},"weekday":"wednesday","open":true},{"closing":{"minute":0,"hour":22},"opening":{"minute":0,"hour":11},"weekday":"thursday","open":true},{"closing":{"minute":0,"hour":22},"opening":{"minute":0,"hour":11},"weekday":"friday","open":true},{"closing":{"minute":0,"hour":22},"opening":{"minute":0,"hour":11},"weekday":"saturday","open":true},{"closing":{"minute":0,"hour":22},"opening":{"minute":0,"hour":11},"weekday":"sunday","open":true}],"manager":{"name":"Yrf","mobile_no":{"country_code":91,"number":"83456774567"},"email":"gbp@jkl.com"},"contact_numbers":[{"country_code":91,"number":"7208229698"}],"warnings":{},"product_return_config":{"on_same_store":false,"store_uid":11906}}]}}}},"responses":{"200":{"description":"Returns a success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfileSuccessResponse"},"example":{"message":"10 stores inserted","success":true}}}},"4XX":{"description":"Bad request. See the error object in the response body for specific reason","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/service/platform/company-profile/v1.0/company/{company_id}/location/tags":{"get":{"summary":"getLocationTags | Get tags associated with locations for a company.","description":"This API fetches all the tags associated to a company.","tags":["CompanyProfile"],"parameters":[{"in":"path","name":"company_id","description":"Id of the company inside which the location is to be created.","schema":{"type":"integer"},"required":true,"examples":{"success":{"value":1}}}],"responses":{"200":{"description":"Tags list. See example below or refer `StoreTagsResponseSchema` for details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreTagsResponseSchema"},"examples":{"TagsFound":{"value":{"tags":["hyperlocale","instant"],"success":true}},"NoTagsFound":{"value":{"tags":[],"success":true}}}}}},"4XX":{"description":"Bad request. See the error object in the response body for specific  reason","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/build/{platform_type}/configuration":{"get":{"description":"Fetch latest build configuration, such as app name, landing page image, splash image used in a mobile build.","summary":"getBuildConfig | Get configuration of latest mobile build","tags":["Configuration"],"parameters":[{"schema":{"type":"integer"},"description":"Numeric ID allotted to a business account on Fynd Platform","in":"path","required":true,"name":"company_id","examples":{"success":{"value":2}}},{"schema":{"type":"string"},"description":"Alphanumeric ID allotted to an application (sales channel website) created within a business account","in":"path","required":true,"name":"application_id","examples":{"success":{"value":"000000000000000000000001"}}},{"schema":{"type":"string","enum":["android","ios"]},"description":"The device platform for which the mobile app is built, e.g. android, ios.","in":"path","required":true,"name":"platform_type"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MobileAppConfiguration"},"examples":{"success":{"value":{"is_active":true,"_id":"5ea9b318bc23a343ab6d442f","app_name":"TestUniket","landing_image":{"aspect_ratio":"57/51","secure_url":"https://hdn-1.addsale.com/x0/company/1/applications/000000000000000000000004/mobile-build/pictures/free-landing/original/yKnXY1ATx-store-landing-image.png"},"splash_image":{"aspect_ratio":"1/1","secure_url":"https://hdn-1.addsale.com/x0/company/1/applications/000000000000000000000004/mobile-build/pictures/free-splash/original/s6d7oYfY6-store-splash-image.png"},"application":"000000000000000000000001","platform_type":"android","created_at":"2020-04-29T17:02:16.976Z","modified_at":"2021-02-23T17:10:26.872Z","__v":0,"package_name":"com.fynd.store.x000000000000000000000004"}}}}}},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationFailedResponse"}}}}}},"put":{"description":"Modify the existing build configuration, such as app name, landing page image, splash image used in a mobile build.","summary":"updateBuildConfig | Update the configuration for next mobile build","tags":["Configuration"],"parameters":[{"schema":{"type":"integer"},"description":"Numeric ID allotted to a business account on Fynd Platform","in":"path","required":true,"name":"company_id","examples":{"success":{"value":2}}},{"schema":{"type":"string"},"description":"Alphanumeric ID allotted to an application (sales channel website) created within a business account","in":"path","required":true,"name":"application_id","examples":{"success":{"value":"000000000000000000000001"}}},{"schema":{"type":"string","enum":["android","ios"]},"description":"The device platform for which the mobile app is built, e.g. android, ios.","in":"path","required":true,"name":"platform_type"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MobileAppConfigRequest"},"examples":{"success":{"value":{"landing_image":{"aspect_ratio":"57/51","secure_url":"https://hdn-1.addsale.com/x0/company/1/applications/000000000000000000000004/mobile-build/pictures/free-landing/original/yKnXY1ATx-store-landing-image.png"},"splash_image":{"aspect_ratio":"1/1","secure_url":"https://hdn-1.addsale.com/x0/company/1/applications/000000000000000000000004/mobile-build/pictures/free-splash/original/s6d7oYfY6-store-splash-image.png"},"is_active":true}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MobileAppConfiguration"},"examples":{"success":{"value":{"is_active":true,"_id":"5ea9b318bc23a343ab6d442f","app_name":"TestUniket","landing_image":{"aspect_ratio":"57/51","secure_url":"https://hdn-1.addsale.com/x0/company/1/applications/000000000000000000000004/mobile-build/pictures/free-landing/original/yKnXY1ATx-store-landing-image.png"},"splash_image":{"aspect_ratio":"1/1","secure_url":"https://hdn-1.addsale.com/x0/company/1/applications/000000000000000000000004/mobile-build/pictures/free-splash/original/s6d7oYfY6-store-splash-image.png"},"application":"000000000000000000000001","platform_type":"android","created_at":"2020-04-29T17:02:16.976Z","modified_at":"2021-02-23T17:10:26.872Z","__v":0,"package_name":"com.fynd.store.x000000000000000000000001"}}}}}},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationFailedResponse"}}}}}}},"/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/build/{platform_type}/versions":{"get":{"description":"Fetch version details of the app, this includes the build status, build date, version name, latest version, and a lot more.","summary":"getPreviousVersions | Get details of previous mobile builds","tags":["Configuration"],"parameters":[{"schema":{"type":"integer"},"description":"Numeric ID allotted to a business account on Fynd Platform","in":"path","required":true,"name":"company_id","examples":{"success":{"value":2}}},{"schema":{"type":"string"},"description":"Alphanumeric ID allotted to an application (sales channel website) created within a business account","in":"path","required":true,"name":"application_id","examples":{"success":{"value":"000000000000000000000001"}}},{"schema":{"type":"string","enum":["android","ios"]},"description":"The device platform for which the mobile app is built, e.g. android, ios.","in":"path","required":true,"name":"platform_type"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuildVersionHistory"},"examples":{"success":{"value":{"versions":[{"_id":"6035376ab937c5f7c5462888","application":"000000000000000000000001","platform_type":"android","build_status":"pending","version_name":"0.5.6","download_url":{"secure_url":"http://test-bucket.s3.amazonaws.com/test-bucket/release/app-uniket-release.apk"},"version_code":1,"created_at":"2021-02-23T17:12:10.977Z","modified_at":"2021-02-23T17:12:10.977Z","__v":0}],"latest_available_version_name":"0.5.7"}}}}}},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationFailedResponse"}}}}}}},"/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/feature":{"get":{"description":"Shows feature configuration of sales channel websites, such as product detail, landing page, options in the login/registration screen, home page, listing page, reward points, communication opt-in, cart options and many more.","summary":"getAppFeatures | Get the sales channel configuration and features","tags":["Configuration"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppFeatureResponse"},"examples":{"success":{"value":{"feature":{"product_detail":{"similar":["basic","visual","brand","category","seller","price","specs"],"seller_selection":true,"update_product_meta":true,"request_product":true},"landing_page":{"launch_page":{"page_type":"home","params":{},"query":{}},"continue_as_guest":true,"login_btn_text":"Click here to sign-in","show_domain_textbox":true,"show_register_btn":true},"registration_page":{"ask_store_address":false},"home_page":{"order_processing":true},"common":{"communication_optin_dialog":{"visibility":true},"deployment_store_selection":{"enabled":true,"type":"hard"},"listing_price":{"value":"min","sort":"min"},"listing_page":{"sort_on":"popular"},"international_shipping":{"enabled":false},"currency":{"value":["INR"],"type":"explicit","default_currency":"INR"},"revenue_engine":{"enabled":false},"feedback":{"enabled":true},"compare_products":{"enabled":true},"reward_points":{"credit":{"enabled":true},"debit":{"enabled":true,"auto_apply":false,"strategy_channel":"REWARDS"}}},"cart":{"gst_input":true,"staff_selection":true,"placing_for_customer":true,"google_map":true,"revenue_engine_coupon":false},"qr":{"application":true,"products":true,"collections":true},"pcr":{"staff_selection":true},"order":{"buy_again":true},"_id":"5e57643c986e4119c973df7d","app":"000000000000000000000001","created_at":"2020-02-27T06:39:56.088Z","modified_at":"2021-02-02T11:04:14.289Z","__v":1}}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"value":{"message":"no feature found"}}}}}},"parameters":[{"schema":{"type":"integer"},"description":"Numeric ID allotted to a business account on Fynd Platform","in":"path","required":true,"name":"company_id","examples":{"success":{"value":2}}},{"schema":{"type":"string"},"description":"Alphanumeric ID allotted to an application (sales channel website) created within a business account","in":"path","required":true,"name":"application_id","examples":{"success":{"value":"000000000000000000000001"}}}]},"post":{"description":"Modify the feature configuration of sales channel websites, such as product detail, landing page, options in the login/registration screen, home page, listing page, reward points, communication opt-in, cart options and many more.","summary":"updateAppFeatures | Update the sales channel configuration and features","tags":["Configuration"],"requestBody":{"description":"Request body to save/update sales channel feature.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppFeatureRequest"},"examples":{"400":{"value":{"feature":"invalid data"}},"success":{"value":{"feature":{"product_detail":{"similar":["basic","visual","brand","category","seller","price","specs"],"seller_selection":true,"update_product_meta":true,"request_product":true},"landing_page":{"launch_page":{"page_type":"home","params":{},"query":{}},"continue_as_guest":true,"login_btn_text":"Click here to sign-in","show_domain_textbox":true,"show_register_btn":true},"registration_page":{"ask_store_address":false},"home_page":{"order_processing":true},"common":{"communication_optin_dialog":{"visibility":true},"deployment_store_selection":{"enabled":true,"type":"hard"},"listing_price":{"value":"min","sort":"min"},"currency":{"value":["INR"],"type":"explicit","default_currency":"INR"},"revenue_engine":{"enabled":false},"feedback":{"enabled":true},"compare_products":{"enabled":true},"reward_points":{"credit":{"enabled":true},"debit":{"enabled":true,"auto_apply":false,"strategy_channel":"REWARDS"}}},"cart":{"gst_input":true,"staff_selection":true,"placing_for_customer":true,"google_map":true,"revenue_engine_coupon":false},"qr":{"application":true,"products":true,"collections":true},"pcr":{"staff_selection":true},"order":{"buy_again":true},"app":"000000000000000000000001","created_at":"2020-02-27T06:39:56.088Z","modified_at":"2020-02-27T06:39:56.088Z","__v":0}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppFeature"},"examples":{"success":{"value":{"product_detail":{"similar":["basic","visual","brand","category","seller","price","specs"],"seller_selection":true,"update_product_meta":true,"request_product":true},"landing_page":{"launch_page":{"page_type":"home","params":{},"query":{}},"continue_as_guest":true,"login_btn_text":"Click here to sign-in","show_domain_textbox":true,"show_register_btn":true},"registration_page":{"ask_store_address":false},"home_page":{"order_processing":true},"common":{"communication_optin_dialog":{"visibility":true},"deployment_store_selection":{"enabled":true,"type":"hard"},"listing_price":{"value":"min","sort":"min"},"currency":{"value":["INR"],"type":"explicit","default_currency":"INR"},"revenue_engine":{"enabled":false},"feedback":{"enabled":true},"compare_products":{"enabled":true}},"cart":{"gst_input":true,"staff_selection":true,"placing_for_customer":true,"google_map":true,"revenue_engine_coupon":false},"qr":{"application":true,"products":true,"collections":true},"pcr":{"staff_selection":true},"order":{"buy_again":true},"_id":"5e57643c986e4119c973df7d","app":"000000000000000000000001","created_at":"2020-02-27T06:39:56.088Z","updated_at":"2021-03-09T15:40:29.188Z","__v":1}}}}}},"400":{"description":"Invalid request or Missing params","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidPayloadRequest"},"examples":{"400":{"value":{"message":"Invalid Params"}}}}}}},"parameters":[{"schema":{"type":"integer"},"description":"Numeric ID allotted to a business account on Fynd Platform","in":"path","required":true,"name":"company_id","examples":{"400":{"value":2},"success":{"value":2}}},{"schema":{"type":"string"},"description":"Alphanumeric ID allotted to an application (sales channel website) created within a business account","in":"path","required":true,"name":"application_id","examples":{"400":{"value":"000000000000000000000005"},"success":{"value":"000000000000000000000001"}}}]},"patch":{"description":"Update features of application","summary":"modifyAppFeatures | Update features of application","tags":["Configuration"],"requestBody":{"description":"Request body to save/update application feature.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppFeatureRequest"},"examples":{"400":{"value":{"feature":"invalid data"}},"success":{"value":{"feature":{"common":{"communication_optin_dialog":{"visibility":true}}}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppFeature"},"examples":{"success":{"value":{"product_detail":{"similar":["basic","visual","brand","category","seller","price","specs"],"seller_selection":true,"update_product_meta":true,"request_product":true},"landing_page":{"launch_page":{"page_type":"home","params":{},"query":{}},"continue_as_guest":true,"login_btn_text":"Click here to sign-in","show_domain_textbox":true,"show_register_btn":true},"registration_page":{"ask_store_address":false},"home_page":{"order_processing":true},"common":{"communication_optin_dialog":{"visibility":true},"deployment_store_selection":{"enabled":true,"type":"hard"},"listing_price":{"value":"min","sort":"min"},"currency":{"value":["INR"],"type":"explicit","default_currency":"INR"},"revenue_engine":{"enabled":false},"feedback":{"enabled":true},"compare_products":{"enabled":true}},"cart":{"gst_input":true,"staff_selection":true,"placing_for_customer":true,"google_map":true,"revenue_engine_coupon":false},"qr":{"application":true,"products":true,"collections":true},"pcr":{"staff_selection":true},"order":{"buy_again":true},"_id":"5e57643c986e4119c973df7d","app":"000000000000000000000001","created_at":"2020-02-27T06:39:56.088Z","modified_at":"2021-03-09T15:40:29.188Z","__v":1}}}}}},"400":{"description":"Invalid request or Missing params","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidPayloadRequest"},"examples":{"400":{"value":{"message":"Invalid Params"}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"value":{"message":"Invalid Params"}}}}}},"parameters":[{"schema":{"type":"integer"},"description":"Numeric ID allotted to a business account on Fynd Platform","in":"path","required":true,"name":"company_id","examples":{"400":{"value":2},"success":{"value":2}}},{"schema":{"type":"string"},"description":"Alphanumeric ID allotted to an application (sales channel website) created within a business account","in":"path","required":true,"name":"application_id","examples":{"400":{"value":"000000000000000000000003"},"success":{"value":"000000000000000000000001"}}}]}},"/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/detail":{"get":{"tags":["Configuration"],"summary":"getAppBasicDetails | Get sales channel details","description":"Shows basic sales channel details like name, description, logo, domain, company ID, and other related information.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationDetail"},"examples":{"success":{"value":{"name":"Uniket B2B","description":"Uniket B2B - India's Fastest Growing Retail Store - Aapki Badhti Dukaan","logo":{"secure_url":"https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/fyndnp/wrkr/x1/company/1/applications/000000000000000000000004/application/pictures/free-logo/original/oEf3SQjda-Uniket-B2B.png"},"mobile_logo":{"secure_url":"https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/fyndnp/wrkr/x1/company/1/applications/000000000000000000000004/application/pictures/free-logo/original/oEf3SQjda-Uniket-B2B.png"},"favicon":{"secure_url":"https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/fyndnp/wrkr/x1/company/1/applications/000000000000000000000004/application/pictures/favicon/original/y3h6SSlY5-Uniket-B2B.png"},"banner":{"secure_url":"https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/fyndnp/wrkr/x1/company/1/applications/000000000000000000000004/application/pictures/landscape-banner/original/uSwlNpygq-Uniket-B2B.png"},"domain":{"verified":true,"is_primary":true,"is_shortlink":false,"_id":"5eb1177748312a3bd55d0f1e","name":"uniket.hostfynd.dev"},"domains":[{"verified":true,"is_primary":true,"is_shortlink":false,"_id":"5eb1177748312a3bd55d0f1e","name":"uniket.hostfynd.dev"},{"verified":true,"is_primary":false,"is_shortlink":true,"_id":"5f0858c5f86e00cd42dccc8d","name":"jd.hostfynd.dev"}],"company_id":2,"slug":"test-mg1-36,","_id":"000000000000000000000001"}}}}}}},"parameters":[{"schema":{"type":"integer"},"description":"Numeric ID allotted to a business account on Fynd Platform","in":"path","required":true,"name":"company_id","examples":{"success":{"value":2}}},{"schema":{"type":"string"},"description":"Alphanumeric ID allotted to an application (sales channel website) created within a business account","in":"path","required":true,"name":"application_id","examples":{"success":{"value":"000000000000000000000001"}}}]},"put":{"tags":["Configuration"],"summary":"updateAppBasicDetails | Update sales channel details","description":"Modify sales channel details like name, description, logo, domain, company ID, and other related information.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationDetail"},"examples":{"success":{"value":{"name":"Uniket B2B","description":"Uniket B2B - India's Fastest Growing Retail Store - Aapki Badhti Dukaan","banner":{"secure_url":"https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/fyndnp/wrkr/x1/company/1/applications/000000000000000000000004/application/pictures/landscape-banner/original/uSwlNpygq-Uniket-B2B.png"},"logo":{"secure_url":"https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/fyndnp/wrkr/x1/company/1/applications/000000000000000000000004/application/pictures/free-logo/original/oEf3SQjda-Uniket-B2B.png"},"mobile_logo":{"secure_url":"https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/fyndnp/wrkr/x1/company/1/applications/000000000000000000000004/application/pictures/free-logo/original/oEf3SQjda-Uniket-B2B.png"},"favicon":{"secure_url":"https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/fyndnp/wrkr/x1/company/1/applications/000000000000000000000004/application/pictures/favicon/original/y3h6SSlY5-Uniket-B2B.png"}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationDetail"},"examples":{"success":{"value":{"name":"Uniket B2B","description":"Uniket B2B - India's Fastest Growing Retail Store - Aapki Badhti Dukaan","logo":{"secure_url":"https://hdn-1.addsale.com/x0/company/1/applications/000000000000000000000004/application/pictures/free-logo/original/oEf3SQjda-Uniket-B2B.png"},"mobile_logo":{"secure_url":"https://hdn-1.addsale.com/x0/company/1/applications/000000000000000000000004/application/pictures/free-logo/original/oEf3SQjda-Uniket-B2B.png"},"favicon":{"secure_url":"https://hdn-1.addsale.com/x0/company/1/applications/000000000000000000000004/application/pictures/favicon/original/y3h6SSlY5-Uniket-B2B.png"},"banner":{"secure_url":"https://hdn-1.addsale.com/x0/company/1/applications/000000000000000000000004/application/pictures/landscape-banner/original/uSwlNpygq-Uniket-B2B.png"},"domain":{"verified":true,"is_primary":true,"is_shortlink":false,"_id":"5eb1177748312a3bd55d0f1e","name":"uniket.hostfynd.dev"},"domains":[{"verified":true,"is_primary":true,"is_shortlink":false,"_id":"5eb1177748312a3bd55d0f1e","name":"uniket.hostfynd.dev"},{"verified":true,"is_primary":false,"is_shortlink":true,"_id":"5f0858c5f86e00cd42dccc8d","name":"jd.hostfynd.dev"}]}}}}}}},"parameters":[{"schema":{"type":"integer"},"description":"Numeric ID allotted to a business account on Fynd Platform","in":"path","required":true,"name":"company_id","examples":{"success":{"value":2}}},{"schema":{"type":"string"},"description":"Alphanumeric ID allotted to an application (sales channel website) created within a business account","in":"path","required":true,"name":"application_id","examples":{"success":{"value":"000000000000000000000001"}}}]}},"/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/information":{"get":{"description":"Fetch data such as social links, copyright text, business highlights, address and contact information of the company/seller/brand operating the application.","summary":"getAppContactInfo | Get current information of the sales channel","tags":["Configuration"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationInformation"},"examples":{"success":{"value":{"address":{"loc":{},"address_line":["Warehouse 5, Near Industrial Complex","2nd Lane, Andheri"],"phone":[{"code":"+91","number":"9988998899"}],"city":"Mumbai , Maharashtra , India","country":"India","pincode":400059},"support":{"phone":[],"email":[],"timing":"9 AM to 9 PM"},"social_links":{"facebook":{"title":"Facebook","icon":"https://hdn-1.fynd.com/system/svg/social-media/icon/original/hQAbAKdvHK-facebookfooteraopcjq.svg","link":""},"instagram":{"title":"Instagram","icon":"https://hdn-1.fynd.com/system/svg/social-media/icon/original/UZYsGWOqXp-instagramfooterl3utrr.svg","link":""},"twitter":{"title":"Twitter","icon":"https://hdn-1.fynd.com/system/svg/social-media/icon/original/oT2hW-BJjq-twitterfooternajsyr.svg","link":""},"pinterest":{"title":"Pinterest","icon":"https://hdn-1.fynd.com/system/svg/social-media/icon/original/v0erlcMk8p-pinterestfooternzmq4b.svg","link":""},"google_plus":{"title":"Google+","icon":"https://hdn-1.fynd.com/system/svg/social-media/icon/original/lw3Y5S58h4-googleplusysukr1.png","link":""},"youtube":{"title":"Youtube","icon":"https://hdn-1.fynd.com/system/svg/social-media/icon/original/EYV03PDST_-youtubefootermqhcr7.svg","link":""},"linked_in":{"title":"LinkedIn","icon":"https://hdn-1.fynd.com/system/svg/social-media/icon/original/qa7gx_bW9O-linkedinfooterrcr0yq.svg","link":""},"vimeo":{"title":"Vimeo","icon":"https://hdn-1.fynd.com/system/svg/social-media/icon/original/Ttc80b3U78-vimeofooternho4br.svg","link":""},"blog_link":{"title":"Blog","icon":"https://hdn-1.fynd.com/system/svg/social-media/icon/original/LKpxTk1I3s-mediumfooterdtvrva.svg","link":""}},"links":[{"title":"Shipping","link":"www.uniket.store/shipping-details"},{"title":"Returns","link":"www.uniket.store/policy/return-policy"},{"title":"Privacy","link":"www.uniket.store/policy/privacy-policy"},{"title":"Terms","link":"www.uniket.store/policy/terms-conditions"}],"copyright_text":"#MadeInIndia © 2020 Shopsense Retail Technologies","_id":"5e6627bd0732616083e83750","business_highlights":[{"_id":"5fc901611dfba6c2e87d1ca9","title":"Most Genuine Products","icon":"https://hdn-1.addsale.com/x0/company/1/applications/000000000000000000000004/business-highlights/pictures/square-logo/original/bVlx43F2a-H6pvZ9tzp-business-logo-icon.png","sub_title":"Directly from brands"},{"_id":"5fc901611dfba64ce57d1caa","title":"Credit Facility Available","icon":"https://hdn-1.addsale.com/x0/company/1/applications/000000000000000000000004/business-highlights/pictures/square-logo/original/VMnltS1m3-QuUnEjOsA-business-logo-icon.png","sub_title":"Free 30 Days Credit"},{"_id":"5fc901611dfba64b2e7d1cab","title":"Assured Returns","icon":"https://hdn-1.addsale.com/x0/company/1/applications/000000000000000000000004/business-highlights/pictures/square-logo/original/cTHzgHJXK-sROtLMalN-business-logo-icon.png","sub_title":"For all damaged/wrong items"}],"application":"000000000000000000000001","created_at":"2020-03-09T11:25:49.921Z","modified_at":"2020-12-03T15:16:49.087Z","__v":99}}}}}}},"parameters":[{"schema":{"type":"integer"},"description":"Numeric ID allotted to a business account on Fynd Platform","in":"path","required":true,"name":"company_id","examples":{"success":{"value":2}}},{"schema":{"type":"string"},"description":"Alphanumeric ID allotted to an application (sales channel website) created within a business account","in":"path","required":true,"name":"application_id","examples":{"success":{"value":"000000000000000000000001"}}}]},"put":{"description":"Modify the social links, copyright text, business highlights, address and contact information of the company/seller/brand operating the application.","summary":"updateAppContactInfo | Save or update current information of the sales channel","tags":["Configuration"],"requestBody":{"description":"Request body to save modified application information.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationInformation"},"examples":{"success":{"value":{"address":{"city":"Mumbai , Maharashtra , India","country":"India","pincode":400059,"phone":[{"code":"+91","number":"9988998899"}],"address_line":["Warehouse 5, Near Industrial Complex","2nd Lane, Andheri"]},"social_links":{"facebook":{"title":"Facebook","icon":"https://hdn-1.fynd.com/system/svg/social-media/icon/original/hQAbAKdvHK-facebookfooteraopcjq.svg","link":""},"instagram":{"title":"Instagram","icon":"https://hdn-1.fynd.com/system/svg/social-media/icon/original/UZYsGWOqXp-instagramfooterl3utrr.svg","link":""},"twitter":{"title":"Twitter","icon":"https://hdn-1.fynd.com/system/svg/social-media/icon/original/oT2hW-BJjq-twitterfooternajsyr.svg","link":""},"pinterest":{"title":"Pinterest","icon":"https://hdn-1.fynd.com/system/svg/social-media/icon/original/v0erlcMk8p-pinterestfooternzmq4b.svg","link":""},"google_plus":{"title":"Google+","icon":"https://hdn-1.fynd.com/system/svg/social-media/icon/original/lw3Y5S58h4-googleplusysukr1.png","link":""},"youtube":{"title":"Youtube","icon":"https://hdn-1.fynd.com/system/svg/social-media/icon/original/EYV03PDST_-youtubefootermqhcr7.svg","link":""},"linked_in":{"title":"LinkedIn","icon":"https://hdn-1.fynd.com/system/svg/social-media/icon/original/qa7gx_bW9O-linkedinfooterrcr0yq.svg","link":""},"vimeo":{"title":"Vimeo","icon":"https://hdn-1.fynd.com/system/svg/social-media/icon/original/Ttc80b3U78-vimeofooternho4br.svg","link":""},"blog_link":{"title":"Blog","icon":"https://hdn-1.fynd.com/system/svg/social-media/icon/original/LKpxTk1I3s-mediumfooterdtvrva.svg","link":""}},"links":[{"title":"Shipping","link":"www.uniket.store/shipping-details"},{"title":"Returns","link":"www.uniket.store/policy/return-policy"},{"title":"Privacy","link":"www.uniket.store/policy/privacy-policy"},{"title":"Terms","link":"www.uniket.store/policy/terms-conditions"}],"copyright_text":"#MadeInIndia © 2020 Shopsense Retail Technologies","support":{"email":[],"phone":[],"timing":"9 AM to 9 PM"},"business_highlights":[{"title":"Most Genuine Products","icon":"https://hdn-1.addsale.com/x0/company/1/applications/000000000000000000000004/business-highlights/pictures/square-logo/original/bVlx43F2a-H6pvZ9tzp-business-logo-icon.png","sub_title":"Directly from brands"},{"title":"Credit Facility Available","icon":"https://hdn-1.addsale.com/x0/company/1/applications/000000000000000000000004/business-highlights/pictures/square-logo/original/VMnltS1m3-QuUnEjOsA-business-logo-icon.png","sub_title":"Free 30 Days Credit"},{"title":"Assured Returns","icon":"https://hdn-1.addsale.com/x0/company/1/applications/000000000000000000000004/business-highlights/pictures/square-logo/original/cTHzgHJXK-sROtLMalN-business-logo-icon.png","sub_title":"For all damaged/wrong items"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationInformation"},"examples":{"success":{"value":{"_id":"5e6627bd0732616083e83750","address":{"address_line":["Warehouse 5, Near Industrial Complex","2nd Lane, Andheri"],"phone":[{"code":"+91","number":"9988998899"}],"city":"Mumbai , Maharashtra , India","country":"India","pincode":400059},"social_links":{"facebook":{"title":"Facebook","icon":"https://hdn-1.fynd.com/system/svg/social-media/icon/original/hQAbAKdvHK-facebookfooteraopcjq.svg","link":""},"instagram":{"title":"Instagram","icon":"https://hdn-1.fynd.com/system/svg/social-media/icon/original/UZYsGWOqXp-instagramfooterl3utrr.svg","link":""},"twitter":{"title":"Twitter","icon":"https://hdn-1.fynd.com/system/svg/social-media/icon/original/oT2hW-BJjq-twitterfooternajsyr.svg","link":""},"pinterest":{"title":"Pinterest","icon":"https://hdn-1.fynd.com/system/svg/social-media/icon/original/v0erlcMk8p-pinterestfooternzmq4b.svg","link":""},"google_plus":{"title":"Google+","icon":"https://hdn-1.fynd.com/system/svg/social-media/icon/original/lw3Y5S58h4-googleplusysukr1.png","link":""},"youtube":{"title":"Youtube","icon":"https://hdn-1.fynd.com/system/svg/social-media/icon/original/EYV03PDST_-youtubefootermqhcr7.svg","link":""},"linked_in":{"title":"LinkedIn","icon":"https://hdn-1.fynd.com/system/svg/social-media/icon/original/qa7gx_bW9O-linkedinfooterrcr0yq.svg","link":""},"blog_link":{"title":"Blog","icon":"https://hdn-1.fynd.com/system/svg/social-media/icon/original/LKpxTk1I3s-mediumfooterdtvrva.svg","link":""}},"links":[{"title":"Shipping","link":"www.uniket.store/shipping-details"},{"title":"Returns","link":"www.uniket.store/policy/return-policy"},{"title":"Privacy","link":"www.uniket.store/policy/privacy-policy"},{"title":"Terms","link":"www.uniket.store/policy/terms-conditions"}],"copyright_text":"#MadeInIndia © 2020 Shopsense Retail Technologies","support":{"timing":"9 AM to 9 PM","phone":[],"email":[],"business_highlights":[{"_id":"60479413a32f774d754b00ef","title":"Most Genuine Products","icon":"https://hdn-1.addsale.com/x0/company/1/applications/000000000000000000000004/business-highlights/pictures/square-logo/original/bVlx43F2a-H6pvZ9tzp-business-logo-icon.png","sub_title":"Directly from brands"},{"_id":"60479413a32f7717df4b00f0","title":"Credit Facility Available","icon":"https://hdn-1.addsale.com/x0/company/1/applications/000000000000000000000004/business-highlights/pictures/square-logo/original/VMnltS1m3-QuUnEjOsA-business-logo-icon.png","sub_title":"Free 30 Days Credit"},{"_id":"60479413a32f77e70b4b00f1","title":"Assured Returns","icon":"https://hdn-1.addsale.com/x0/company/1/applications/000000000000000000000004/business-highlights/pictures/square-logo/original/cTHzgHJXK-sROtLMalN-business-logo-icon.png","sub_title":"For all damaged/wrong items"}]},"application":"000000000000000000000001","created_at":"2020-03-09T11:25:49.921Z","modified_at":"2021-03-09T15:28:19.598Z","__v":101}}}}}}},"parameters":[{"schema":{"type":"integer"},"description":"Numeric ID allotted to a business account on Fynd Platform","in":"path","required":true,"name":"company_id","examples":{"success":{"value":2}}},{"schema":{"type":"string"},"description":"Alphanumeric ID allotted to an application (sales channel website) created within a business account","in":"path","required":true,"name":"application_id","examples":{"success":{"value":"000000000000000000000001"}}}]}},"/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/token":{"get":{"description":"Use this API to retrieve the tokens used for integrating Firebase, MoEngage, Segment, GTM, Freshchat, Safetynet, Google Map, Google, and Facebook auth. **Note** - Token values are encrypted with AES encryption using a secret key.","summary":"getAppApiTokens | Get social tokens for the sales channel","tags":["Configuration"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenResponse"},"examples":{"success":{"value":{"tokens":{"firebase":{"credentials":{"ios":{"application_id":"test","api_key":"test"},"android":{"application_id":"test","api_key":"test"},"project_id":"uniket-d8cdc","gcm_sender_id":"test","application_id":"test","api_key":"test"},"enabled":true},"moengage":{"credentials":{"app_id":"test"},"enabled":true},"segment":{"credentials":{"write_key":"test"},"enabled":true},"gtm":{"credentials":{"api_key":"test"},"enabled":false},"freshchat":{"credentials":{"app_id":"123456","app_key":"123456789","web_token":""},"enabled":false},"safetynet":{"credentials":{"api_key":"test"},"enabled":true},"fynd_rewards":{"credentials":{"public_key":"test"}},"google_map":{"credentials":{"api_key":"test"}}},"_id":"5e66282a073261060ee83751","application":"000000000000000000000001","created_at":"2020-03-09T11:27:38.894Z","modified_at":"2020-12-24T05:39:17.054Z","__v":0}}}}}}},"parameters":[{"schema":{"type":"integer"},"description":"Numeric ID allotted to a business account on Fynd Platform","in":"path","required":true,"name":"company_id","examples":{"success":{"value":2}}},{"schema":{"type":"string"},"description":"Alphanumeric ID allotted to an application (sales channel website) created within a business account","in":"path","required":true,"name":"application_id","examples":{"success":{"value":"000000000000000000000001"}}}]},"post":{"description":"Use this API to add or edit the tokens used for integrating Firebase, MoEngage, Segment, GTM, Freshchat, Safetynet, Google Map, Google and Facebook auth.","summary":"updateAppApiTokens | Add or update social tokens for the sales channel","tags":["Configuration"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenResponse"},"examples":{"400":{"value":{"tokens":"invalid data"}},"success":{"value":{"tokens":{"firebase":{"credentials":{"ios":{"application_id":"test","api_key":"test"},"android":{"application_id":"test","api_key":"test"},"project_id":"uniket-d8cdc","gcm_sender_id":"test","application_id":"test","api_key":"test"},"enabled":true},"moengage":{"credentials":{"app_id":"test"},"enabled":true},"segment":{"credentials":{"write_key":"test"},"enabled":true},"gtm":{"credentials":{"api_key":"1234567890"},"enabled":false},"freshchat":{"credentials":{"app_id":"123456","app_key":"123456789","web_token":""},"enabled":false},"safetynet":{"credentials":{"api_key":"test"},"enabled":true},"fynd_rewards":{"credentials":{"public_key":"test"}},"google_map":{"credentials":{"api_key":"test"}}},"_id":"5e66282a073261060ee83751","application":"000000000000000000000001","created_at":"2020-03-09T11:27:38.894Z","modified_at":"2020-12-24T05:39:17.054Z","__v":0}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenResponse"},"examples":{"success":{"value":{"tokens":{"firebase":{"credentials":{"ios":{"application_id":"test","api_key":"test"},"android":{"application_id":"test","api_key":"test"},"project_id":"uniket-d8cdc","gcm_sender_id":"test","application_id":"test","api_key":"test"},"enabled":true},"moengage":{"credentials":{"app_id":"test"},"enabled":true},"segment":{"credentials":{"write_key":"test"},"enabled":true},"gtm":{"credentials":{"api_key":"1234567890"},"enabled":false},"freshchat":{"credentials":{"app_id":"123456","app_key":"123456789","web_token":""},"enabled":false},"safetynet":{"credentials":{"api_key":"test"},"enabled":true},"fynd_rewards":{"credentials":{"public_key":"test"}},"auth":{"google":{"appId":"test"},"facebook":{"appId":"test"},"accountkit":{"appId":""}},"google_map":{"credentials":{"api_key":"test"}}},"_id":"5e66282a073261060ee83751","application":"000000000000000000000001","created_at":"2020-03-09T11:27:38.894Z","updated_at":"2020-12-24T05:39:17.054Z","__v":0}}}}}},"400":{"description":"Invalid request or Missing params","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidPayloadRequest"},"examples":{"400":{"value":{"message":"Invalid data"}}}}}}},"parameters":[{"schema":{"type":"integer"},"description":"Numeric ID allotted to a business account on Fynd Platform","in":"path","required":true,"name":"company_id","examples":{"400":{"value":2},"success":{"value":2}}},{"schema":{"type":"string"},"description":"Alphanumeric ID allotted to an application (sales channel website) created within a business account","in":"path","required":true,"name":"application_id","examples":{"400":{"value":"000000000000000000000005"},"success":{"value":"000000000000000000000001"}}}]}},"/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/companies":{"get":{"description":"Fetch info of all the companies (e.g. name, uid, and company type) whose inventory is fetched into the current sales channel application","summary":"getAppCompanies | Get companies enabled in the sales channel inventory","tags":["Configuration"],"parameters":[{"schema":{"type":"integer"},"description":"Numeric ID allotted to a business account on Fynd Platform","in":"path","required":true,"name":"company_id","examples":{"success":{"value":2}}},{"schema":{"type":"string"},"description":"Alphanumeric ID allotted to an application (sales channel website) created within a business account","in":"path","required":true,"name":"application_id","examples":{"success":{"value":"000000000000000000000001"}}},{"name":"uid","in":"query","schema":{"type":"integer"},"description":"UID of companies to be fetched","examples":{"success":{"value":1080}}},{"name":"page_no","in":"query","schema":{"type":"integer"},"description":"The current page number to navigate through the given set of results. Default value is 1.","examples":{"success":{"value":1}}},{"name":"page_size","in":"query","schema":{"type":"integer"},"description":"The number of items to retrieve in each page. Default value is 10.","examples":{"success":{"value":10}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompaniesResponse"},"examples":{"success":{"value":{"items":[{"uid":2,"name":"Sample2 Company","company_type":"mbo"}],"page":{"type":"number","size":200,"current":1,"has_next":false,"item_total":3}}}}}}}}}},"/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/stores":{"get":{"description":"Fetch info of all the companies (e.g. uid, name, display name, store type, store code and company id) whose inventory is fetched into the current sales channel application","summary":"getAppStores | Get stores enabled in the sales channel inventory","tags":["Configuration"],"parameters":[{"schema":{"type":"integer"},"description":"Numeric ID allotted to a business account on Fynd Platform","in":"path","required":true,"name":"company_id","examples":{"success":{"value":2}}},{"schema":{"type":"string"},"description":"Alphanumeric ID allotted to an application (sales channel website) created within a business account","in":"path","required":true,"name":"application_id","examples":{"success":{"value":"000000000000000000000001"}}},{"name":"page_no","in":"query","schema":{"type":"integer"},"description":"The current page number to navigate through the given set of results. Default value is 1.","examples":{"success":{"value":1}}},{"name":"page_size","in":"query","schema":{"type":"integer"},"description":"The number of items to retrieve in each page. Default value is 10.","examples":{"success":{"value":1}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoresResponse"},"examples":{"success":{"value":{"items":[{"id":"5ec2c0b168fc2800017112f5","uid":1,"name":"RRL01","display_name":"RRL01","store_type":"warehouse","store_code":"WH_8513","company_id":2,"address":{"country":"INDIA","address1":"76, GROUND FLOOR, R CITY MALL, GHATKOPAR WEST","city":"Mumbai","pincode":400086,"lat_long":{"type":"Point","coordinates":[72.916756,19.099478]},"state":"MAHARASHTRA"}}],"page":{"type":"number","size":200,"current":1,"has_next":true,"item_total":3}}}}}}}}}},"/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/configuration":{"get":{"description":"Use this API to fetch configuration details of authentication, inventory, article assignment rules, reward points, cart, payment, order, logistics, etc.","summary":"getInventoryConfig | Get sales channel configuration","tags":["Configuration"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationInventory"},"examples":{"success":{"value":{"inventory":{"brand":{"criteria":"all","brands":[]},"store":{"criteria":"filter","stores":[],"rules":[{"companies":[1,2,4],"brands":[]}]},"category":{"criteria":"all","categories":[]},"price":{"min":1,"max":10000},"discount":{"min":0,"max":100},"out_of_stock":true,"franchise_enabled":true,"exclude_category":[],"image":["standard","substandard","default"],"company_store":[]},"authentication":{"required":true,"provider":"fynd"},"article_assignment":{"rules":{"store_priority":{"enabled":false,"storetype_order":[]}},"post_order_reassignment":true},"reward_points":{"credit":{"enabled":true},"debit":{"enabled":true,"auto_apply":false,"strategy_channel":"rewards"}},"cart":{"delivery_charges":{"enabled":true},"charges":[{"threshold":1000,"charges":49},{"threshold":200000,"charges":79}],"international_delivery_charges":{"enabled":true,"charges":[{"threshold":1000,"charges":49},{"threshold":200000,"charges":79}]},"enabled":true,"max_cart_items":0,"min_cart_value":120,"bulk_coupons":true,"revenue_engine_coupon":false},"payment":{"callback_url":{"app":"","web":""},"methods":{"pl":{"enabled":true},"card":{"enabled":true},"nb":{"enabled":true},"wl":{"enabled":true},"ps":{"enabled":true},"upi":{"enabled":true},"qr":{"enabled":true},"cod":{"enabled":true},"pp":{"enabled":true},"jp":{"enabled":false},"pac":{"enabled":false},"fc":{"enabled":false},"jiopp":{"enabled":false},"stripepg":{"enabled":true},"juspaypg":{"enabled":false},"payubizpg":{"enabled":true},"payumoneypg":{"enabled":true},"rupifipg":{"enabled":false},"simpl":{"enabled":true}},"payment_selection_lock":{"enabled":false,"default_options":"","payment_identifier":""},"mode_of_payment":"uniket_b2b","source":"uniket","enabled":true,"cod_amount_limit":100000,"cod_charges":1500},"order":{"enabled":true,"force_reassignment":false},"logistics":{"logistics_by_seller":false,"serviceability_check":true,"same_day_delivery":true,"dp_assignment":true},"business":"retail","comms_enabled":true,"communication":{"email":{"enabled":false},"sms":{"enabled":false},"voice":{"enabled":false}},"platforms":["uniket_wholesale"],"_id":"5e04c76b8dd8c003577fdd0a","loyalty_points":{"enabled":true,"auto_apply":false},"app":"000000000000000000000001","created_at":"2019-12-26t14:44:59.835z","modified_at":"2021-03-09t15:40:29.208z","__v":3,"modified_by":"5e199eed98cfe16dc61385de"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"Configuration not found"}}}}},"parameters":[{"schema":{"type":"integer"},"description":"Numeric ID allotted to a business account on Fynd Platform","in":"path","required":true,"name":"company_id","examples":{"success":{"value":2}}},{"schema":{"type":"string"},"description":"Alphanumeric ID allotted to an application (sales channel website) created within a business account","in":"path","required":true,"name":"application_id","examples":{"success":{"value":"000000000000000000000001"}}}]},"put":{"description":"Modify the configuration details of authentication, inventory, article assignment rules, reward points, cart, payment, order, logistics, etc.","summary":"updateInventoryConfig | Update sales channel configuration","tags":["Configuration"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationInventory"},"examples":{"429":{"value":{"inventory":{"brand":{"criteria":"all","brands":[]},"store":{"criteria":"filter","stores":[],"rules":[{"companies":[1,3,4],"brands":[]}]},"category":{"criteria":"all","categories":[]},"price":{"min":1,"max":10000},"discount":{"min":0,"max":100},"out_of_stock":true,"franchise_enabled":true,"exclude_category":[],"image":["standard","substandard","default"],"company_store":[]},"authentication":{"required":true,"provider":"fynd"},"article_assignment":{"rules":{"store_priority":{"enabled":false,"storetype_order":[]}},"post_order_reassignment":true},"reward_points":{"credit":{"enabled":true},"debit":{"enabled":true,"auto_apply":false,"strategy_channel":"REWARDS"}},"cart":{"delivery_charges":{"enabled":true},"enabled":true,"max_cart_items":0,"min_cart_value":120,"bulk_coupons":true,"revenue_engine_coupon":false},"payment":{"callback_url":{"app":"","web":""},"methods":{"pl":{"enabled":true},"card":{"enabled":true},"nb":{"enabled":true},"wl":{"enabled":true},"ps":{"enabled":true},"upi":{"enabled":true},"qr":{"enabled":true},"cod":{"enabled":true},"pp":{"enabled":true},"jp":{"enabled":false},"pac":{"enabled":false},"fc":{"enabled":false},"jiopp":{"enabled":false},"stripepg":{"enabled":true},"juspaypg":{"enabled":false},"payubizpg":{"enabled":true},"payumoneypg":{"enabled":true},"rupifipg":{"enabled":false},"simpl":{"enabled":true}},"payment_selection_lock":{"enabled":false,"default_options":"","payment_identifier":""},"mode_of_payment":"UNIKET_B2B","source":"UNIKET","enabled":true,"cod_amount_limit":100000,"cod_charges":1500},"order":{"enabled":true,"force_reassignment":false},"logistics":{"logistics_by_seller":false,"serviceability_check":true,"same_day_delivery":true,"dp_assignment":true},"business":"retail","comms_enabled":true,"communication":{"email":{"enabled":false},"sms":{"enabled":false},"voice":{"enabled":false}},"platforms":["uniket_wholesale"],"_id":"5e04c76b8dd8c003577fdd0a","loyalty_points":{"enabled":true,"auto_apply":false},"app":"000000000000000000000001","created_at":"2019-12-26T14:44:59.835Z","modified_at":"2021-03-09T15:40:29.208Z","modified_by":"5e199eed98cfe16dc61385de"}},"success":{"value":{"inventory":{"brand":{"criteria":"all","brands":[]},"store":{"criteria":"filter","stores":[],"rules":[{"companies":[1,3,4],"brands":[]}]},"category":{"criteria":"all","categories":[]},"price":{"min":1,"max":10000},"discount":{"min":0,"max":100},"out_of_stock":true,"franchise_enabled":true,"exclude_category":[],"image":["standard","substandard","default"],"company_store":[]},"authentication":{"required":true,"provider":"fynd"},"article_assignment":{"rules":{"store_priority":{"enabled":false,"storetype_order":[]}},"post_order_reassignment":true},"reward_points":{"credit":{"enabled":true},"debit":{"enabled":true,"auto_apply":false,"strategy_channel":"REWARDS"}},"cart":{"delivery_charges":{"enabled":true},"international_delivery_charges":{"enabled":true,"charges":[{"threshold":1000,"charges":49},{"threshold":200000,"charges":79}]},"enabled":true,"max_cart_items":0,"min_cart_value":120,"bulk_coupons":true,"revenue_engine_coupon":false},"payment":{"callback_url":{"app":"","web":""},"methods":{"pl":{"enabled":true},"card":{"enabled":true},"nb":{"enabled":true},"wl":{"enabled":true},"ps":{"enabled":true},"upi":{"enabled":true},"qr":{"enabled":true},"cod":{"enabled":true},"pp":{"enabled":true},"jp":{"enabled":false},"pac":{"enabled":false},"fc":{"enabled":false},"jiopp":{"enabled":false},"stripepg":{"enabled":true},"juspaypg":{"enabled":false},"payubizpg":{"enabled":true},"payumoneypg":{"enabled":true},"rupifipg":{"enabled":false},"simpl":{"enabled":true}},"payment_selection_lock":{"enabled":false,"default_options":"","payment_identifier":""},"mode_of_payment":"UNIKET_B2B","source":"UNIKET","enabled":true,"cod_amount_limit":100000,"cod_charges":1500},"order":{"enabled":true,"force_reassignment":false},"logistics":{"logistics_by_seller":false,"serviceability_check":true,"same_day_delivery":true,"dp_assignment":true},"business":"retail","comms_enabled":true,"communication":{"email":{"enabled":false},"sms":{"enabled":false},"voice":{"enabled":false}},"platforms":["uniket_wholesale"],"_id":"652cfe52d25ec5b4acd798c3","loyalty_points":{"enabled":true,"auto_apply":false},"app":"000000000000000000000003","created_at":"2019-12-26T14:44:59.835Z","modified_at":"2021-03-09T15:40:29.208Z","modified_by":"5e199eed98cfe16dc61385de"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationInventory"},"examples":{"success":{"value":{"inventory":{"brand":{"criteria":"all","brands":[]},"store":{"criteria":"filter","stores":[],"rules":[{"companies":[1,3,4],"brands":[]}]},"category":{"criteria":"all","categories":[]},"price":{"min":1,"max":10000},"discount":{"min":0,"max":100},"out_of_stock":true,"franchise_enabled":true,"exclude_category":[],"image":["standard","substandard","default"],"company_store":[]},"authentication":{"required":true,"provider":"fynd"},"article_assignment":{"rules":{"store_priority":{"enabled":false,"storetype_order":[]}},"post_order_reassignment":true},"reward_points":{"credit":{"enabled":true},"debit":{"enabled":true,"auto_apply":false,"strategy_channel":"REWARDS"}},"cart":{"delivery_charges":{"enabled":true},"charges":[{"threshold":1000,"charges":49},{"threshold":200000,"charges":79}],"international_delivery_charges":{"enabled":true,"charges":[{"threshold":1000,"charges":49},{"threshold":200000,"charges":79}]},"enabled":true,"max_cart_items":0,"min_cart_value":120,"bulk_coupons":true,"revenue_engine_coupon":false},"payment":{"callback_url":{"app":"","web":""},"methods":{"pl":{"enabled":true},"card":{"enabled":true},"nb":{"enabled":true},"wl":{"enabled":true},"ps":{"enabled":true},"upi":{"enabled":true},"qr":{"enabled":true},"cod":{"enabled":true},"pp":{"enabled":true},"jp":{"enabled":false},"pac":{"enabled":false},"fc":{"enabled":false},"jiopp":{"enabled":false},"stripepg":{"enabled":true},"juspaypg":{"enabled":false},"payubizpg":{"enabled":true},"payumoneypg":{"enabled":true},"rupifipg":{"enabled":false},"simpl":{"enabled":true}},"payment_selection_lock":{"enabled":false,"default_options":"","payment_identifier":""},"mode_of_payment":"UNIKET_B2B","source":"UNIKET","enabled":true,"cod_amount_limit":100000,"cod_charges":1500},"order":{"enabled":true,"force_reassignment":false},"logistics":{"logistics_by_seller":false,"serviceability_check":true,"same_day_delivery":true,"dp_assignment":true},"business":"retail","comms_enabled":true,"communication":{"email":{"enabled":false},"sms":{"enabled":false},"voice":{"enabled":false}},"platforms":["uniket_wholesale"],"_id":"5e04c76b8dd8c003577fdd0a","loyalty_points":{"enabled":true,"auto_apply":false},"app":"000000000000000000000001","created_at":"2019-12-26T14:44:59.835Z","modified_at":"2021-03-09T15:40:29.208Z","__v":3,"modified_by":"5e199eed98cfe16dc61385de"}}}}}},"429":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidPayloadRequest"},"examples":{"429":{"value":{"message":"Wait for 3 mins before consecutive update"}}}}}}},"parameters":[{"schema":{"type":"integer"},"description":"Numeric ID allotted to a business account on Fynd Platform","in":"path","required":true,"name":"company_id","examples":{"429":{"value":2},"success":{"value":2}}},{"schema":{"type":"string"},"description":"Alphanumeric ID allotted to an application (sales channel website) created within a business account","in":"path","required":true,"name":"application_id","examples":{"429":{"value":"000000000000000000000001"},"success":{"value":"000000000000000000000003"}}}]},"patch":{"description":"Partially update the configuration details of authentication, inventory, article assignment rules, reward points, cart, payment, order, logistics, etc.","summary":"partiallyUpdateInventoryConfig | Partially update sales channel configuration","tags":["Configuration"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppInventoryPartialUpdate"},"examples":{"success":{"value":{"reward_points":{"credit":{"enabled":true},"debit":{"enabled":true,"auto_apply":false,"strategy_channel":"REWARDS"}},"cart":{"delivery_charges":{"enabled":true,"charges":[{"threshold":1000,"charges":49}]},"international_delivery_charges":{"enabled":true,"charges":[{"threshold":1000,"charges":49},{"threshold":200000,"charges":79}]},"enabled":true,"max_cart_items":0,"min_cart_value":120,"bulk_coupons":true,"revenue_engine_coupon":false},"payment":{"callback_url":{"app":"","web":""},"methods":{"pl":{"enabled":true},"card":{"enabled":true},"nb":{"enabled":true},"wl":{"enabled":true},"ps":{"enabled":true},"upi":{"enabled":true},"qr":{"enabled":true},"cod":{"enabled":true},"pp":{"enabled":true},"jp":{"enabled":false},"pac":{"enabled":false},"fc":{"enabled":false},"jiopp":{"enabled":false},"stripepg":{"enabled":true},"juspaypg":{"enabled":false},"payubizpg":{"enabled":true},"payumoneypg":{"enabled":true},"rupifipg":{"enabled":false},"simpl":{"enabled":true}},"payment_selection_lock":{"enabled":false,"default_options":"","payment_identifier":""},"mode_of_payment":"UNIKET_B2B","source":"UNIKET","enabled":true,"cod_amount_limit":100000,"cod_charges":1500},"comms_enabled":true,"communication":{"email":{"enabled":false},"sms":{"enabled":false},"voice":{"enabled":false}},"loyalty_points":{"enabled":true,"auto_apply":false}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationInventory"},"examples":{"success":{"value":{"inventory":{"brand":{"criteria":"all","brands":[]},"store":{"criteria":"filter","stores":[],"rules":[{"companies":[1,3,4],"brands":[]}]},"category":{"criteria":"all","categories":[]},"price":{"min":1,"max":10000},"discount":{"min":0,"max":100},"out_of_stock":true,"franchise_enabled":true,"exclude_category":[],"image":["standard","substandard","default"],"company_store":[]},"authentication":{"required":true,"provider":"fynd"},"article_assignment":{"rules":{"store_priority":{"enabled":false,"storetype_order":[]}},"post_order_reassignment":true},"reward_points":{"credit":{"enabled":true},"debit":{"enabled":true,"auto_apply":false,"strategy_channel":"REWARDS"}},"cart":{"delivery_charges":{"enabled":true},"charges":[{"threshold":1000,"charges":49},{"threshold":200000,"charges":79}],"international_delivery_charges":{"enabled":true,"charges":[{"threshold":1000,"charges":49},{"threshold":200000,"charges":79}]},"enabled":true,"max_cart_items":0,"min_cart_value":120,"bulk_coupons":true,"revenue_engine_coupon":false},"payment":{"callback_url":{"app":"","web":""},"methods":{"pl":{"enabled":true},"card":{"enabled":true},"nb":{"enabled":true},"wl":{"enabled":true},"ps":{"enabled":true},"upi":{"enabled":true},"qr":{"enabled":true},"cod":{"enabled":true},"pp":{"enabled":true},"jp":{"enabled":false},"pac":{"enabled":false},"fc":{"enabled":false},"jiopp":{"enabled":false},"stripepg":{"enabled":true},"juspaypg":{"enabled":false},"payubizpg":{"enabled":true},"payumoneypg":{"enabled":true},"rupifipg":{"enabled":false},"simpl":{"enabled":true}},"payment_selection_lock":{"enabled":false,"default_options":"","payment_identifier":""},"mode_of_payment":"UNIKET_B2B","source":"UNIKET","enabled":true,"cod_amount_limit":100000,"cod_charges":1500},"order":{"enabled":true,"force_reassignment":false},"logistics":{"logistics_by_seller":false,"serviceability_check":true,"same_day_delivery":true,"dp_assignment":true},"business":"retail","comms_enabled":true,"communication":{"email":{"enabled":false},"sms":{"enabled":false},"voice":{"enabled":false}},"platforms":["uniket_wholesale"],"_id":"5e04c76b8dd8c003577fdd0a","loyalty_points":{"enabled":true,"auto_apply":false},"app":"000000000000000000000001","created_at":"2019-12-26T14:44:59.835Z","modified_at":"2021-03-09T15:40:29.208Z","__v":3,"modified_by":"5e199eed98cfe16dc61385de"}}}}}}},"parameters":[{"schema":{"type":"integer"},"description":"Numeric ID allotted to a business account on Fynd Platform","in":"path","required":true,"name":"company_id","examples":{"success":{"value":2}}},{"schema":{"type":"string"},"description":"Alphanumeric ID allotted to an application (sales channel website) created within a business account","in":"path","required":true,"name":"application_id","examples":{"success":{"value":"000000000000000000000001"}}}]}},"/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/currency":{"get":{"description":"Get a list of currencies supported in the current sales channel. Moreover, get the cuurency that is set as the default one in the application.","summary":"getAppCurrencyConfig | Get currencies supported in the application","tags":["Configuration"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppSupportedCurrency"},"examples":{"success":{"value":{"_id":"5ec7a85965c3893857538d93","supported_currency":["5ec75d11f7bfb5a7d38f3524","5ec75d11f7bfb54d798f3516","5ec75d11f7bfb553b88f355f","5ec75d11f7bfb559d08f34d5","5ec75d11f7bfb5d1e98f34da"],"application":"000000000000000000000001","default_currency":{"ref":"5ec75d11f7bfb54d798f3516","code":"USD"},"created_at":"2020-05-22T10:24:25.984Z","modified_at":"2021-03-09T10:47:32.664Z"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"App currency not found"}}}}},"parameters":[{"schema":{"type":"integer"},"description":"Numeric ID allotted to a business account on Fynd Platform","in":"path","required":true,"name":"company_id","examples":{"success":{"value":2}}},{"schema":{"type":"string"},"description":"Alphanumeric ID allotted to an application (sales channel website) created within a business account","in":"path","required":true,"name":"application_id","examples":{"success":{"value":"000000000000000000000001"}}}]},"post":{"description":"Use this API to add and edit the currencies supported in the application. Initially, INR will be enabled by default.","summary":"updateAppCurrencyConfig | Update initial sales channel supported currency","tags":["Configuration"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppSupportedCurrency"},"examples":{"success":{"value":{"_id":"5ec7a85965c3893857538d93","supported_currency":["5ec75d11f7bfb5a7d38f3524","5ec75d11f7bfb54d798f3516","5ec75d11f7bfb553b88f355f","5ec75d11f7bfb559d08f34d5","5ec75d11f7bfb5d1e98f34da"],"application":"000000000000000000000001","default_currency":{"ref":"5ec75d11f7bfb54d798f3516","code":"USD"},"created_at":"2020-05-22T10:24:25.984Z","modified_at":"2021-03-09T10:47:32.664Z"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppSupportedCurrency"},"examples":{"success":{"value":{"_id":"5ec7a85965c3893857538d93","supported_currency":["5ec75d11f7bfb5a7d38f3524","5ec75d11f7bfb54d798f3516","5ec75d11f7bfb553b88f355f","5ec75d11f7bfb559d08f34d5","5ec75d11f7bfb5d1e98f34da"],"application":"000000000000000000000001","default_currency":{"ref":"5ec75d11f7bfb54d798f3516","code":"USD"},"created_at":"2020-05-22T10:24:25.984Z","modified_at":"2021-03-09T10:47:32.664Z"}}}}}}},"parameters":[{"schema":{"type":"integer"},"description":"Numeric ID allotted to a business account on Fynd Platform","in":"path","required":true,"name":"company_id","examples":{"success":{"value":2}}},{"schema":{"type":"string"},"description":"Alphanumeric ID allotted to an application (sales channel website) created within a business account","in":"path","required":true,"name":"application_id","examples":{"success":{"value":"000000000000000000000001"}}}]}},"/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/currency/supported":{"get":{"description":"Use this API to get a list of currencies allowed in the current application. Moreover, get the name, code, symbol, and the decimal digits of the currencies.","summary":"getAppSupportedCurrency | Get currencies enabled in the application","tags":["Configuration"],"responses":{"200":{"description":"Success. Check the example shown below or refer `AppCurrencyResponse` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppCurrencyResponse"},"examples":{"success":{"value":{"application":"000000000000000000000001","default_currency":{"ref":"5ecf6122d953d4242c044907","code":"INR"},"supported_currency":[{"_id":"5ecf6122d953d4242c044907","is_active":true,"name":"Indian Rupee","code":"INR","decimal_digits":2,"symbol":"₹","created_at":"2020-05-28T06:58:42.532Z","modified_at":"2021-04-05T16:44:14.358Z"}]}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"App currency not found"}}}}},"parameters":[{"schema":{"type":"integer"},"description":"Numeric ID allotted to a business account on Fynd Platform","in":"path","required":true,"name":"company_id","examples":{"success":{"value":2}}},{"schema":{"type":"string"},"description":"Alphanumeric ID allotted to an application (sales channel website) created within a business account","in":"path","required":true,"name":"application_id","examples":{"success":{"value":"000000000000000000000001"}}}]}},"/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/ordering-store/stores/filter":{"post":{"description":"Use this API to use filters and retrieve the details of the deployment stores (the selling locations where the application will be utilised for placing orders).","summary":"getOrderingStoresByFilter | Get ordering store by filter","tags":["Configuration"],"parameters":[{"schema":{"type":"integer"},"description":"Numeric ID allotted to a business account on Fynd Platform","in":"path","required":true,"name":"company_id","examples":{"success":{"value":2}}},{"schema":{"type":"string"},"description":"Alphanumeric ID allotted to an application (sales channel website) created within a business account","in":"path","required":true,"name":"application_id","examples":{"success":{"value":"000000000000000000000001"}}},{"name":"page_no","in":"query","schema":{"type":"integer"},"description":"The page number to navigate through the given set of results. Default value is 1."},{"name":"page_size","in":"query","schema":{"type":"integer"},"description":"The number of items to retrieve in each page. Default value is 10."}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FilterOrderingStoreRequest"},"examples":{"success":{"value":{"all_stores":true,"deployed_stores":[1,2],"q":"test store name"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderingStores"},"examples":{"success":{"value":{"page":{"type":"number","size":10,"current":1,"has_next":true,"item_total":583},"items":[{"address":{"state":"MAHARASHTRA","address1":"SAGAR TECH PLAZA, SAKINAKA","lat_long":{"type":"Point","coordinates":[1,1]},"pincode":400070,"country":"INDIA","city":"MUMBAI"},"_id":"5f586563f509dd000145c02d","store_type":"high_street","uid":11016,"store_code":"HS-0c532","display_name":" Brand Company Store 11","name":" Brand Company Store 11","pincode":400070,"code":"HS-0c532"},{"address":{"state":"MAHARASHTRA","address1":"UNNAMED ROAD, VASAI EAST SALT PLANT","lat_long":{"type":"Point","coordinates":[72.84293219999999,19.3805675]},"address2":"VASAI EAST SALT PLANT, VASAI EAST, ","pincode":401208,"country":"INDIA","city":"VIRAR","landmark":""},"_id":"5f585934f509dd000145c025","store_type":"high_street","uid":11567,"store_code":"123456","display_name":"2nd Store","name":"2nd Store","pincode":401208,"code":"123456"},{"address":{"state":"GUJARAT","address1":"32, AANAND SHOPPING CENTRE ","lat_long":{"type":"Point","coordinates":[1,1]},"pincode":380001,"country":"INDIA","city":"AHMEDABAD"},"_id":"5f587b5ef509dd000145c02f","store_type":"high_street","uid":11568,"store_code":"12345","display_name":"3rd ","name":"3rd ","pincode":380001,"code":"12345"}]}}}}}}}}},"/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/ordering-store":{"post":{"description":"Use this API to edit the details of the deployment stores (the selling locations where the application will be utilised for placing orders)","summary":"updateOrderingStoreConfig | Add/Update ordering store config","tags":["Configuration"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentMeta"},"examples":{"success":{"value":{"deployed_stores":[1,10],"all_stores":false,"enabled":true,"type":"hard","_id":"5e7e5e4d6b5f3b4b54c95f9c","app":"000000000000000000000001"}}}}}},"400":{"description":"Invalid/Missing params","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidPayloadRequest"},"examples":{"400":{"value":{"message":"Invalid Params"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"no deployment meta found"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderingStoreConfig"},"examples":{"400":{"value":{"deployment_meta":"invalid data"}},"success":{"value":{"deployment_meta":{"deployed_stores":[1,10],"all_stores":false,"enabled":true,"type":"hard","app":"000000000000000000000001"}}}}}}},"parameters":[{"schema":{"type":"integer"},"description":"Numeric ID allotted to a business account on Fynd Platform","in":"path","required":true,"name":"company_id","examples":{"400":{"value":2},"success":{"value":2}}},{"schema":{"type":"string"},"description":"Alphanumeric ID allotted to an application (sales channel website) created within a business account","in":"path","required":true,"name":"application_id","examples":{"400":{"value":"000000000000000000000001"},"success":{"value":"000000000000000000000001"}}}]},"get":{"description":"Fetch the details of the deployment stores (the selling locations where the application will be utilised for placing orders).","summary":"getOrderingStoreConfig | Get ordering store config","tags":["Configuration"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderingStoreConfig"},"examples":{"success":{"value":{"deployment_meta":{"deployed_stores":[1,10],"all_stores":false,"enabled":true,"type":"hard","_id":"5e7e5e4d6b5f3b4b54c95f9c","app":"000000000000000000000001"}}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"no deployment meta found"}}}}},"parameters":[{"schema":{"type":"integer"},"description":"Numeric ID allotted to a business account on Fynd Platform","in":"path","required":true,"name":"company_id","examples":{"success":{"value":2}}},{"schema":{"type":"string"},"description":"Alphanumeric ID allotted to an application (sales channel website) created within a business account","in":"path","required":true,"name":"application_id","examples":{"success":{"value":"000000000000000000000001"}}}]}},"/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/ordering-store/staff-stores":{"get":{"description":"Use this API to retrieve the details of all stores access given to the staff member (the selling locations where the application will be utilized for placing orders).","summary":"getStaffOrderingStores | Get deployment stores","tags":["Configuration"],"parameters":[{"schema":{"type":"integer"},"description":"Numeric ID allotted to a business account on Fynd Platform","in":"path","required":true,"name":"company_id","examples":{"success":{"value":2}}},{"schema":{"type":"string"},"description":"Alphanumeric ID allotted to an application (sales channel website) created within a business account","in":"path","required":true,"name":"application_id","examples":{"success":{"value":"000000000000000000000001"}}},{"name":"page_no","in":"query","schema":{"type":"integer"},"description":"The page number to navigate through the given set of results. Default value is 1."},{"name":"page_size","in":"query","schema":{"type":"integer"},"description":"The number of items to retrieve in each page. Default value is 10."},{"name":"q","in":"query","schema":{"type":"string"},"description":"Store code or name of the ordering store."}],"responses":{"200":{"description":"Success. Check the example shown below or refer `OrderingStoresResponse` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderingStoresResponse"},"examples":{"success":{"value":{"uid":10}}}}}}}}},"/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/ordering-store/select":{"post":{"description":"Use this API to get an Ordering Store signed cookie upon selecting an ordering store. This will be used by the cart service to verify a coupon against the selected ordering store in cart.","summary":"getOrderingStoreCookie | Get an Ordering Store signed cookie on selection of ordering store.","tags":["Configuration"],"parameters":[{"schema":{"type":"integer"},"description":"Numeric ID allotted to a business account on Fynd Platform","in":"path","required":true,"name":"company_id","examples":{"400":{"value":2},"success":{"value":2}}},{"schema":{"type":"string"},"description":"Alphanumeric ID allotted to an application (sales channel website) created within a business account","in":"path","required":true,"name":"application_id","examples":{"400":{"value":"000000000000000000000001"},"success":{"value":"000000000000000000000001"}}}],"requestBody":{"description":"Pass the UID of the ordering store in the request body as shown below.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderingStoreSelectRequest"},"examples":{"400":{"value":{"ordering_store":{"uid":99}}},"success":{"value":{"ordering_store":{"uid":1}}}}}}},"responses":{"200":{"description":"Success","headers":{"set-cookie":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessMessageResponse"},"examples":{"success":{"value":{"message":"success"}}}}}},"400":{"description":"API Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"examples":{"400":{"value":{"message":"store not found"}}}}}}}},"delete":{"description":"Use this API to unset the Ordering Store cookie upon changing the sales channel, by its domain URL, in the Universal Fynd Store app.","summary":"removeOrderingStoreCookie | Unset the Ordering Store signed cookie.","tags":["Configuration"],"parameters":[{"schema":{"type":"integer"},"description":"Numeric ID allotted to a business account on Fynd Platform","in":"path","required":true,"name":"company_id","examples":{"success":{"value":2}}},{"schema":{"type":"string"},"description":"Alphanumeric ID allotted to an application (sales channel website) created within a business account","in":"path","required":true,"name":"application_id","examples":{"success":{"value":"000000000000000000000001"}}}],"responses":{"200":{"description":"Success","headers":{"set-cookie":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessMessageResponse"},"examples":{"success":{"value":{"message":"success"}}}}}}}}},"/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/domain":{"get":{"summary":"getDomains | Fetch all the domains added to an  application (sales channel website), including pre-defined domain (free domain) or custom domain (owned by the brand). Know the verification status of each domain name, and find out which one is the primary domain, short link domain, or both.","description":"Get list of domains","tags":["Configuration"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DomainsResponse"},"examples":{"success":{"value":{"domains":[{"_id":"5eb1177748312a3bd55d0f1e","verified":true,"name":"uniket.hostfynd.dev","is_primary":true,"is_shortlink":false,"is_predefined":true},{"verified":true,"is_primary":false,"is_shortlink":true,"_id":"5f0858c5f86e00cd42dccc8d","name":"jd.hostfynd.dev","is_predefined":true},{"verified":true,"is_primary":false,"is_shortlink":false,"_id":"6048497e87f5730423149190","name":"testdm.hostfynd.dev","is_predefined":true}]}}}}}}},"parameters":[{"schema":{"type":"integer"},"description":"Numeric ID allotted to a business account on Fynd Platform","in":"path","required":true,"name":"company_id","examples":{"success":{"value":2}}},{"schema":{"type":"string"},"description":"Alphanumeric ID allotted to an application (sales channel website) created within a business account","in":"path","required":true,"name":"application_id","examples":{"success":{"value":"000000000000000000000001"}}}]},"post":{"description":"Add a new domain to current sales channel, including pre-defined domain (free domain) or custom domain (owned by the brand)","summary":"addDomain | Add new domain to current sales channel","tags":["Configuration"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DomainAddRequest"},"examples":{"success":{"value":{"domain":{"name":"testdm.hostfynd.dev"}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Domain"},"examples":{"success":{"value":{"name":"testdm.hostfynd.dev","verified":true,"message":"New domain added successfully","is_primary":false,"is_shortlink":false,"_id":"6048497e87f5730423149190"}}}}}},"400":{"description":"Invalid request or Missing params","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidPayloadRequest"},"example":{"Maximum domain limit reached":{"value":{"message":"Maximum 4 domains can be added to application. Please remove existing one to add new"}},"Failed to verify domain record":{"value":{"message":"Failed to verify domain records"}},"Domain already registered":{"value":{"message":"Domain already linked to application"}}}}}}},"parameters":[{"schema":{"type":"integer"},"description":"Numeric ID allotted to a business account on Fynd Platform","in":"path","required":true,"name":"company_id","examples":{"success":{"value":2}}},{"schema":{"type":"string"},"description":"Alphanumeric ID allotted to an application (sales channel website) created within a business account","in":"path","required":true,"name":"application_id","examples":{"success":{"value":"000000000000000000000001"}}}]}},"/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/domain/{id}":{"delete":{"summary":"removeDomainById | Remove attached domain from current sales channel","description":"Delete a domain (secondary or shortlink domain) added to a sales channel. It will disable user's access to website, shared links, and other features associated with this domain.","tags":["Configuration"],"parameters":[{"schema":{"type":"integer"},"description":"Numeric ID allotted to a business account on Fynd Platform","in":"path","required":true,"name":"company_id","examples":{"success":{"value":2}}},{"schema":{"type":"string"},"description":"Alphanumeric ID allotted to an application (sales channel website) created within a business account","in":"path","required":true,"name":"application_id","examples":{"success":{"value":"000000000000000000000001"}}},{"name":"id","in":"path","required":true,"description":"The unique identifier (24-digit Mongo Object ID) of the domain","schema":{"type":"string"},"examples":{"404":{"value":"652c0a61d25ec5b4acd798c2"},"success":{"value":"5caf4f967583794673424d77"},"Primary or Default domain deletiion":{"value":"65265de8ba12e07731880aec"},"Shortlink or Default domain deletiion":{"value":"65265de8ba12e07731880aec"}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessMessageResponse"},"examples":{"success":{"value":{"message":"Domain removed successfully"}}}}}},"400":{"description":"Invalid request or Missing params","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidPayloadRequest"},"examples":{"Primary or Default domain deletiion":{"value":{"message":"Primary domain deletion not allowed"}},"Shortlink or Default domain deletiion":{"value":{"message":"Shortlink domain deletion not allowed"}}}}}},"404":{"description":"Invalid/Missing params","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"examples":{"404":{"value":{"message":"Domain with given id not found"}}}}}}}}},"/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/domain/set-domain":{"post":{"description":"Primary domain is used as the URL of your website. Short link domain is comparatively smaller and used while generating short links. Use this API to change a domain to either Primary or a Shortlink domain.","summary":"changeDomainType | Change the type of domain in the current sales channel","tags":["Configuration"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateDomainTypeRequest"},"examples":{"404":{"value":{"domain":{"_id":"652c0a61d25ec5b4acd798c2"},"action":"shortlink"}},"success":{"value":{"domain":{"_id":"65265de8ba12e07731880aec"},"action":"shortlink"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DomainsResponse"},"examples":{"success":{"value":{"domains":[{"_id":"5eb1177748312a3bd55d0f1e","verified":true,"name":"uniket.hostx0.de","is_primary":true,"is_shortlink":false},{"verified":true,"is_primary":false,"is_shortlink":true,"_id":"5f0858c5f86e00cd42dccc8d","name":"jd.hostx0.de"},{"verified":true,"is_primary":false,"is_shortlink":false,"_id":"6048497e87f5730423149190","name":"testdm.hostx0.de"}]}}}}}},"404":{"description":"Invalid/Missing params","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"examples":{"404":{"value":{"message":"Domain with given id not found"}}}}}}},"parameters":[{"schema":{"type":"integer"},"description":"Numeric ID allotted to a business account on Fynd Platform","in":"path","required":true,"name":"company_id","examples":{"404":{"value":2},"success":{"value":2}}},{"schema":{"type":"string"},"description":"Alphanumeric ID allotted to an application (sales channel website) created within a business account","in":"path","required":true,"name":"application_id","examples":{"404":{"value":"000000000000000000000001"},"success":{"value":"000000000000000000000001"}}}]}},"/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/domain/domain-status":{"post":{"description":"Shows if the A records and TXT records of the domain correctly points to appropriate IP on Fynd Servers.","summary":"getDomainStatus | Get the status of connected domain","tags":["Configuration"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DomainStatusRequest"},"examples":{"success":{"value":{"domain_url":"testdms.hostfynd.dev"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DomainStatusResponse"},"examples":{"success":{"value":{"connected":true,"status":[{"display":"Domain TXT record entry 5d65089e031f9029f8e8dc2f","status":true},{"display":"Domain pointing to 18.217.232.69 A record","status":true},{"display":"Domain pointing to 18.188.115.251 A record","status":true}]}}}}}}},"parameters":[{"schema":{"type":"integer"},"description":"Numeric ID allotted to a business account on Fynd Platform","in":"path","required":true,"name":"company_id","examples":{"success":{"value":2}}},{"schema":{"type":"string"},"description":"Alphanumeric ID allotted to an application (sales channel website) created within a business account","in":"path","required":true,"name":"application_id","examples":{"success":{"value":"000000000000000000000001"}}}]}},"/service/platform/configuration/v1.0/company/{company_id}/application":{"post":{"description":"Applications are sales channel websites which can be configured, personalized and customized. Use this API to create a new application in the current company.","summary":"createApplication | Create a new sales channel","tags":["Configuration"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateApplicationRequest"},"examples":{"success":{"value":{"app":{"company_id":"363","channel_type":"website-and-mobile-apps","auth":{"enabled":true},"name":"test","desc":""},"configuration":{"payment":{"mode_of_payment":"ECOMM","source":"ECOMM"},"article_assignment":{"post_order_reassignment":true,"rules":{"store_priority":{"enabled":false,"storetype_order":[]}}},"inventory":{"brand":{"criteria":"explicit","brands":[2,3]},"store":{"criteria":"filter","rules":[{"companies":[1,2],"brands":[2,3]}],"stores":[]},"image":["standard","substandard","default"],"franchise_enabled":true}},"domain":{"name":"testdigital.hostfynd.dev"}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAppResponse"},"examples":{"success":{"value":{"app":{"name":"testing"}}}}}}},"400":{"description":"Invalid request or Missing params","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidPayloadRequest"},"example":{"Maximum domain limit reached":{"value":{"message:\" You have crossed the maximum limit of creating applications. Contact support.\"":null}},"Domain already registered":{"value":{"domain":{"message":"Domain already linked to application","name":"domainInfo.name"}}},"Domain verification failed":{"value":{"domain":{"error":"domain verification failed"}}}}}}}},"parameters":[{"schema":{"type":"integer"},"description":"Numeric ID allotted to a business account on Fynd Platform","in":"path","required":true,"name":"company_id","examples":{"success":{"value":2}}}]},"get":{"description":"Applications are sales channel websites which can be configured, personalized and customised. Use this API to fetch a list of applications created within a company.","summary":"getApplications | Get list of registered sales channels under company","tags":["Configuration"],"parameters":[{"schema":{"type":"integer"},"description":"Numeric ID allotted to a business account on Fynd Platform","in":"path","required":true,"name":"company_id","examples":{"success":{"value":2}}},{"in":"query","name":"page_no","schema":{"type":"integer"}},{"name":"page_size","schema":{"type":"integer"},"in":"query"},{"name":"q","schema":{"type":"string"},"in":"query","description":"Search param by name or domain"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationsResponse"},"examples":{"success":{"value":{"app":{"name":"testing","company_id":2}}}}}}}}}},"/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}":{"get":{"description":"Use application ID to get the current sales channel details which includes channel name, description, banner, logo, favicon, domain details, token, etc.","summary":"getApplicationById | Get sales channel data by ID","tags":["Configuration"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Application"},"examples":{"success":{"value":{"company_id":2,"name":"test"}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"examples":{"404":{"value":{"message":"Not Found"}}}}}}},"parameters":[{"schema":{"type":"integer"},"description":"Numeric ID allotted to a business account on Fynd Platform","in":"path","required":true,"name":"company_id","examples":{"404":{"value":2},"success":{"value":2}}},{"schema":{"type":"string"},"description":"Alphanumeric ID allotted to an application (sales channel website) created within a business account","in":"path","required":true,"name":"application_id","examples":{"404":{"value":"000000000000000000000005"},"success":{"value":"000000000000000000000001"}}}]}},"/service/platform/configuration/v1.0/company/{company_id}/currencies":{"get":{"description":"Use this API to get a list of currencies allowed in the company. Moreover, get the name, code, symbol, and the decimal digits of the currencies.","summary":"getCurrencies | Get all currencies","tags":["Configuration"],"responses":{"200":{"description":"Currencies Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CurrenciesResponse"},"examples":{"success":{"value":{"items":[{"_id":"5ec75d11f7bfb54d798f3516","is_active":true,"name":"United States Dollar","code":"USD","created_at":"2020-05-22T05:03:13.354Z","updated_at":"2020-06-05T09:12:04.248Z","decimal_digits":2,"symbol":"$"}]}}}}}}},"parameters":[{"schema":{"type":"integer"},"description":"Numeric ID allotted to a business account on Fynd Platform","in":"path","required":true,"name":"company_id","examples":{"success":{"value":2}}}]}},"/service/platform/configuration/v1.0/company/{company_id}/domain/suggestions":{"post":{"description":"Use this API to check the domain availability before linking it to application. Also sends domain suggestions that are similar to the queried domain. Note - Custom domain search is currently powered by GoDaddy provider.","summary":"getDomainAvailibility | Check domain availability before linking to application","tags":["Configuration"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DomainSuggestionsRequest"},"examples":{"success":{"value":{"domain_url":"test25.in","custom":true}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DomainSuggestionsResponse"},"examples":{"success":{"value":{"Suggestions for fynd domains":{"value":{"domains":[{"name":"test.hostx1.de","is_available":false},{"name":"testhive.hostx1.de","is_available":true}]}},"Suggestions for custom domains":{"value":{"domains":[{"name":"test25.in","unsupported":false,"is_available":false},{"name":"try25.in","unsupported":false,"is_available":true,"price":14.99,"currency":"USD"}]}}}}}}}}},"parameters":[{"schema":{"type":"integer"},"description":"Numeric ID allotted to a business account on Fynd Platform","in":"path","required":true,"name":"company_id","examples":{"success":{"value":2}}}]}},"/service/platform/configuration/v1.0/company/{company_id}/integration/{id}":{"get":{"description":"Use this API to fetch the details of an integration (such as Ginesys, SAP, etc.) using its ID","summary":"getIntegrationById | Get integration data by its ID","tags":["Configuration"],"parameters":[{"schema":{"type":"integer"},"description":"Numeric ID allotted to a business account on Fynd Platform","in":"path","required":true,"name":"company_id","examples":{"404":{"value":2},"success":{"value":2}}},{"name":"id","in":"path","schema":{"type":"string"},"description":"Integration id","required":true,"examples":{"404":{"value":"652c0a61d25ec5b4acd798c2"},"success":{"value":"6524d9e195f3c8e3d36b6977"}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Integration"},"examples":{"success":{"value":{"_id":"5ec376ce848a005189acb312","validators":{"company":{"browser_script":"","json_schema":[{"type":"object"},{"required":["ip_address","icode","gds_entity_id","auth_key"]},{"properties":null,"gds_entity_id":{"type":"string","title":"GDS Entity ID","minLength":3,"maxLength":10,"pattern":"^[a-zA-Z0-9]+$","description":"GDS Entity ID is a unique identifier provided by Ginesys to you."},"ip_address":{"type":"string","title":"IP Address","pattern":"(\\d{1,3}\\.){3}\\d{1,3}","description":"Enter IP address provided by Ginesys for your POS server"},"auth_key":{"title":"Auth Key","type":"string","maxLength":500,"description":"Provide authentication token provided by Ginesys to you."},"icode":{"title":"ICODE","type":"string","enum":["ean","upc","alu","sku_code"],"description":"Please select the correct SKU identifier that you use to provide inventory to Fynd."}}]},"store":{"browser_script":"","json_schema":[{"type":"object"},{"properties":null,"location_id":{"type":"string","title":"Location ID","description":"Provide site code as per POS/SAP."},"ip_address":{"type":"string","title":"IP Address","pattern":"(\\d{1,3}\\.){3}\\d{1,3}","description":"Enter IP address provided by Ginesys for your POS server"}}]}},"description":"Sap Integration west ELM brands","constants":{},"name":"SAP RBL Integration","meta":[{"public":true,"_id":"5ee3e246129be17ce0b59ef4","name":"price_level","value":"store"}],"icon":"https://res.cloudinary.com/dwzm9bysq/image/upload/v1589868232/addsale/platform/integrations/icon/z3kj9p8nidx4zzmdutdu.svg","owner":"5e60e43dcd08cf01069eb23e","created_at":"2020-05-19T06:03:58.757Z","updated_at":"2020-06-15T12:00:42.598Z","token":"qk60vXqk-","secret":"Gp0dYInpUV","__v":13,"description_html":""}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"examples":{"404":{"value":{"message":"not found"}}}}}}}}},"/service/platform/configuration/v1.0/company/{company_id}/integration-opt-in/available":{"get":{"description":"Use this API to get a list of all available integrations in a company","summary":"getAvailableOptIns | Get all available integration opt-ins","tags":["Configuration"],"parameters":[{"schema":{"type":"integer"},"description":"Numeric ID allotted to a business account on Fynd Platform","in":"path","required":true,"name":"company_id","examples":{"success":{"value":2}}},{"name":"page_no","in":"query","schema":{"type":"integer"},"description":"The page number to navigate through the given set of results. Default value is 1."},{"name":"page_size","in":"query","schema":{"type":"integer"},"description":"The number of items to retrieve in each page. Default value is 10."}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetIntegrationsOptInsResponse"},"examples":{"success":{"value":{"items":[{"validators":{"company":{"json_schema":[{"display":"Host","key":"host","type":"text","tooltip":"Enter host address"}],"browser_script":""},"store":{"json_schema":[],"browser_script":""},"inventory":{"json_schema":[],"browser_script":""},"order":{"json_schema":[],"browser_script":""}},"description":"awesome integration","description_html":"","constants":"{\"mop_mapping\":{\"FYND\":\"FYND\"}}","companies":[],"support":["inventory","order"],"_id":"5e56089f4265cf2846d1e58c","name":"x0-1","meta":[{"public":true,"_id":"5e56089f4265cf81e1d1e58e","name":"wow","value":"1"}],"icon":"https://res.cloudinary.com/dwzm9bysq/image/upload/v1582696589/addsale/platform/integrations/icon/jihgcoibfmdttgiukwg0.png","owner":"5e55fe074bda3c392ed9eab2","created_at":"2020-02-26T05:56:47.214Z","updated_at":"2021-03-02T12:29:03.554Z","token":"fKoHRW5H","secret":"d1E85CTmf","__v":12},{"validators":{"company":{"json_schema":[],"browser_script":""},"store":{"json_schema":[],"browser_script":""},"inventory":{"json_schema":[],"browser_script":""},"order":{"json_schema":[],"browser_script":""}},"description":"jabardast","description_html":"","constants":"{\"mop_mapping\":{\"FYND\":\"FYND\"}}","companies":[],"support":["inventory","order"],"_id":"5e5608bf4265cf7198d1e58f","name":"x0-2","meta":[{"public":false,"_id":"5e5608bf4265cf813fd1e590","name":"wow","value":"1"}],"icon":"https://res.cloudinary.com/dwzm9bysq/image/upload/v1582696633/addsale/platform/integrations/icon/cstvvkgjgip1ja56gq4x.png","owner":"5e55fe074bda3c392ed9eab2","created_at":"2020-02-26T05:57:19.875Z","updated_at":"2021-02-15T05:23:55.962Z","token":"3h3_mnzp","secret":"dgGHrIlFG","__v":7}],"page":{"type":"number","current":1,"size":50,"item_total":24,"has_next":false}}}}}}}}}},"/service/platform/configuration/v1.0/company/{company_id}/integration-opt-in/selected/{level}/{uid}":{"get":{"description":"Use this API to get the store-level/company-level integrations configured in a company","summary":"getSelectedOptIns | Get company/store level integration opt-ins","tags":["Configuration"],"parameters":[{"schema":{"type":"integer"},"description":"Numeric ID allotted to a business account on Fynd Platform","in":"path","required":true,"name":"company_id","examples":{"success":{"value":2}}},{"name":"level","in":"path","schema":{"type":"string"},"description":"store or company","required":true,"examples":{"success":{"value":"store"}}},{"name":"uid","in":"path","schema":{"type":"integer"},"description":"Unique identifier of the selected integration level.","required":true,"examples":{"success":{"value":2}}},{"name":"page_no","in":"query","schema":{"type":"integer"},"description":"The page number to navigate through the given set of results. Default value is 1."},{"name":"page_size","in":"query","schema":{"type":"integer"},"description":"The number of items to retrieve in each page. Default value is 10."}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetIntegrationsOptInsResponse"},"examples":{"success":{"value":{"items":[{"validators":{"company":{"json_schema":[{"display":"Host","key":"host","type":"text","tooltip":"Enter host address"}],"browser_script":""},"store":{"json_schema":[],"browser_script":""},"inventory":{"json_schema":[],"browser_script":""},"order":{"json_schema":[],"browser_script":""}},"description":"awesome integration","description_html":"","constants":"{\"mop_mapping\":{\"FYND\":\"FYND\"}}","companies":[],"support":["inventory","order"],"_id":"5e56089f4265cf2846d1e58c","name":"x0-1","meta":[{"public":true,"_id":"5e56089f4265cf81e1d1e58e","name":"wow","value":"1"}],"icon":"https://res.cloudinary.com/dwzm9bysq/image/upload/v1582696589/addsale/platform/integrations/icon/jihgcoibfmdttgiukwg0.png","owner":"5e55fe074bda3c392ed9eab2","created_at":"2020-02-26T05:56:47.214Z","updated_at":"2021-03-02T12:29:03.554Z","token":"fKoHRW5H","secret":"d1E85CTmf","__v":12},{"validators":{"company":{"json_schema":[],"browser_script":""},"store":{"json_schema":[],"browser_script":""},"inventory":{"json_schema":[],"browser_script":""},"order":{"json_schema":[],"browser_script":""}},"description":"jabardast","description_html":"","constants":"{\"mop_mapping\":{\"FYND\":\"FYND\"}}","companies":[],"support":["inventory","order"],"_id":"5e5608bf4265cf7198d1e58f","name":"x0-2","meta":[{"public":false,"_id":"5e5608bf4265cf813fd1e590","name":"wow","value":"1"}],"icon":"https://res.cloudinary.com/dwzm9bysq/image/upload/v1582696633/addsale/platform/integrations/icon/cstvvkgjgip1ja56gq4x.png","owner":"5e55fe074bda3c392ed9eab2","created_at":"2020-02-26T05:57:19.875Z","updated_at":"2021-02-15T05:23:55.962Z","token":"3h3_mnzp","secret":"dgGHrIlFG","__v":7}],"page":{"type":"number","current":1,"size":50,"item_total":24,"has_next":false}}}}}}}}}},"/service/platform/configuration/v1.0/company/{company_id}/integration-opt-in/configuration/{id}/{level}":{"get":{"description":"Use this API to get the configuration details of an integration such as token, permissions, level, opted value, uid, meta, location ID, etc.","summary":"getIntegrationLevelConfig | Get integration level config","tags":["Configuration"],"parameters":[{"schema":{"type":"integer"},"description":"Numeric ID allotted to a business account on Fynd Platform","in":"path","required":true,"name":"company_id","examples":{"success":{"value":2}}},{"name":"id","in":"path","schema":{"type":"string"},"description":"Integration ID (24-digit Mongo Object ID)","required":true,"examples":{"success":{"value":"6524d9e195f3c8e3d36b6977"}}},{"name":"level","in":"path","schema":{"type":"string"},"description":"store or company","required":true,"examples":{"success":{"value":"company"}}},{"name":"opted","in":"query","schema":{"type":"boolean"},"description":"True means get the opted stores. False means get the stores that aren't opted.","required":false},{"name":"check_permission","in":"query","schema":{"type":"boolean"},"description":"Filter on if permissions (for inventory/order) are present","required":false}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationConfigResponse"},"examples":{"success":{"value":{"items":[{"opted":false,"permissions":[],"last_patch":[],"_id":"5ec377f2848a0073feacb31b","integration":"5ec376ce848a005189acb312","level":"store","uid":1,"meta":[],"token":"1RuGX0Fyp","created_at":"2020-05-19T06:08:50.199Z","modified_at":"2020-08-17T07:54:01.809Z","__v":14}]}}}}}}}},"put":{"description":"Use this API to update the configuration details of an integration such as token, permissions, level, opted value, uid, meta, location ID, etc. at a particular level (store/company).","summary":"updateLevelIntegration | Update a store level integration you opted","tags":["Configuration"],"parameters":[{"schema":{"type":"integer"},"description":"Numeric ID allotted to a business account on Fynd Platform","in":"path","required":true,"name":"company_id","examples":{"success":{"value":2}}},{"name":"id","in":"path","schema":{"type":"string"},"description":"Integration ID (24-digit Mongo Object ID)","required":true,"examples":{"success":{"value":"000000000000000000000001"}}},{"name":"level","in":"path","schema":{"type":"string"},"description":"Integration level, `store` or `company`","required":true,"examples":{"success":{"value":"company"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateIntegrationLevelRequest"},"examples":{"success":{"value":{"items":[{"opted":false,"permissions":[],"last_patch":[],"_id":"5ec377f2848a0073feacb31b","integration":"5ec376ce848a005189acb312","level":"store","uid":1,"meta":[],"token":"1RuGX0Fyp","created_at":"2020-05-19T06:08:50.199Z","modified_at":"2020-08-17T07:54:01.809Z","__v":14}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationLevel"},"examples":{"success":{"value":{"opted":false,"permissions":[],"last_patch":[],"_id":"5ec377f2848a0073feacb31b","integration":"5ec376ce848a005189acb312","level":"store","uid":1,"meta":[],"token":"1RuGX0Fyp","created_at":"2020-05-19T06:08:50.199Z","modified_at":"2020-08-17T07:54:01.809Z","__v":14}}}}}}}}},"/service/platform/configuration/v1.0/company/{company_id}/integration-opt-in/configuration/{id}/{level}/{uid}":{"get":{"description":"Use this API to get the configuration details of an integration such as token, permissions, level, opted value, uid, meta, location ID, etc. at a particular level (store/company).","summary":"getIntegrationByLevelId | Get integration config at a particular level (store/company)","tags":["Configuration"],"parameters":[{"schema":{"type":"integer"},"description":"Numeric ID allotted to a business account on Fynd Platform","in":"path","required":true,"name":"company_id","examples":{"success":{"value":2}}},{"name":"id","in":"path","schema":{"type":"string"},"description":"Integration ID (24-digit Mongo Object ID)","required":true,"examples":{"success":{"value":"6524d9e195f3c8e3d36b6977"}}},{"name":"level","in":"path","schema":{"type":"string"},"description":"Integration level, `store` or `company`","required":true,"examples":{"success":{"value":"company"}}},{"name":"uid","in":"path","schema":{"type":"integer"},"description":"Unique identifier of integration level (store/company)","required":true,"examples":{"success":{"value":2}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationLevel"},"examples":{"success":{"value":{"opted":false,"permissions":[],"last_patch":[],"_id":"5ec377f2848a0073feacb31b","integration":"5ec376ce848a005189acb312","level":"store","uid":1,"meta":[],"token":"1RuGX0Fyp","created_at":"2020-05-19T06:08:50.199Z","modified_at":"2020-08-17T07:54:01.809Z","__v":14}}}}}}}},"put":{"description":"Update the level of integration by store UID","summary":"updateLevelUidIntegration | Update integration level by store UID","tags":["Configuration"],"parameters":[{"schema":{"type":"integer"},"description":"Numeric ID allotted to a business account on Fynd Platform","in":"path","required":true,"name":"company_id","examples":{"success":{"value":2}}},{"name":"id","in":"path","schema":{"type":"string"},"description":"Integration ID (24-digit Mongo Object ID)","required":true,"examples":{"success":{"value":"000000000000000000000001"}}},{"name":"level","in":"path","schema":{"type":"string"},"description":"Integration level, `store` or `company`","required":true,"examples":{"success":{"value":"company"}}},{"name":"uid","in":"path","schema":{"type":"integer"},"description":"Unique identifier of integration level (store/company)","required":true,"examples":{"success":{"value":2}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationLevel"},"examples":{"success":{"value":{"opted":false,"permissions":[],"last_patch":[],"_id":"5ec377f2848a0073feacb31b","integration":"5ec376ce848a005189acb312","level":"store","uid":2,"meta":[],"token":"1RuGX0Fyp","created_at":"2020-05-19T06:08:50.199Z","modified_at":"2020-08-17T07:54:01.809Z","__v":14}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationLevel"},"examples":{"success":{"value":{"opted":false,"permissions":[],"last_patch":[],"_id":"5ec377f2848a0073feacb31b","integration":"5ec376ce848a005189acb312","level":"store","uid":2,"meta":[],"token":"1RuGX0Fyp","company_id":2,"created_at":"2020-05-19T06:08:50.199Z","modified_at":"2020-08-17T07:54:01.809Z","__v":14}}}}}}}}},"/service/platform/configuration/v1.0/company/{company_id}/integration-opt-in/check/configuration/{id}/{level}/{uid}":{"get":{"description":"Use this API to check if a store is already opted-in for any integration","summary":"getLevelActiveIntegrations | Check active integration at store","tags":["Configuration"],"parameters":[{"schema":{"type":"integer"},"description":"Numeric ID allotted to a business account on Fynd Platform","in":"path","required":true,"name":"company_id","examples":{"success":{"value":2}}},{"name":"id","in":"path","schema":{"type":"string"},"description":"Integration ID (24-digit Mongo Object ID)","required":true,"examples":{"success":{"value":"6524d9e195f3c8e3d36b6977"}}},{"name":"level","in":"path","schema":{"type":"string"},"description":"Integration level, `store` or `company`","required":true,"examples":{"success":{"value":"company"}}},{"name":"uid","in":"path","schema":{"type":"integer"},"description":"Unique identifier of integration level (store/company)","required":true,"examples":{"success":{"value":11081}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OptedStoreIntegration"},"examples":{"success":{"value":{"other_entity":{"opted":false,"permissions":[],"last_patch":[],"_id":"5ec377f2848a0073feacb31b","integration":"5ec376ce848a005189acb312","level":"company","uid":2,"meta":[],"token":"1RuGX0Fyp","created_at":"2020-05-19T06:08:50.199Z","modified_at":"2020-08-17T07:54:01.809Z","__v":14}}}}}}}}}},"/service/platform/configuration/v1.0/company/{company_id}/inventory/brands-by-companies":{"get":{"description":"Use this API to get all the brands added in a company. Get all the brand names, along with URLs of their logo, banner, and portrait image.","summary":"getBrandsByCompany | Get brands by company.","tags":["Configuration"],"parameters":[{"schema":{"type":"integer"},"description":"Numeric ID allotted to a business account on Fynd Platform","in":"path","required":true,"name":"company_id","examples":{"success":{"value":2}}},{"name":"q","in":"query","schema":{"type":"string"},"description":"Search text for brand name"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrandsByCompanyResponse"},"examples":{"success":{"value":{"brands":[{"name":"5th Avenue","value":476,"brand_logo_url":"https://hdn-1.addsale.com/x0/seller/pictures/logo/original/--unnamed--/1595615012186.jpeg","brand_banner_url":"https://hdn-1.addsale.com/x0/seller/pictures/landscape-banner/original/--unnamed--/1595615012724.jpeg","brand_banner_portrait_url":"https://hdn-1.addsale.com/x0/seller/pictures/portrait-banner/original/--unnamed--/1595615013203.jpeg"}]}}}}}},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationFailedResponse"}}}}}}},"/service/platform/configuration/v1.0/company/{company_id}/inventory/companies-by-brands":{"post":{"description":"Use this API to get a list of companies by the brands they deal","summary":"getCompanyByBrands | Get company by brand uids","tags":["Configuration"],"parameters":[{"schema":{"type":"integer"},"description":"Numeric ID allotted to a business account on Fynd Platform","in":"path","required":true,"name":"company_id","examples":{"success":{"value":2}}},{"name":"page_no","in":"query","schema":{"type":"integer"},"description":"The page number to navigate through the given set of results. Default value is 1."},{"name":"page_size","in":"query","schema":{"type":"integer"},"description":"The number of items to retrieve in each page. Default value is 10."}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyByBrandsRequest"},"examples":{"success":{"value":{"brands":1}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyByBrandsResponse"},"examples":{"success":{"value":{"items":[{"company_name":"RELIANCE RETAIL LTD","company_id":1},{"company_name":"SARASUOLE PRIVATE LIMITED","company_id":2},{"company_name":"Lloyd Palek","company_id":4}],"page":{"type":"number","current":1,"size":200,"item_total":171,"has_next":false}}}}}}}}}},"/service/platform/configuration/v1.0/company/{company_id}/inventory/stores-by-brands":{"post":{"description":"Use this API to get a list of selling locations (stores) by the brands they deal. Store has information about store name, store type, store code, store address, and company detail.","summary":"getStoreByBrands | Get stores by brand uids for the current company","tags":["Configuration"],"parameters":[{"schema":{"type":"integer"},"description":"Numeric ID allotted to a business account on Fynd Platform","in":"path","required":true,"name":"company_id","examples":{"success":{"value":2}}},{"name":"page_no","in":"query","schema":{"type":"integer"},"description":"The page number to navigate through the given set of results. Default value is 1."},{"name":"page_size","in":"query","schema":{"type":"integer"},"description":"The number of items to retrieve in each page. Default value is 10."}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreByBrandsRequest"},"examples":{"Current company stores":{"value":{"company_id":2,"brands":1}},"Get stores including cross selling company stores":{"value":{"brands":1}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreByBrandsResponse"},"examples":{"success":{"value":{"items":[{"store_name":"RRL01","store_id":1,"store_type":"warehouse","store_code":"WH_8513","store_address":{"state":"MAHARASHTRA","address1":"SHOPSENSE RETAIL TECHNOLOGIES PRIVATE LIMITED 1ST FLOOR WEWORK VIJAY DIAMOND, CROSS RD B, AJIT NAGAR,","lat_long":{"type":"Point","coordinates":[72.8691788,19.1174114]},"address2":"KONDIVITA, ANDHERI EAST, MUMBAI, MAHARASHTRA 400069","pincode":400059,"country":"INDIA","city":"MUMBAI"},"company":{"uid":2,"name":"RELIANCE RETAIL LTD"}},{"store_name":"RUOSH WAREHOUSE","store_id":2,"store_type":"warehouse","store_code":"RUOSH43","store_address":{"state":"MAHARASHTRA","address1":"RAUNAK CITY SECTOR 4 D10, SAPAD GAON","lat_long":{"type":"Point","coordinates":[73.121952,19.2645048]},"address2":"SAPAD GAON, KHADAKPADA, ","pincode":421301,"country":"INDIA","city":"THANE","landmark":"near taj"},"company":{"uid":2,"name":"SARASUOLE PRIVATE LIMITED"}}],"page":{"type":"number","current":1,"size":200,"item_total":762,"has_next":true}}}}}}}}}},"/service/platform/configuration/v1.0/company/{company_id}/other-seller-applications":{"get":{"description":"Use this API to fetch all other seller applications that were not created within the current company. but have opted for the current company's inventory","summary":"getOtherSellerApplications | Get other seller sales channels","tags":["Configuration"],"parameters":[{"schema":{"type":"integer"},"description":"Numeric ID allotted to a business account on Fynd Platform","in":"path","required":true,"name":"company_id","examples":{"success":{"value":2}}},{"name":"page_no","in":"query","schema":{"type":"integer"},"description":"The page number to navigate through the given set of results. Default value is 1."},{"name":"page_size","in":"query","schema":{"type":"integer"},"description":"The number of items to retrieve in each page. Default value is 10."}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OtherSellerApplications"},"examples":{"success":{"value":{"items":[{"name":"intent 2","description":"","_id":"5f030880f019afd636889afc","domain":"intent.hostfynd.dev","company":{"uid":2,"name":"DummyImran"},"opt_type":"store"},{"name":"new application imran","description":"","_id":"5f03f5d17692029e2d1a50a5","domain":"imranstore.hostfynd.dev","company":{"uid":2,"name":"DummyImran"},"opt_type":"store"},{"name":"helo","description":"","_id":"5f03f63b769202170c1a50a9","domain":"helo.hostfynd.dev","company":{"uid":7,"name":"Zack Burgdorf"},"opt_type":"store"}],"page":{"type":"number","current":1,"size":10,"item_total":20,"has_next":true}}}}}}}}}},"/service/platform/configuration/v1.0/company/{company_id}/other-seller-applications/{id}":{"get":{"description":"Use application ID to fetch details of a seller application that was not created within the current company. but has opted for the current company's inventory","summary":"getOtherSellerApplicationById | Get other seller's sales channel by ID","tags":["Configuration"],"parameters":[{"schema":{"type":"integer"},"description":"Numeric ID allotted to a business account on Fynd Platform","in":"path","required":true,"name":"company_id","examples":{"404":{"value":2},"success":{"value":2}}},{"name":"id","in":"path","schema":{"type":"string"},"description":"Application Id","required":true,"examples":{"404":{"value":"000000000000000000000005"},"success":{"value":"000000000000000000000001"}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OptedApplicationResponse"},"examples":{"success":{"value":{"name":"intent 2","description":"","_id":"5f030880f019afd636889afc","domain":"intent.hostfynd.dev","company":{"uid":94,"name":"DummyImran"},"opted_inventory":{"opt_type":{"key":"store","display":"Store"},"items":[{"name":"RRL01","id":1,"store_code":"WH_8513","_id":"5ec2c0b168fc2800017112f5","modified_on":"2020-09-09T04:25:55.843Z","uid":1}]},"address":{"state":"MAHARASHTRA","address1":"SHOPSENSE RETAIL TECHNOLOGIES PRIVATE LIMITED 1ST FLOOR WEWORK VIJAY DIAMOND, CROSS RD B, AJIT NAGAR,","lat_long":{"type":"Point","coordinates":[72.8691788,19.1174114]},"address2":"KONDIVITA, ANDHERI EAST, MUMBAI, MAHARASHTRA 400069","pincode":400059,"country":"INDIA","city":"MUMBAI"},"display_name":"RRL01","store_type":"warehouse","company_id":2,"opt_out_inventory":{"store":[],"company":[]}}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"examples":{"404":{"value":{"message":"application not found"}}}}}}}}},"/service/platform/configuration/v1.0/company/{company_id}/other-seller-applications/{id}/opt_out":{"put":{"description":"Use this API to opt-out your company or store from other seller application. The specific seller application will no longer fetch inventory from your company or store.","summary":"optOutFromApplication | Opt-out company or store from other seller application","tags":["Configuration"],"parameters":[{"schema":{"type":"integer"},"description":"Numeric ID allotted to a business account on Fynd Platform","in":"path","required":true,"name":"company_id","examples":{"404":{"value":2},"success":{"value":2},"Missing parameter":{"value":2},"Company other than current company sent for opt out":{"value":2},"Store other than current company sent for opt out":{"value":2},"Inventory not configured for sent application id":{"value":2}}},{"name":"id","in":"path","schema":{"type":"string"},"description":"Alphanumeric ID allotted to an application (sales channel website) created within a business account.","required":true,"examples":{"404":{"value":"000000000000000000000005"},"success":{"value":"000000000000000000000001"},"Missing parameter":{"value":"000000000000000000000001"},"Company other than current company sent for opt out":{"value":"000000000000000000000001"},"Store other than current company sent for opt out":{"value":"000000000000000000000001"},"Inventory not configured for sent application id":{"value":"000000000000000000000002"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OptOutInventory"},"examples":{"404":{"value":{"store":[],"company":[2]}},"success":{"value":{"store":[],"company":[2]}},"Missing parameter":{"value":{"store":[]}},"Company other than current company sent for opt out":{"value":{"store":[],"company":[1]}},"Store other than current company sent for opt out":{"value":{"store":[105],"company":[2]}},"Inventory not configured for sent application id":{"value":{"store":[],"company":[2]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessMessageResponse"},"examples":{"success":{"value":{"message":"Updated opt out data"}}}}}},"400":{"description":"Invalid params or Not configured inventory","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidPayloadRequest"},"examples":{"Missing parameter":{"value":{"message":"Invalid opt out request data. Either of `store` and `company` fields are missing"}},"Company other than current company sent for opt out":{"value":{"message":"Invalid company id"}},"Store other than current company sent for opt out":{"value":{"message":"Invalid store ids"}},"Inventory not configured for sent application id":{"value":{"message":"Inventory is not configured"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"examples":{"404":{"value":{"message":"application not found"}}}}}}}}},"/service/platform/content/v1.0/company/{company_id}/application/{application_id}/announcements":{"get":{"description":"Announcements are useful to highlight a message or information on top of a webpage. Use this API to retrieve a list of announcements.\t","summary":"getAnnouncementsList | Get a list of announcements","tags":["Content"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Numeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}},{"name":"page_no","in":"query","description":"The page number to navigate through the given set of results. Default value is 1.","required":false,"schema":{"type":"integer","default":1}},{"name":"page_size","in":"query","description":"The number of items to retrieve in each page. Default value is 10.","required":false,"schema":{"type":"integer","default":10}}],"responses":{"200":{"description":"Success. Refer `GetAnnouncementListSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAnnouncementListSchema"},"examples":{"success":{"$ref":"#/components/examples/GetAnnouncementList"}}}}},"4XX":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"5XX":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/5XXAPIError"}}}}}}},"post":{"description":"Announcements are useful to highlight a message or information on top of a webpage. Use this API to create an announcement.","summary":"createAnnouncement | Create an announcement","tags":["Content"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Numeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Refer `AdminAnnouncementSchema` for more details.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminAnnouncementSchema"},"examples":{"default":{"$ref":"#/components/examples/Announcement"}}}}},"responses":{"200":{"description":"Success. Refer `CreateAnnouncementSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAnnouncementSchema"},"examples":{"success":{"$ref":"#/components/examples/CreateAnnouncement"}}}}},"4XX":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"5XX":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/5XXAPIError"}}}}}}}},"/service/platform/content/v1.0/company/{company_id}/application/{application_id}/announcements/{announcement_id}":{"get":{"description":"Use this API to retrieve an announcement and its details such as the target platform and pages on which it's applicable","summary":"getAnnouncementById | Get announcement by ID","tags":["Content"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Numeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}},{"name":"announcement_id","in":"path","description":"ID allotted to the announcement.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success. Refer `AdminAnnouncementSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminAnnouncementSchema"},"examples":{"success":{"$ref":"#/components/examples/Announcement"}}}}},"4XX":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"5XX":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/5XXAPIError"}}}}}}},"put":{"description":"Use this API to edit an existing announcement and its details such as the target platform and pages on which it's applicable","summary":"updateAnnouncement | Update an announcement","tags":["Content"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Numeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}},{"name":"announcement_id","in":"path","description":"ID allotted to the announcement.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Refer `AdminAnnouncementSchema` for more details.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminAnnouncementSchema"},"examples":{"default":{"$ref":"#/components/examples/Announcement"}}}}},"responses":{"200":{"description":"Success. Refer `CreateAnnouncementSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAnnouncementSchema"},"examples":{"success":{"$ref":"#/components/examples/UpdateAnnouncement"}}}}},"4XX":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"5XX":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/5XXAPIError"}}}}}}},"patch":{"description":"Use this API to edit the duration, i.e. start date-time and end date-time of an announcement. Moreover, you can enable/disable an announcement using this API.","summary":"updateAnnouncementSchedule | Update the schedule and the publish status of an announcement","tags":["Content"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Numeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}},{"name":"announcement_id","in":"path","description":"ID allotted to the announcement.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Refer `ScheduleSchema` for knowing more about the request body for **Update Schedule** and **Unpublish Announcement** respectively.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduleSchema"},"examples":{"Unpublish Announcement":{"value":{"published":false}},"Update Schedule":{"$ref":"#/components/examples/Schedule"}}}}},"responses":{"200":{"description":"Success. Refer `CreateAnnouncementSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAnnouncementSchema"},"examples":{"success":{"$ref":"#/components/examples/PatchAnnouncement"}}}}},"4XX":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"5XX":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/5XXAPIError"}}}}}}},"delete":{"description":"Use this API to delete an existing announcement.","summary":"deleteAnnouncement | Delete announcement by id","tags":["Content"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Numeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}},{"name":"announcement_id","in":"path","description":"ID allotted to the announcement.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAnnouncementSchema"},"examples":{"success":{"$ref":"#/components/examples/DeleteAnnouncement"}}}}},"4XX":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"5XX":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/5XXAPIError"}}}}}}}},"/service/platform/content/v1.0/company/{company_id}/application/{application_id}/blogs/":{"post":{"description":"Use this API to create a blog.","summary":"createBlog | Create a blog","tags":["Content"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Numeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Pass the author details, content, feature image, title, SEO details, etc. in the request body. Refer `BlogRequest` for more details.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlogRequest"},"examples":{"default":{"$ref":"#/components/examples/BlogRequest"}}}}},"responses":{"200":{"description":"Success. Refer `BlogSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlogSchema"},"examples":{"default":{"$ref":"#/components/examples/BlogResponse"}}}}},"4XX":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"value":{"message":"Oops! Something went wrong. Please try later","status":400,"code":"CX-1003","exception":"","info":"","request_id":"","stack_trace":"","meta":{}}}}}}},"5XX":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"value":{"message":"Oops! Something went wrong. Please try later","status":500,"code":"CX-1004","exception":"","info":"","request_id":"","stack_trace":"","meta":{}}}}}}}}},"get":{"description":"Use this API to get a list of blogs along with their details, such as the title, reading time, publish status, feature image, tags, author, etc.","summary":"getBlogs | Get blogs","tags":["Content"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Numeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}},{"name":"page_no","in":"query","description":"The page number to navigate through the given set of results. Default value is 1.","required":false,"schema":{"type":"integer","default":1}},{"name":"page_size","in":"query","description":"The number of items to retrieve in each page. Default value is 10.","required":false,"schema":{"type":"integer","default":10}}],"responses":{"200":{"description":"Success. Refer `BlogGetResponse` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlogGetResponse"},"examples":{"default":{"$ref":"#/components/examples/BlogGetResponse"}}}}},"4XX":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"5XX":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/5XXAPIError"}}}}}}}},"/service/platform/content/v1.0/company/{company_id}/application/{application_id}/blogs/{id}":{"put":{"description":"Use this API to update the details of an existing blog which includes title, feature image, content, SEO details, expiry, etc.","summary":"updateBlog | Update a blog","tags":["Content"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Numeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"ID allotted to the blog.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Refer `BlogRequest` for more details.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlogRequest"},"examples":{"default":{"$ref":"#/components/examples/BlogRequest"}}}}},"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlogSchema"},"examples":{"default":{"$ref":"#/components/examples/BlogResponse"}}}}},"4XX":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"value":{"message":"Oops! Something went wrong. Please try later","status":400,"code":"CX-1003","exception":"","info":"","request_id":"","stack_trace":"","meta":{}}}}}}},"5XX":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"value":{"message":"Oops! Something went wrong. Please try later","status":500,"code":"CX-1004","exception":"","info":"","request_id":"","stack_trace":"","meta":{}}}}}}}}},"delete":{"description":"Use this API to delete a blog.","summary":"deleteBlog | Delete blogs","tags":["Content"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Numeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"ID allotted to the blog.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlogSchema"},"examples":{"default":{"$ref":"#/components/examples/BlogResponse"}}}}},"4XX":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"5XX":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/5XXAPIError"}}}}}}}},"/service/platform/content/v1.0/company/{company_id}/application/{application_id}/blogs/{slug}":{"get":{"summary":"getComponentById | Get components of a blog","description":"Use this API to retrieve the components of a blog, such as title, slug, feature image, content, schedule, publish status, author, etc.","tags":["Content"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Numeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}},{"name":"slug","in":"path","description":"A short, human-readable, URL-friendly identifier of a blog page. You can get slug value of a blog from `getBlogs` API.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success. Returns a a JSON object with components. Refer `BlogSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlogSchema"},"examples":{"default":{"$ref":"#/components/examples/BlogResponse"}}}}},"4XX":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"5XX":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/5XXAPIError"}}}}}}}},"/service/platform/content/v1.0/company/{company_id}/application/{application_id}/data-loader":{"post":{"description":"Use this API to add data loader. This includes the data loader name, operationId, service name and its type (url/function) with corresponding value.","summary":"addDataLoader | Adds a data loader","tags":["Content"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform.","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Alphanumeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Pass the name, operation Id incluing type (url/function), url and service name in request body. Refer `DataLoaderSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataLoaderSchema"},"example":{"name":"Search API from Algolia","service":"catalog","operation_id":"fetchSuggestions","type":"url","url":"/ext/example/url"}}}},"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataLoaderResponseSchema"},"example":{"_id":"601f77e7aa61066feda44487","name":"Search API from Algolia","service":"catalog","operation_id":"fetchSuggestions","type":"url","application":"000000000000000000000001","__v":0}}}},"4XX":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"5XX":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonError"},"examples":{"default":{"$ref":"#/components/examples/5XXAPIError"}}}}}}},"get":{"description":"Use this to get all data loaders of an application","summary":"getDataLoaders | Get all the data loaders in an application","tags":["Content"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform.","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Alphanumeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success. Refer `DataLoadersSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataLoadersSchema"},"example":{"items":[{"name":"Algolia","is_selected":false,"type":"url","_id":"61bc4523a7ffc7504f4de4a5","service":"catalog","operation_id":"fetchSuggestions","url":"/ext/example/url","__source":{"type":"extension","id":"000000000000000000000003"},"application":"100000000000000000000001","__v":0},{"name":"Algolia v3","is_selected":false,"type":"url","_id":"61bc452da7ffc7504f4de4a7","service":"catalog","operation_id":"fetchSuggestions","url":"/ext/example/url","__source":{"type":"extension","id":"000000000000000000000003"},"application":"100000000000000000000001","__v":0}]}}}},"4XX":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"5XX":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonError"},"examples":{"default":{"$ref":"#/components/examples/5XXAPIError"}}}}}}}},"/service/platform/content/v1.0/company/{company_id}/application/{application_id}/data-loader/{data_loader_id}":{"delete":{"description":"Use this API to delete data loader.","summary":"deleteDataLoader | Delete data loader in application","tags":["Content"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform.","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Alphanumeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}},{"name":"data_loader_id","in":"path","description":"ID allotted to the data loader.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataLoaderResponseSchema"},"example":{"_id":"601f77e7aa61066feda44487","name":"Search API from Algolia","service":"catalog","operation_id":"fetchSuggestions","type":"url","application":"000000000000000000000001","__v":0}}}},"4XX":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"5XX":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonError"},"examples":{"default":{"$ref":"#/components/examples/5XXAPIError"}}}}}}},"put":{"description":"Use this API to edit the details of an existing data loader by its ID.","summary":"editDataLoader | Edit a data loader by id","tags":["Content"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform.","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Alphanumeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}},{"name":"data_loader_id","in":"path","description":"ID allotted to the data loader.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Data Loader. Refer `DataLoaderSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataLoaderSchema"},"example":{"name":"Search API from Algolia","service":"catalog","operation_id":"fetchSuggestions","type":"url","url":"/ext/example/url"}}}},"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataLoaderResponseSchema"},"example":{"_id":"601f77e7aa61066feda44487","name":"Search API from Algolia","service":"catalog","operation_id":"fetchSuggestions","type":"url","application":"000000000000000000000001","__v":0}}}},"4XX":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"5XX":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonError"},"examples":{"default":{"$ref":"#/components/examples/5XXAPIError"}}}}}}}},"/service/platform/content/v1.0/company/{company_id}/application/{application_id}/data-loader/service/{service_name}":{"get":{"description":"Use this to get all data loaders of an application by service name","summary":"getDataLoadersByService | Get all the data loaders in an application by service name","tags":["Content"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform.","required":true,"schema":{"type":"string","example":"13741"}},{"name":"application_id","in":"path","description":"Alphanumeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string","example":"637b6355dc65337da9b5c951"}},{"name":"service_name","in":"path","description":"Service name of the data loader..","required":true,"schema":{"type":"string","example":"catalog"}}],"responses":{"200":{"description":"Success. Refer `DataLoaderResponseSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataLoaderResponseSchema"},"example":{"items":[{"name":"Algolia","is_selected":false,"type":"url","_id":"61bc4523a7ffc7504f4de4a5","service":"catalog","operation_id":"fetchSuggestions","url":"/ext/example/url","__source":{"type":"extension","id":"000000000000000000000003"},"application":"100000000000000000000001","__v":0},{"name":"Algolia v3","is_selected":false,"type":"url","_id":"61bc452da7ffc7504f4de4a7","service":"catalog","operation_id":"fetchSuggestions","url":"/ext/example/url","__source":{"type":"extension","id":"000000000000000000000003"},"application":"100000000000000000000001","__v":0}]}}}},"4XX":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"5XX":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonError"},"examples":{"default":{"$ref":"#/components/examples/5XXAPIError"}}}}}}}},"/service/platform/content/v1.0/company/{company_id}/application/{application_id}/data-loader/{data_loader_id}/select":{"put":{"description":"Use this API to select a data loader to be used in applications.","summary":"selectDataLoader | Select a data loader by id","tags":["Content"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform.","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Alphanumeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}},{"name":"data_loader_id","in":"path","description":"ID allotted to the data loader.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataLoaderResponseSchema"},"example":{"_id":"601f77e7aa61066feda44487","name":"Search API from Algolia","service":"catalog","operation_id":"fetchSuggestions","type":"url","application":"000000000000000000000001","__v":0}}}},"4XX":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"5XX":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonError"},"examples":{"default":{"$ref":"#/components/examples/5XXAPIError"}}}}}}}},"/service/platform/content/v1.0/company/{company_id}/application/{application_id}/data-loader/{service}/{operation_id}/reset":{"put":{"description":"Use this API to reselect a data loader.","summary":"resetDataLoader | Reset a data loader by serive name and operation Id","tags":["Content"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform.","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Alphanumeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}},{"name":"service","in":"path","description":"Name of service.","required":true,"schema":{"type":"string"}},{"name":"operation_id","in":"path","description":"Name of operation id of the service.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataLoaderResetResponseSchema"},"example":{"reset":true}}}},"4XX":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"5XX":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonError"},"examples":{"default":{"$ref":"#/components/examples/5XXAPIError"}}}}}}}},"/service/platform/content/v1.0/company/{company_id}/application/{application_id}/faq/categories":{"get":{"description":"FAQs can be divided into categories. Use this API to get a list of FAQ categories.","summary":"getFaqCategories | Get a list of FAQ categories","tags":["Content"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Numeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success. Refer `GetFaqCategoriesSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetFaqCategoriesSchema"},"example":{"categories":[{"index":0,"children":["6026426ae507768b168dee4b"],"title":"Test","_id":"60263f80c83c1f89f2863a8a","slug":"test","application":"000000000000000000000001"}]}}}},"4XX":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"5XX":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/5XXAPIError"}}}}}}}},"/service/platform/content/v1.0/company/{company_id}/application/{application_id}/faq/category/{id_or_slug}":{"get":{"description":"FAQs can be divided into categories. Use this API to get an FAQ categories using its slug or ID.","summary":"getFaqCategoryBySlugOrId | Get an FAQ category by slug or id","tags":["Content"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Numeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}},{"name":"id_or_slug","in":"path","description":"ID or the slug allotted to an FAQ category. Slug is a short, human-readable, URL-friendly identifier of an object. You can get slug value of an FAQ category from `getFaqCategories` API.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success. Refer `GetFaqCategoryBySlugSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetFaqCategoryBySlugSchema"},"example":{"category":{"index":0,"children":[{"_id":"6026426ae507768b168dee4b","question":"question 1","answer":"answer 1","slug":"question-1","application":"000000000000000000000001"}],"_id":"60263f80c83c1f89f2863a8a","slug":"test","title":"Test","application":"000000000000000000000001"}}}}},"4XX":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"5XX":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/5XXAPIError"}}}}}}}},"/service/platform/content/v1.0/company/{company_id}/application/{application_id}/faq/category":{"post":{"description":"FAQs help users to solve an issue or know more about a process. FAQs can be categorized separately, for e.g. some questions can be related to payment, some could be related to purchase, shipping, navigating, etc. Use this API to create an FAQ category.","summary":"createFaqCategory | Create an FAQ category","tags":["Content"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Numeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Pass the title and slug of the FAQ category in a category object, in the request body. Refer `CreateFaqCategoryRequestSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFaqCategoryRequestSchema"},"example":{"category":{"slug":"test","title":"Test"}}}}},"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFaqCategorySchema"},"example":{"category":{"index":0,"children":[],"_id":"60263f80c83c1f89f2863a8a","slug":"test","application":"000000000000000000000001","title":"Test"}}}}},"4XX":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"5XX":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/5XXAPIError"}}}}}}}},"/service/platform/content/v1.0/company/{company_id}/application/{application_id}/faq/category/{id}":{"put":{"description":"Use this API to edit an existing FAQ category.","summary":"updateFaqCategory | Update an FAQ category","tags":["Content"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Numeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"ID allotted to an FAQ category.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Refer `UpdateFaqCategoryRequestSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateFaqCategoryRequestSchema"},"example":{"category":{"index":0,"title":"Test Updated","children":[],"_id":"60263f80c83c1f89f2863a8a","slug":"test","application":"000000000000000000000001"}}}}},"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFaqCategorySchema"},"example":{"category":{"index":0,"children":[],"_id":"60263f80c83c1f89f2863a8a","title":"Test Updated","slug":"test","application":"000000000000000000000001"}}}}},"4XX":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"5XX":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/5XXAPIError"}}}}}}},"delete":{"description":"Use this API to delete an FAQ category.","summary":"deleteFaqCategory | Delete an FAQ category","tags":["Content"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Numeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"ID allotted to an FAQ category.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FaqSchema"},"example":{"category":{"index":0,"children":[],"_id":"60263f80c83c1f89f2863a8a","slug":"test","title":"Test","application":"000000000000000000000001","__v":2}}}}},"4XX":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"5XX":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/5XXAPIError"}}}}}}}},"/service/platform/content/v1.0/company/{company_id}/application/{application_id}/faq/category/{id_or_slug}/faqs":{"get":{"description":"Use this API to retrieve all the commonly asked question and answers belonging to an FAQ category.","summary":"getFaqsByCategoryIdOrSlug | Get question and answers within an FAQ category","tags":["Content"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Numeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}},{"name":"id_or_slug","in":"path","description":"ID or the slug allotted to an FAQ category. Slug is a short, human-readable, URL-friendly identifier of an object. You can get slug value of an FAQ category from `getFaqCategories` API.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success. Refer `GetFaqSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetFaqSchema"},"example":{"faqs":[{"_id":"60265b64e507768b168dee4d","question":"question 1","answer":"answer 1","slug":"question-1","application":"000000000000000000000001"}]}}}},"4XX":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"5XX":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/5XXAPIError"}}}}}}}},"/service/platform/content/v1.0/company/{company_id}/application/{application_id}/faq/category/{category_id}/faq":{"post":{"description":"FAQs help users to solve an issue or know more about a process. Use this API to create an FAQ for a given FAQ category.","summary":"addFaq | Create an FAQ","tags":["Content"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Numeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}},{"name":"category_id","in":"path","description":"ID allotted to an FAQ category.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Pass the question, answer and slug in the request body. Refer `CreateFaqSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFaqSchema"},"example":{"faq":{"question":"question 1","answer":"answer 1","slug":"question-1"}}}}},"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFaqResponseSchema"},"example":{"faq":{"_id":"60265b64e507768b168dee4d","question":"question 1","answer":"answer 1","slug":"question-1","application":"000000000000000000000001"}}}}},"4XX":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"5XX":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/5XXAPIError"}}}}}}}},"/service/platform/content/v1.0/company/{company_id}/application/{application_id}/faq/category/{category_id}/faq/{faq_id}":{"put":{"description":"Use this API to edit an existing FAQ.","summary":"updateFaq | Update an FAQ","tags":["Content"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Numeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}},{"name":"category_id","in":"path","description":"ID allotted to an FAQ category.","required":true,"schema":{"type":"string"}},{"name":"faq_id","in":"path","description":"ID allotted to an FAQ.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Pass the updated question, answer or slug in the request body. Refer `CreateFaqSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFaqSchema"},"example":{"faq":{"question":"question 1 updated","answer":"answer 1","slug":"question-1"}}}}},"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFaqResponseSchema"},"example":{"faq":{"_id":"60265b64e507768b168dee4d","question":"question 1 updated","answer":"answer 1","slug":"question-1","application":"000000000000000000000001"}}}}},"4XX":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"5XX":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/5XXAPIError"}}}}}}},"delete":{"description":"Use this API to delete an existing FAQ.","summary":"deleteFaq | Delete an FAQ","tags":["Content"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Numeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}},{"name":"category_id","in":"path","description":"ID allotted to an FAQ category.","required":true,"schema":{"type":"string"}},{"name":"faq_id","in":"path","description":"ID allotted to an FAQ.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFaqResponseSchema"},"example":{"faq":{"_id":"60265b64e507768b168dee4d","question":"question 1 updated","answer":"answer 1","slug":"question-1","application":"000000000000000000000001"}}}}},"4XX":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"5XX":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/5XXAPIError"}}}}}}}},"/service/platform/content/v1.0/company/{company_id}/application/{application_id}/faq/{id_or_slug}":{"get":{"description":"Use this API to retrieve a specific FAQ. You will get the question and answer of that FAQ.","summary":"getFaqByIdOrSlug | Get an FAQ","tags":["Content"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Numeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}},{"name":"id_or_slug","in":"path","description":"ID or the slug allotted to an FAQ category. Slug is a short, human-readable, URL-friendly identifier of an object. You can get slug value of an FAQ category from `getFaqCategories` API.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success. Refer `CreateFaqResponseSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFaqResponseSchema"},"example":{"faq":{"_id":"60265b64e507768b168dee4d","question":"question 1","answer":"answer 1","slug":"question-1","application":"000000000000000000000001"}}}}},"4XX":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"5XX":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/5XXAPIError"}}}}}}}},"/service/platform/content/v1.0/company/{company_id}/application/{application_id}/generate-seo/{type}":{"post":{"description":"Use this API to get GPT3 generated SEO meta tag title for content","summary":"generateSEOTitle | Get SEO meta tag title for content","tags":["Content"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Numeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}},{"name":"type","in":"path","description":"String representing the type of SEO content to be generated. Possible values are: title, description","required":true,"schema":{"$ref":"#/components/schemas/GenerationEntityType"}}],"requestBody":{"description":"Payload to generate SEO title","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateSEOContent"}}}},"responses":{"200":{"description":"Returns the generated SEO title","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneratedSEOContent"},"examples":{"default":{"value":{"title":"SEO Title example","description":"SEO Description example"}}}}}},"4XX":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"5XX":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/5XXAPIError"}}}}}}}},"/service/platform/content/v1.0/company/{company_id}/application/{application_id}/landing-page/":{"get":{"description":"Landing page is the first page that a prospect lands upon while visiting a website. Use this API to fetch a list of landing pages.","summary":"getLandingPages | Get landing pages","tags":["Content"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Numeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}},{"name":"page_no","in":"query","description":"The page number to navigate through the given set of results. Default value is 1.","required":false,"schema":{"type":"integer","default":1}},{"name":"page_size","in":"query","description":"The number of items to retrieve in each page. Default value is 10.","required":false,"schema":{"type":"integer","default":10}}],"responses":{"200":{"description":"Success. Refer `LandingPageGetResponse` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LandingPageGetResponse"},"examples":{"default":{"$ref":"#/components/examples/LandingPageGetResponse"}}}}},"4XX":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"5XX":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/5XXAPIError"}}}}}}},"post":{"description":"Landing page is the first page that a prospect lands upon while visiting a website. Use this API to create a landing page.","summary":"createLandingPage | Create a landing page","tags":["Content"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Numeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Refer `LandingPageSchema` for more details.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LandingPageSchema"},"examples":{"default":{"value":{"slug":"pnc-landing","action":{"page":{"type":"home"},"popup":{},"type":"page"},"platform":["web"],"_custom_json":{}}}}}}},"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LandingPageSchema"},"examples":{"default":{"$ref":"#/components/examples/LandingPageResponse"}}}}},"4XX":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"5XX":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/5XXAPIError"}}}}}}}},"/service/platform/content/v1.0/company/{company_id}/application/{application_id}/landing-page/{id}":{"put":{"description":"Use this API to edit the details of an existing landing page.","summary":"updateLandingPage | Update a landing page","tags":["Content"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Numeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"ID allotted to a landing page.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Refer `LandingPageSchema` for more details.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LandingPageSchema"},"examples":{"default":{"value":{"_id":"5eaa451a21a4dd75f0fd96c5","application":"5d3ebd89f540e7506b8b3548","_custom_json":{},"slug":"pnc-landing","action":{"page":{"type":"home"},"popup":{},"type":"page"},"platform":["web"],"created_by":{"id":"000000000000000000000000"},"date_meta":{"created_on":"2020-04-30T03:25:14.549Z","modified_on":"2020-04-30T03:25:14.549Z"},"archived":false}}}}}},"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LandingPageSchema"},"examples":{"default":{"$ref":"#/components/examples/LandingPageResponse"}}}}},"4XX":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"5XX":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/5XXAPIError"}}}}}}},"delete":{"description":"Use this API to delete an existing landing page.","summary":"deleteLandingPage | Delete a landing page","tags":["Content"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Numeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"ID allotted to a landing page.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LandingPageSchema"},"examples":{"default":{"value":{"_id":"5eaa451a21a4dd75f0fd96c5","application":"5d3ebd89f540e7506b8b3548","_custom_json":{},"slug":"pnc-landing","action":{"page":{"type":"home"},"popup":{},"type":"page"},"platform":["web"],"created_by":{"id":"000000000000000000000000"},"date_meta":{"created_on":"2020-04-30T03:25:14.549Z","modified_on":"2020-04-30T03:25:14.549Z"},"archived":true}}}}}},"4XX":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"5XX":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/5XXAPIError"}}}}}}}},"/service/platform/content/v1.0/company/{company_id}/application/{application_id}/legal":{"get":{"description":"Use this API to get the legal information of an application, which includes Policy, Terms and Conditions, Shipping Policy and FAQ regarding the application.","summary":"getLegalInformation | Get legal information","tags":["Content"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Numeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success. Refer `ApplicationLegal` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationLegal"},"examples":{"Success":{"$ref":"#/components/examples/Legal"}}}}},"4XX":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"5XX":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/5XXAPIError"}}}}}}},"post":{"description":"Use this API to edit, update and save the legal information of an application, which includes Policy, Terms and Conditions, Shipping Policy and FAQ regarding the application.","summary":"updateLegalInformation | Save legal information","tags":["Content"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Numeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Pass the updated tnc, policy, shipping and faq information in the request body. Refer `ApplicationLegal` for more details.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationLegal"},"example":{"tnc":"This is terms and condition","policy":"This is policy","faq":[{"question":"This is question","answer":"This is answer"}]}}}},"responses":{"200":{"description":"Success. Refer `ApplicationLegal` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationLegal"},"example":{"tnc":"This is terms and condition","policy":"This is policy","faq":[{"question":"This is question","answer":"This is answer"}]}}}},"4XX":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"5XX":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/5XXAPIError"}}}}}}}},"/service/platform/content/v1.0/company/{company_id}/application/{application_id}/navigations/":{"get":{"description":"Use this API to fetch the navigations details which includes the items of the navigation pane. It also shows the orientation, links, sub-navigations, etc.","summary":"getNavigations | Get navigations","tags":["Content"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Numeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}},{"name":"device_platform","in":"query","description":"Filter navigations by platform. Acceptable values are: web, android, ios, all","required":true,"schema":{"type":"string"}},{"name":"page_no","in":"query","description":"The page number to navigate through the given set of results. Default value is 1.","required":false,"schema":{"type":"integer","default":1}},{"name":"page_size","in":"query","description":"The number of items to retrieve in each page. Default value is 10.","required":false,"schema":{"type":"integer","default":10}}],"responses":{"200":{"description":"Success. Refer `NavigationGetResponse` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NavigationGetResponse"},"examples":{"default":{"$ref":"#/components/examples/NavigationGetResponse"}}}}},"4XX":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"5XX":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/5XXAPIError"}}}}}}},"post":{"description":"Navigation is the arrangement of navigational items to ease the accessibility of resources for users on a website. Use this API to create a navigation.","summary":"createNavigation | Create a navigation","tags":["Content"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Numeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Refer `NavigationRequest` for more details.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NavigationRequest"},"examples":{"default":{"$ref":"#/components/examples/NavigationRequest"}}}}},"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NavigationSchema"},"examples":{"default":{"$ref":"#/components/examples/NavigationResponse"}}}}},"4XX":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"5XX":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/5XXAPIError"}}}}}}}},"/service/platform/content/v1.0/company/{company_id}/application/{application_id}/navigations/default":{"get":{"description":"On any website (application), there are navigations that are present by default. Use this API to retrieve those default navigations.","summary":"getDefaultNavigations | Get default navigations","tags":["Content"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Numeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success. Refer `DefaultNavigationResponse` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultNavigationResponse"},"examples":{"default":{"$ref":"#/components/examples/DefaultNavigationResponse"}}}}},"4XX":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"5XX":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/5XXAPIError"}}}}}}}},"/service/platform/content/v1.0/company/{company_id}/application/{application_id}/navigations/{slug}":{"get":{"description":"Use this API to retrieve a navigation by its slug.","summary":"getNavigationBySlug | Get a navigation by slug","tags":["Content"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Numeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}},{"name":"slug","in":"path","description":"A short, human-readable, URL-friendly identifier of a navigation. You can get slug value of a navigation from `getNavigations` API.","required":true,"schema":{"type":"string"}},{"name":"device_platform","in":"query","description":"Filter navigations by platform. Acceptable values are: web, android, ios, all","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success. Refer `NavigationSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NavigationSchema"},"examples":{"default":{"$ref":"#/components/examples/NavigationResponse"}}}}},"4XX":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"5XX":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/5XXAPIError"}}}}}}}},"/service/platform/content/v1.0/company/{company_id}/application/{application_id}/navigations/{id}":{"put":{"description":"Use this API to edit the details of an existing navigation.","summary":"updateNavigation | Update a navigation","tags":["Content"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Numeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"ID allotted to the navigation.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Refer `NavigationRequest` for more details.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NavigationRequest"},"examples":{"default":{"$ref":"#/components/examples/NavigationRequest"}}}}},"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NavigationSchema"},"examples":{"default":{"$ref":"#/components/examples/NavigationResponse"}}}}},"4XX":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"5XX":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/5XXAPIError"}}}}}}},"delete":{"description":"Use this API to delete an existing navigation.","summary":"deleteNavigation | Delete a navigation","tags":["Content"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Numeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"ID allotted to the navigation.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NavigationSchema"},"examples":{"default":{"value":{"_id":"5ffbd9b90ac98678ae0458d7","application":"000000000000000000000001","_custom_json":null,"name":"temp","slug":"temp","platform":"[web]","orientation":{"portrait":["left"]},"navigation":[{"display":"Home","image":"https://res.cloudinary.com/dwzm9bysq/image/upload/v1567148153/production/system/icons/mystore-tab_y0dqzt.png","sort_order":1,"type":"","action":{"page":{"url":"/","type":"home"},"popup":{},"type":"page"},"active":true,"tags":{"type":"array","items":{"type":"string"}},"acl":["all"],"_locale_language":{"hi":{"display":""},"ar":{"display":""},"en_us":{"display":""}},"sub_navigation":[{"display":"Brands","image":"https://res.cloudinary.com/dwzm9bysq/image/upload/v1567148153/production/system/icons/brands-tab_sfinpk.png","sort_order":1,"type":"","action":{"page":{"url":"/brands/","type":"brands"},"popup":{},"type":"page"},"active":true,"tags":null,"acl":["all"],"_locale_language":{"hi":{"display":""},"ar":{"display":""},"en_us":{"display":""}}}]},{"display":"Collections","image":"https://res.cloudinary.com/dwzm9bysq/image/upload/v1567148153/production/system/icons/collections-tab_a0tg9c.png","sort_order":2,"type":"","action":{"page":{"url":"/collections/","type":"collections"},"popup":{},"type":"page"},"active":true,"tags":null,"acl":["all"],"_locale_language":{"hi":{"display":""},"ar":{"display":""},"en_us":{"display":""}},"sub_navigation":[{"display":"Categories","image":"https://res.cloudinary.com/dwzm9bysq/image/upload/v1567148154/production/system/icons/categories-tab_ss8e0q.png","sort_order":1,"type":"","action":{"page":{"url":"/categories/","type":"categories"},"popup":{},"type":"page"},"active":true,"tags":null,"acl":["all"],"_locale_language":{"hi":{"display":""},"ar":{"display":""},"en_us":{"display":""}}}]},{"display":"Primary Menu","image":"","sort_order":3,"type":"","action":{"page":{"type":"home"},"popup":{},"type":"page"},"active":true,"tags":null,"acl":["all"],"_locale_language":{"hi":{"display":""},"ar":{"display":""},"en_us":{"display":""}}}],"created_by":{"id":"000000000000000000000000"},"date_meta":{"created_on":"2021-01-11T04:53:13.585Z","modified_on":"2021-01-14T10:24:34.485Z"},"archived":true}}}}}},"4XX":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"5XX":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/5XXAPIError"}}}}}}}},"/service/platform/content/v1.0/company/{company_id}/application/{application_id}/pages/meta":{"get":{"description":"Use this API to get the meta of custom pages (blog, page) and default system pages (e.g. home/brand/category/collection).","summary":"getPageMeta | Get page meta","tags":["Content"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Numeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success. Refer `PageMetaSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageMetaSchema"},"examples":{"default":{"$ref":"#/components/examples/PageMeta"}}}}},"4XX":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"5XX":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/5XXAPIError"}}}}}}}},"/service/platform/content/v1.0/company/{company_id}/application/{application_id}/pages/spec":{"get":{"description":"Use this API to get the specifications of a page, such as page type, display name, params and query.","summary":"getPageSpec | Get page spec","tags":["Content"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Numeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success. Refer `PageSpec` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageSpec"},"examples":{"default":{"value":{"specifications":[{"page_type":"home","display_name":"Home","params":[],"query":[]},{"page_type":"collections","display_name":"Collections","params":[],"query":[]},{"page_type":"collection","display_name":"Collection","params":[{"key":"slug","required":true}],"query":[]}]}}}}}},"4XX":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"5XX":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/5XXAPIError"}}}}}}}},"/service/platform/content/v1.0/company/{company_id}/application/{application_id}/pages/preview/":{"post":{"description":"Use this API to create a page preview to check the appearance of a custom page.","summary":"createPagePreview | Create a page preview","tags":["Content"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Numeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Refer `PageRequest` for more details.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageRequest"},"examples":{"default":{"$ref":"#/components/examples/PageRequest"}}}}},"responses":{"200":{"description":"Success. Refer `PageSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageSchema"},"examples":{"default":{"$ref":"#/components/examples/PageResponse"}}}}},"4XX":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"5XX":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/5XXAPIError"}}}}}}}},"/service/platform/content/v1.0/company/{company_id}/application/{application_id}/pages/publish/{slug}":{"put":{"description":"Use this API to change the publish status of an existing page. Allows you to publish and unpublish the page.","summary":"updatePagePreview | Change the publish status of a page","tags":["Content"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Numeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}},{"name":"slug","in":"path","description":"A short, human-readable, URL-friendly identifier of a page. You can get slug value of a page from `getPages` API.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Pass a boolean value for a key named `publish` in the request body.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagePublishRequest"},"examples":{"default":{"$ref":"#/components/examples/PagePublishRequest"}}}}},"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageSchema"},"examples":{"default":{"$ref":"#/components/examples/PageResponse"}}}}},"4XX":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"5XX":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/5XXAPIError"}}}}}}}},"/service/platform/content/v1.0/company/{company_id}/application/{application_id}/pages/{id}":{"delete":{"description":"Use this API to delete an existing page.","summary":"deletePage | Delete a page","tags":["Content"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Numeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"ID allotted to the page.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageSchema"},"examples":{"default":{"$ref":"#/components/examples/PageResponse"}}}}},"4XX":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"5XX":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/5XXAPIError"}}}}}}}},"/service/platform/content/v1.0/company/{company_id}/application/{application_id}/path-mappings":{"post":{"description":"Use this API to add redirection rules","summary":"addPathRedirectionRules | Save path based redirection rules","tags":["Content"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Numeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Pass new redirection rules object. Refer `PathMappingSchema` for more details.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PathMappingSchema"},"example":{"redirect_from":"test.hostfynd.dev/redirect_from","redirect_to":"/redirect_to"}}}},"responses":{"200":{"description":"Success. Refer `PathMappingSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PathMappingSchema"},"examples":{"Success":{"$ref":"#/components/examples/PathMapping"}}}}},"4XX":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"5XX":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/5XXAPIError"}}}}}}},"get":{"description":"Use this API to get path based redirection rules.","summary":"getPathRedirectionRules | Get path based redirection rules","tags":["Content"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Numeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}},{"name":"page_size","in":"query","description":"The number of items to retrieve in each page. Default value is 5. ","required":false,"schema":{"type":"integer","default":5}},{"name":"page_no","in":"query","description":"The page number to navigate through the given set of results. Default value is 1.","required":false,"schema":{"type":"integer","default":1}}],"responses":{"200":{"description":"Success. Refer `PathMappingSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PathMappingSchema"},"examples":{"Success":{"$ref":"#/components/examples/PathMapping"}}}}},"4XX":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"5XX":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/5XXAPIError"}}}}}}}},"/service/platform/content/v1.0/company/{company_id}/application/{application_id}/path-mappings/{path_id}":{"get":{"description":"Use this API to get path based redirection rule.","summary":"getPathRedirectionRule | Get path based redirection rule","tags":["Content"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Numeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}},{"name":"path_id","in":"path","description":"ID allotted to the path redirection rule.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success. Refer `PathMappingSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PathMappingSchema"},"examples":{"Success":{"$ref":"#/components/examples/PathMapping"}}}}},"4XX":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"5XX":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/5XXAPIError"}}}}}}},"put":{"description":"Use this API to update redirection rules","summary":"updatePathRedirectionRules | Update path based redirection rules","tags":["Content"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Numeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}},{"name":"path_id","in":"path","description":"ID allotted to the path redirection rule.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Pass updated redirection rules object. Refer `PathMappingSchema` for more details.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PathMappingSchema"},"example":{"redirect_from":"test.hostfynd.dev/redirect_from","redirect_to":"/redirect_to"}}}},"responses":{"200":{"description":"Success. Refer `PathMappingSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PathMappingSchema"},"examples":{"Success":{"$ref":"#/components/examples/PathMapping"}}}}},"4XX":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"5XX":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/5XXAPIError"}}}}}}},"delete":{"description":"Use this API to delete redirection rules","summary":"deletePathRedirectionRules | Delete path based redirection rules","tags":["Content"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Numeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}},{"name":"path_id","in":"path","description":"ID allotted to the path redirection rule.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"type":"object"},"example":{"message":"Redirection deleted successfully"}}}},"4XX":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"5XX":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/5XXAPIError"}}}}}}}},"/service/platform/content/v1.0/company/{company_id}/application/{application_id}/seo":{"get":{"description":"Use this API to know how the SEO is configured in the application. This includes the sitemap, robot.txt, custom meta tags, etc.","summary":"getSEOConfiguration | Get SEO configuration of an application","tags":["Content"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Numeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success. Refer `SeoComponent` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SeoComponent"},"examples":{"default":{"$ref":"#/components/examples/Seo"}}}}},"4XX":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"5XX":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/5XXAPIError"}}}}}}},"post":{"description":"Use this API to edit the SEO details of an application. This includes the sitemap, robot.txt, custom meta tags, etc.","summary":"updateSEOConfiguration | Update SEO of application","tags":["Content"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Numeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Refer `SeoComponent` for more details.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SeoComponent"},"examples":{"default":{"$ref":"#/components/examples/Seo"}}}}},"responses":{"200":{"description":"Success. Refer `SeoSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SeoSchema"},"examples":{"default":{"value":{"details":{"title":"Zyosa Zyosa","description":"","image_url":""},"robots_txt":"User-agent: * \nAllow: / \nsancisciasn xwsaixjowqnxwsiwjs","sitemap_enabled":false,"_id":"6009819ee463ad40de397eb2","app":"000000000000000000000001","created_at":"2021-01-21T13:29:02.543Z","updated_at":"2021-02-05T06:36:16.048Z","__v":11,"custom_meta_tags":[{"name":"test 0000","content":"<meta name=\"test\" content=\"0000 cn dcje dcj rejre cjrenurenc \">","_id":"6017c301bde3c21dbb13b284"},{"name":"cwdcdc","content":"<meta content=\"wdcewdewc\">","_id":"6017c675bde3c22cfb13b290"}]}}}}}},"4XX":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"5XX":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/5XXAPIError"}}}}}}}},"/service/platform/content/v1.0/company/{company_id}/application/{application_id}/seo/schema/default":{"get":{"description":"Use this API to get the Default SEO Markup schema Templates setup for an application","summary":"getDefaultSEOMarkupSchema | Get Default SEO Markup schemas of an application","tags":["Content"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Numeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}},{"name":"page_type","in":"query","description":"The type of page against which schema template was created","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success. Refer `DefaultSchemaComponent` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultSchemaComponent"}}}},"4XX":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"5XX":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/5XXAPIError"}}}}}}}},"/service/platform/content/v1.0/company/{company_id}/application/{application_id}/seo/schema":{"get":{"description":"Use this API to get all SEO Markup schema Templates setup for an application","summary":"getSEOMarkupSchemas | Get SEO Markup schemas of an application","tags":["Content"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Numeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}},{"name":"title","in":"query","description":"Title of the seo schema.","required":false,"schema":{"type":"string"}},{"name":"active","in":"query","description":"Boolean value for fetching seo schema.","required":false,"schema":{"type":"string"}},{"name":"page_no","in":"query","description":"The page number to navigate through the given set of results. Default value is 1.","required":false,"schema":{"type":"integer","default":1}},{"name":"page_size","in":"query","description":"The number of items to retrieve in each page. Default value is 10.","required":false,"schema":{"type":"integer","default":10}}],"responses":{"200":{"description":"Success. Refer `SeoSchemaComponent` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SeoSchemaComponent"}}}},"4XX":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"5XX":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/5XXAPIError"}}}}}}},"post":{"description":"Use this API to create a SEO Markup schema Template inside an application","summary":"createSEOMarkupSchema | Create a SEO Markup schema Template of a page type for an application","tags":["Content"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Alphanumeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Refer `SEOSchemaMarkupTemplateRequestBody` for more details.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SEOSchemaMarkupTemplateRequestBody"}}}},"responses":{"200":{"description":"Success. Refer `SEOSchemaMarkupTemplate` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SEOSchemaMarkupTemplate"}}}},"4XX":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"5XX":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/5XXAPIError"}}}}}}}},"/service/platform/content/v1.0/company/{company_id}/application/{application_id}/seo/schema/{id}":{"get":{"description":"Use this API to get a existing SEO Markup schema an application","summary":"getSEOMarkupSchema | Get a particular SEO Markup schema of an application using its id","tags":["Content"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Alphanumeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Alphanumeric ID allotted to a SEO Markup Schema Template created within a business.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success. Refer `SEOSchemaMarkupTemplate` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SEOSchemaMarkupTemplate"}}}},"4XX":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"5XX":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/5XXAPIError"}}}}}}},"put":{"description":"Use this API to edit an existing SEO Markup schema an application","summary":"editSEOMarkupSchema | Get a particular SEO Markup schema of an application using its id","tags":["Content"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Alphanumeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Alphanumeric ID allotted to a SEO Markup Schema Template created within a business.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Refer `SEOSchemaMarkupTemplateRequestBody` for more details.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SEOSchemaMarkupTemplateRequestBody"}}}},"responses":{"200":{"description":"Success. Refer `SEOSchemaMarkupTemplate` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SEOSchemaMarkupTemplate"}}}},"4XX":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"5XX":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/5XXAPIError"}}}}}}},"delete":{"description":"Use this API to delete an existing SEO Markup schema an application","summary":"deleteSEOMarkupSchema | delete a particular SEO Markup schema of an application using its id","tags":["Content"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Alphanumeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Alphanumeric ID allotted to a SEO Markup Schema Template created within a business.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success. Refer `SEOSchemaMarkupTemplate` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SEOSchemaMarkupTemplate"}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}}}}},"/service/platform/content/v1.0/company/{company_id}/application/{application_id}/slideshows":{"get":{"description":"A slideshow is a group of images, videos or a combination of both that are shown on the website in the form of slides. Use this API to fetch a list of slideshows.","summary":"getSlideshows | Get slideshows","tags":["Content"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Numeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}},{"name":"device_platform","in":"query","description":"Filter slideshows by platform. Acceptable values are: web, android, ios and all","required":true,"schema":{"type":"string"}},{"name":"page_no","in":"query","description":"The page number to navigate through the given set of results. Default value is 1.","required":false,"schema":{"type":"integer","default":1}},{"name":"page_size","in":"query","description":"The number of items to retrieve in each page. Default value is 10.","required":false,"schema":{"type":"integer","default":10}}],"responses":{"200":{"description":"Success. Refer `SlideshowGetResponse` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SlideshowGetResponse"},"examples":{"default":{"$ref":"#/components/examples/SlideshowGetResponse"}}}}},"4XX":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"5XX":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/5XXAPIError"}}}}}}},"post":{"description":"A slideshow is a group of images, videos or a combination of both that are shown on the website in the form of slides. Use this API to create a slideshow.","summary":"createSlideshow | Create a slideshow","tags":["Content"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Numeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Refer `SlideshowRequest` for more details.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SlideshowRequest"},"examples":{"default":{"$ref":"#/components/examples/SlideshowRequest"}}}}},"responses":{"200":{"description":"Success. Refer `SlideshowSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SlideshowSchema"},"examples":{"default":{"$ref":"#/components/examples/SlideshowResponse"}}}}},"4XX":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"5XX":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/5XXAPIError"}}}}}}}},"/service/platform/content/v1.0/company/{company_id}/application/{application_id}/slideshows/{slug}":{"get":{"description":"Use this API to retrieve the details of a slideshow by its slug.","summary":"getSlideshowBySlug | Get slideshow by slug","tags":["Content"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Numeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}},{"name":"slug","in":"path","description":"A short, human-readable, URL-friendly identifier of a slideshow. You can get slug value of a page from `getSlideshows` API.","required":true,"schema":{"type":"string"}},{"name":"device_platform","in":"query","description":"Filter slideshows by platform. Acceptable values are: web, android, ios and all","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success. Refer `SlideshowSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SlideshowSchema"},"examples":{"default":{"$ref":"#/components/examples/SlideshowResponse"}}}}},"4XX":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"5XX":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/5XXAPIError"}}}}}}}},"/service/platform/content/v1.0/company/{company_id}/application/{application_id}/slideshows/{id}":{"put":{"description":"Use this API to edit the details of an existing slideshow.","summary":"updateSlideshow | Update a slideshow","tags":["Content"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Numeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"ID allotted to the slideshow.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Refer `SlideshowRequest` for more details.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SlideshowRequest"},"examples":{"default":{"$ref":"#/components/examples/SlideshowRequest"}}}}},"responses":{"200":{"description":"Success. Refer `SlideshowSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SlideshowSchema"},"examples":{"default":{"$ref":"#/components/examples/SlideshowResponse"}}}}},"4XX":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"5XX":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/5XXAPIError"}}}}}}},"delete":{"description":"Use this API to delete an existing slideshow.","summary":"deleteSlideshow | Delete a slideshow","tags":["Content"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Numeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"ID allotted to the slideshow.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SlideshowSchema"},"examples":{"default":{"value":{"date_meta":{"created_on":"2021-03-14T05:27:12.319Z","modified_on":"2021-03-14T05:27:12.319Z"},"archived":true,"_id":"604d9eb975e9d136bb1b8b83","configuration":{"start_on_launch":false,"duration":50,"sleep_time":100,"slide_direction":"horizontal"},"slug":"ss-sfsd-updated","platform":"ios","media":[{"auto_decide_duration":false,"type":"image","url":"https://res.cloudinary.com/dwzm9bysq/image/upload/v1567148153/production/system/icons/brands-tab_sfinpk.png","bg_color":"#ffffff","duration":10,"action":{"type":""}},{"auto_decide_duration":true,"type":"youtube","url":"https://www.youtube.com/embed/9vJRopau0g0","bg_color":"#ffffff","duration":909,"action":{"type":""}}],"application":"5cd3db5e9d692cfe5302a7bb","active":true}}}}}},"4XX":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"5XX":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/5XXAPIError"}}}}}}}},"/service/platform/content/v1.0/company/{company_id}/application/{application_id}/support":{"get":{"description":"Use this API to get the contact details for customer support, including emails and phone numbers.","summary":"getSupportInformation | Get support information","tags":["Content"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform.","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Alphanumeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success. Refer `Support` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Support"},"examples":{"default":{"$ref":"#/components/examples/Support"}}}}},"4XX":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"5XX":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/5XXAPIError"}}}}}}},"post":{"description":"Use this API to edit the existing contact details for customer support, including emails and phone numbers.","summary":"updateSupportInformation | Update the support data of an application","tags":["Content"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform.","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Alphanumeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Refer `Support` for more details.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Support"},"examples":{"default":{"$ref":"#/components/examples/Support"}}}}},"responses":{"200":{"description":"Success. Refer `Support` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Support"},"examples":{"default":{"$ref":"#/components/examples/Support"}}}}},"4XX":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"5XX":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/5XXAPIError"}}}}}}}},"/service/platform/content/v1.0/company/{company_id}/application/{application_id}/tags":{"put":{"description":"Use this API to edit and override all existing tags. All existing tags will be replaced by the new tags provided in body. ","summary":"updateInjectableTag | Update the exisitng tags for an application by replacing with provided tags","tags":["Content"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform.","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Alphanumeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Pass the updated name, tag type (css/js), url and position of the tag in the request body. Refer `CreateTagRequestSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTagRequestSchema"},"example":{"tags":[{"name":"Test","sub_type":"external","_id":"601f77e7aa61066feda44488","type":"js","url":"youtube.com/watch?v=AaxFIY-cWH0&list=PL3O3jhFJEElBHFbs6XsOqZAWZLtlEkZTw&index=31","position":"head"},{"name":"Test 2","sub_type":"external","_id":"601f77e7aa61066feda44489","type":"js","url":"youtube.com/watch?v=AaxFIY-cWH0&list=PL3O3jhFJEElBHFbs6XsOqZAWZLtlEkZTw&index=31","position":"head"}]}}}},"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagsSchema"},"example":{"_id":"601f77e7aa61066feda44487","tags":[{"name":"Test","sub_type":"external","_id":"601f77e7aa61066feda44488","type":"js","url":"youtube.com/watch?v=AaxFIY-cWH0&list=PL3O3jhFJEElBHFbs6XsOqZAWZLtlEkZTw&index=31","position":"head"},{"name":"Test 2","sub_type":"external","_id":"601f77e7aa61066feda44489","type":"js","url":"youtube.com/watch?v=AaxFIY-cWH0&list=PL3O3jhFJEElBHFbs6XsOqZAWZLtlEkZTw&index=31","position":"head"}],"application":"000000000000000000000001","__v":0}}}},"4XX":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"5XX":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/5XXAPIError"}}}}}}},"get":{"description":"Use this API to get the CSS and JS injected in the application in the form of tags.","summary":"getInjectableTags | Get all the tags in an application","tags":["Content"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform.","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Alphanumeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}},{"name":"all","in":"query","description":"Get all tags irrespective of the creator of tags","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Success. Refer `TagsSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagsSchema"},"example":{"_id":"601f77e7aa61066feda44487","tags":[{"name":"Test","sub_type":"external","_id":"601f77e7aa61066feda44488","type":"js","url":"youtube.com/watch?v=AaxFIY-cWH0&list=PL3O3jhFJEElBHFbs6XsOqZAWZLtlEkZTw&index=31","position":"head"},{"name":"Test 2","sub_type":"external","_id":"601f77e7aa61066feda44489","type":"js","url":"youtube.com/watch?v=AaxFIY-cWH0&list=PL3O3jhFJEElBHFbs6XsOqZAWZLtlEkZTw&index=31","position":"head"}],"application":"000000000000000000000001","__v":0}}}},"4XX":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"5XX":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/5XXAPIError"}}}}}}}},"/service/platform/content/v1.0/company/{company_id}/application/{application_id}/tags/add":{"put":{"description":"CSS and JS can be injected in the application (website) with the help of tags. Use this API to create such tags by entering the tag name, tag type (css/js), url and position of the tag.","summary":"addInjectableTag | Add a tag","tags":["Content"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform.","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Alphanumeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Pass the name, tag type (css/js), url and position of the tag in the request body. Refer `CreateTagRequestSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTagRequestSchema"},"example":{"tags":[{"name":"Test","sub_type":"external","_id":"601f77e7aa61066feda44488","type":"js","url":"youtube.com/watch?v=AaxFIY-cWH0&list=PL3O3jhFJEElBHFbs6XsOqZAWZLtlEkZTw&index=31","position":"head"}]}}}},"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagsSchema"},"example":{"_id":"601f77e7aa61066feda44487","tags":[{"name":"Test","sub_type":"external","_id":"601f77e7aa61066feda44488","type":"js","url":"youtube.com/watch?v=AaxFIY-cWH0&list=PL3O3jhFJEElBHFbs6XsOqZAWZLtlEkZTw&index=31","position":"head"}],"application":"000000000000000000000001","__v":0}}}},"4XX":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"5XX":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/5XXAPIError"}}}}}}}},"/service/platform/content/v1.0/company/{company_id}/application/{application_id}/tags/remove/handpicked":{"put":{"description":"Use this API to delete an existing tag.","summary":"removeInjectableTag | Remove a tag","tags":["Content"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform.","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Alphanumeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Refer `RemoveHandpickedSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoveHandpickedSchema"},"example":{"tags":["5fe1896e1eaee246f41faaaf"]}}}},"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagDeleteSuccessResponse"},"example":{"success":true}}}},"4XX":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"5XX":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/5XXAPIError"}}}}}}}},"/service/platform/content/v1.0/company/{company_id}/application/{application_id}/tags/edit/handpicked/{tag_id}":{"put":{"description":"Use this API to edit the details of an existing tag by its ID.","summary":"editInjectableTag | Edit a tag by id","tags":["Content"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform.","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Alphanumeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}},{"name":"tag_id","in":"path","description":"ID allotted to the tag.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Tag. Refer `UpdateHandpickedSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateHandpickedSchema"},"example":{"tag":{"attributes":{},"name":"floating whatsapp","type":"css","sub_type":"inline","content":".float{\n\tposition:fixed;\n\twidth:60px;\n\theight:60px;\n\tbottom:40px;\n\tright:40px;\n\tbackground-color:#25d366;\n\tcolor:#FFF;\n\tborder-radius:50px;\n\ttext-align:center;\n  font-size:30px;\n\tbox-shadow: 2px 2px 3px #999;\n  z-index:100;\n}\n\n.my-float{\n\tmargin-top:16px;\n}","position":"head"}}}}},"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagsSchema"},"example":{"_id":"602671b3c0bac99158b10874","application":"000000000000000000000001","tags":[{"_id":"601f77e7aa61066feda44488","name":"floating whatsapp","sub_type":"inline","type":"css","position":"head","content":".float{\n\tposition:fixed;\n\twidth:60px;\n\theight:60px;\n\tbottom:40px;\n\tright:40px;\n\tbackground-color:#25d366;\n\tcolor:#FFF;\n\tborder-radius:50px;\n\ttext-align:center;\n  font-size:30px;\n\tbox-shadow: 2px 2px 3px #999;\n  z-index:100;\n}\n\n.my-float{\n\tmargin-top:16px;\n}"}],"__v":1}}}},"4XX":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"5XX":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/5XXAPIError"}}}}}}}},"/service/platform/content/v2.0/company/{company_id}/application/{application_id}/blogs/{slug}":{"get":{"summary":"getBlogBySlug | Get blog by slug","description":"Use this API to retrieve the components of a blog, such as title, slug, feature image, content, schedule, publish status, author, etc.","tags":["Content"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Numeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}},{"name":"slug","in":"path","description":"A short, human-readable, URL-friendly identifier of a blog page. You can get slug value of a blog from `getBlogs` API.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success. Returns a a JSON object with components. Refer `BlogSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlogSchema"},"examples":{"default":{"$ref":"#/components/examples/BlogResponse"}}}}},"4XX":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"5XX":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/5XXAPIError"}}}}}}}},"/service/platform/content/v2.0/company/{company_id}/application/{application_id}/pages/":{"post":{"description":"Use this API to create a custom page using a title, seo, publish status, feature image, tags, meta, etc.","summary":"createPage | Create a page","tags":["Content"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Numeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Refer `PageRequest` for more details.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageRequest"},"examples":{"default":{"$ref":"#/components/examples/PageRequest"}}}}},"responses":{"200":{"description":"Success. Refer `PageSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageSchema"},"examples":{"default":{"$ref":"#/components/examples/PageResponse"}}}}},"4XX":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"5XX":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/5XXAPIError"}}}}}}},"get":{"description":"Use this API to retrieve a list of pages.","summary":"getPages | Get a list of pages","tags":["Content"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Numeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}},{"name":"page_no","in":"query","description":"The page number to navigate through the given set of results. Default value is 1.","required":false,"schema":{"type":"integer","default":1}},{"name":"page_size","in":"query","description":"The number of items to retrieve in each page. Default value is 10.","required":false,"schema":{"type":"integer","default":10}}],"responses":{"200":{"description":"Success. Refer `PageGetResponse` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageGetResponse"},"examples":{"default":{"$ref":"#/components/examples/PageGetResponse"}}}}},"4XX":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"5XX":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/5XXAPIError"}}}}}}}},"/service/platform/content/v2.0/company/{company_id}/application/{application_id}/pages/{id}":{"put":{"description":"Use this API to edit the details of an existing page, such as its title, seo, publish status, feature image, tags, schedule, etc.","summary":"updatePage | Update a page","tags":["Content"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Numeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"ID allotted to the page.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Refer `PageSchema` for more details.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageSchema"},"examples":{"default":{"$ref":"#/components/examples/PageRequest"}}}}},"responses":{"200":{"description":"Success. Refer `PageSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageSchema"},"examples":{"default":{"$ref":"#/components/examples/PageResponse"}}}}},"4XX":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"5XX":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/5XXAPIError"}}}}}}}},"/service/platform/content/v2.0/company/{company_id}/application/{application_id}/pages/{slug}":{"get":{"summary":"getPageBySlug | Get page by slug","description":"Use this API to retrieve the components of a page, such as its title, seo, publish status, feature image, tags, schedule, etc.","tags":["Content"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Numeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}},{"name":"slug","in":"path","description":"A short, human-readable, URL-friendly identifier of a page. You can get slug value of a page from `getPages` API.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success. Returns a JSON object of components. Refer `PageSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageSchema"},"examples":{"default":{"$ref":"#/components/examples/PageResponse"}}}}},"4XX":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"5XX":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/5XXAPIError"}}}}}}}},"/service/platform/content/v1.0/company/{company_id}/metafields/types":{"get":{"summary":"getCustomFieldTypes | Get custom field types","description":"Use this API to retrieve the custom field types ","tags":["Content"],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","description":"This is company id"},"examples":{"success":{"value":1},"failure":{"value":10},"success1":{"value":1},"success2":{"value":2},"duplicateFieldExample":{"value":11},"validationErrorExample":{"value":12},"failure2":{"value":10}}}],"responses":{"200":{"description":"Success. Returns all custom field types. ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomObjectByIdSchema"},"examples":{"success":{"value":{"metafield_types":{"string_single_line":{"name":"Single Line Text","list_enabled":true,"category":"TEXT","type":"string","supported_validations":[{"name":"min","type":"integer","display":"Minimum Characters"},{"name":"max","type":"integer","display":"Maximum Characters"},{"name":"regex","type":"string","display":"Regular Expression","meta":{"examples":[{"name":"Alphabet Characters","value":"^[a-zA-Z]+$"},{"name":"Alphanumeric Characters","value":"^[a-zA-Z0-9]+$"},{"name":"Numeric Characters","value":"^[0-9]+$"},{"name":"Email Address","value":"^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$"}]}},{"name":"choices","type":"string_array","display":"Choices"}]},"string_multi_line":{"name":"Multi Line Text","list_enabled":true,"category":"TEXT","type":"string","supported_validations":[{"name":"min","type":"integer","display":"Minimum Characters"},{"name":"max","type":"integer","display":"Maximum Characters"}]},"dropdown":{"name":"Dropdown","list_enabled":true,"category":"TEXT","type":"string","supported_validations":[{"name":"choices","type":"string_array","display":"Choices","required":true}]},"integer":{"name":"Integer","list_enabled":true,"type":"integer","category":"NUMBER","supported_validations":[{"name":"min","type":"integer","display":"Minimum Value"},{"name":"max","type":"integer","display":"Maximum Value"},{"name":"choices","type":"integer_array","display":"Choices"}]},"float_type":{"name":"Decimal","list_enabled":true,"type":"float","category":"NUMBER","supported_validations":[{"name":"min","type":"float","display":"Minimum Value"},{"name":"max","type":"float","display":"Maximum Value"},{"name":"choices","type":"float_array","display":"Choices"}]},"boolean_type":{"name":"Boolean","category":"TRUE_FALSE","list_enabled":false,"type":"boolean","supported_validations":[]},"date":{"name":"Date","list_enabled":true,"category":"DATETIME","type":"date","supported_validations":[{"name":"min","type":"date","display":"From Date"},{"name":"max","type":"date","display":"To Date"}]},"datetime":{"name":"Date - Time","category":"DATETIME","list_enabled":true,"type":"datetime","supported_validations":[{"name":"min","type":"date","display":"From Date & Time"},{"name":"max","type":"date","display":"To Date & Time"}]},"json":{"name":"JSON","list_enabled":false,"category":"ADVANCED","type":"json","supported_validations":[{"name":"schema","type":"json","display":"JSON Schema"}]},"file":{"name":"File","category":"REFERENCE","list_enabled":true,"type":"string","supported_validations":[{"name":"file_type_options","type":"string_array","meta":{"options":[{"image":{"supported_types":["jpeg","jpg","png","svg+xml","tiff","webp","gif"],"max_size":20971520},"video":{"supported_types":["x-flv","mp4","x-mpegURL","MP2T","3gpp","/quicktime","x-msvideo","x-ms-wmv","webm"],"max_size":1048576000}}]}}]},"url":{"name":"URL","list_enabled":true,"type":"string","supported_validations":[{"name":"allowed_domains","display":"Allowed Domains","type":"string_array"}]},"metaobject":{"name":"Custom Object","list_enabled":true,"category":"REFERENCE","type":"string","supported_validations":[{"name":"metaobject_definition_id","display":"Reference","type":"string","required":true}]},"product":{"name":"Product","list_enabled":true,"category":"REFERENCE","type":"string","supported_validations":[],"scope":["company","application"]}}}}}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"}}}}}}},"/service/platform/content/v1.0/company/{company_id}/metafields/resources":{"get":{"summary":"getResources | Get resources","description":"Use this API to retrieve the resources, such as products, collections, customers, selling locations, etc.","tags":["Content"],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","description":"This is company id"},"examples":{"success":{"value":1},"failure":{"value":10},"success1":{"value":1},"success2":{"value":2},"duplicateFieldExample":{"value":11},"validationErrorExample":{"value":12},"failure2":{"value":10}}}],"responses":{"200":{"description":"Success. Returns a JSON object of resources. Refer `ResourcesSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourcesSchema"},"examples":{"success":{"$ref":"#/components/examples/ResourceResponse"}}}}},"4XX":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"5XX":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/5XXAPIError"}}}}}}}},"/service/platform/content/v1.0/company/{company_id}/metafields/definitions":{"get":{"summary":"getCustomFieldDefinitions | Get custom fields definitions","description":"Use this API to retrieve the definitions of custom fields.","tags":["Content"],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","description":"This is company id"},"examples":{"success":{"value":1},"failure":{"value":10},"success1":{"value":1},"success2":{"value":2},"duplicateFieldExample":{"value":11},"validationErrorExample":{"value":12},"failure2":{"value":10}}},{"name":"page_no","in":"query","required":true,"schema":{"type":"string","description":"This is the page number"},"examples":{"success":{"value":1},"failure":{"value":1}}},{"name":"page_size","in":"query","required":true,"schema":{"type":"string","description":"This is the page size"},"examples":{"success":{"value":10},"failure":{"value":10}}},{"name":"resource","in":"query","required":false,"schema":{"type":"string","description":"This is the resource for which we are fetching definitions"},"examples":{"success":{"value":"product"},"failure":{"value":"some"}}},{"name":"type","in":"query","required":false,"schema":{"type":"string","description":"This is the type of the custom fields definitions"},"examples":{"success":{"value":"string_single_line"},"failure":{"value":"string_single"}}},{"name":"search","in":"query","required":false,"schema":{"type":"string","description":"This is the search text to filter custom fields definitions"},"examples":{"success":{"value":"sometext"},"failure":{"value":"sometext"}}}],"responses":{"200":{"description":"Success. Returns a list of custom fields definitions. Refer `CustomFieldDefinitionsSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFieldDefinitionsSchema"},"examples":{"success":{"$ref":"#/components/examples/CustomFieldDefinitionsResponse"}}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"failure":{"$ref":"#/components/examples/4XXAPIError"}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"}}}}}},"post":{"summary":"createCustomFieldDefinition | Create custom field definition","description":"Use this API to create a custom field definition for your application.","tags":["Content"],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","description":"This is company id"},"examples":{"success":{"value":1},"failure":{"value":10},"success1":{"value":1},"success2":{"value":2},"duplicateFieldExample":{"value":11},"validationErrorExample":{"value":12},"failure2":{"value":10}}}],"requestBody":{"description":"Custom field definition data","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFieldDefinitionRequestSchema"},"examples":{"success1":{"value":{"resource":"product","type":"string_single_line","key":"fname","namespace":"fname","multi_value":false,"name":"name","description":"First name"}},"success2":{"value":{"resource":"product","type":"boolean","key":"isActive","namespace":"isactive","multi_value":false,"name":"isActive","description":"Is Active"}},"failure":{"value":{"resource":"product","type":"metaobject","key":"color","namespace":"custom_app2i","multi_value":true,"name":"Color","description":"test description","validations":[{"name":"metaobject_definition_id","value":"65070612a6d40266c48baac3"}]}},"duplicateFieldExample":{"value":{"resource":"product","type":"string_single_line","namespace":"custom","description":"","name":"test","multi_value":false,"key":"test","validations":[]}},"validationErrorExample":{"value":{"resource":"product","type":"string_single_line","namespace":"custom","description":"","name":"","multi_value":false,"key":"test","validations":[]}}}}}},"responses":{"200":{"description":"Custom field definition created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFieldDefinitionDetailResSchema"},"examples":{"success1":{"$ref":"#/components/examples/CustomFieldDefinitionDetailResponse"},"success2":{"$ref":"#/components/examples/CustomFieldDefinitionDetailResponse"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"duplicateFieldExample":{"$ref":"#/components/examples/CustomFieldDefinitionDuplicateFieldError"},"validationErrorExample":{"$ref":"#/components/examples/CustomFieldDefinitionValidationErrorExample"}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"}}}}}}},"/service/platform/content/v1.0/company/{company_id}/metafields/definitions/{definition_id}":{"get":{"summary":"getCustomFieldDefinition | Get custom fields definition by id","description":"Use this API to retrieve the definitions of custom fields using definition_id.","tags":["Content"],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","description":"This is company id"},"examples":{"success":{"value":1},"failure":{"value":10},"success1":{"value":1},"success2":{"value":2},"duplicateFieldExample":{"value":11},"validationErrorExample":{"value":12},"failure2":{"value":10}}},{"name":"definition_id","in":"path","required":true,"schema":{"type":"string","description":"This is definition id"},"examples":{"success":{"value":"65369afad436ae0e54147e86"},"failure":{"value":"5eda528b97457fe43a733acd"}}}],"responses":{"200":{"description":"Success. Returns a object of custom field definition. Refer `CustomFieldDefinitionsSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFieldDefinitionDetailResSchema"},"examples":{"success":{"$ref":"#/components/examples/CustomFieldDefinitionsResponse"}}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"failure":{"$ref":"#/components/examples/4XXAPIError"}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"}}}}}},"put":{"summary":"updateCustomFieldDefinition | Update custom field definition","description":"Use this API to update a custom field definition for your application.","tags":["Content"],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","description":"This is company id"},"examples":{"success":{"value":1},"failure":{"value":10},"success1":{"value":1},"success2":{"value":2},"duplicateFieldExample":{"value":11},"validationErrorExample":{"value":12},"failure2":{"value":10}}},{"name":"definition_id","in":"path","required":true,"schema":{"type":"string","description":"This is definition id"},"examples":{"success":{"value":"65369afad436ae0e54147e86"},"failure":{"value":"5eda528b97457fe43a733acd"}}}],"requestBody":{"description":"Custom field definition data","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFieldDefinitionRequestSchema"},"examples":{"success1":{"$ref":"#/components/examples/CustomFieldCreationSuccessExample1"},"success2":{"$ref":"#/components/examples/CustomFieldCreationSuccessExample2"},"failure":{"$ref":"#/components/examples/CustomFieldCreationsFailureExample"}}}}},"responses":{"200":{"description":"Custom field definition created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFieldDefinitionDetailResSchema"},"examples":{"success":{"$ref":"#/components/examples/CustomFieldDefinitionDetailResponse"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"}}}}}},"delete":{"summary":"deleteCustomFieldDefinition | Delete custom fields definition.","description":"Use this API to delete the definitions of custom fields using definition_id. This will also delete related custom fields entries related to this definition.","tags":["Content"],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","description":"This is company id"},"examples":{"success":{"value":1},"failure":{"value":10},"success1":{"value":1},"success2":{"value":2},"duplicateFieldExample":{"value":11},"validationErrorExample":{"value":12},"failure2":{"value":10}}},{"name":"definition_id","in":"path","required":true,"schema":{"type":"string","description":"This is definition id"},"examples":{"success":{"value":"65369afad436ae0e54147e86"},"failure":{"value":"5eda528b97457fe43a733acd"}}}],"responses":{"200":{"description":"Success. It will returns the message for delete successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomDataDeleteSchema"},"examples":{"success":{"$ref":"#/components/examples/CustomDataDeleteResponse"}}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"failure":{"value":{"status":404,"message":"No such metafield definition found","code":"CX-1013","exception":"","request_id":"","stack_trace":"","meta":{}}}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"}}}}}}},"/service/platform/content/v1.0/company/{company_id}/metafields/{resource}":{"get":{"summary":"getCustomFields | Get list of custom fields of given resource","description":"Use this API to retrieve the custom fields for given resource in param.","tags":["Content"],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","description":"This is company id"},"examples":{"success":{"value":1},"failure":{"value":10},"success1":{"value":1},"success2":{"value":2},"duplicateFieldExample":{"value":11},"validationErrorExample":{"value":12},"failure2":{"value":10}}},{"name":"resource","in":"path","required":true,"schema":{"type":"string","description":"This is the name of resource for which you want to fetch custom fields eg. product, collection, customer etc."},"examples":{"success":{"value":"product"},"failure":{"value":"inventory"}}}],"responses":{"200":{"description":"Success. Returns a list of custom fields. Refer `CustomFieldsResponseSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFieldsResponseSchema"},"examples":{"success":{"$ref":"#/components/examples/CustomFieldsResponse"}}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"failure":{"$ref":"#/components/examples/4XXAPIError"}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/5XXAPIError"}}}}}}}},"/service/platform/content/v1.0/company/{company_id}/metafields/{resource}/{resource_id}":{"get":{"summary":"getCustomFieldsByResourceId | Get list of custom fields of given resource and resource id","description":"Use this API to retrieve the custom fields for given resource in param.","tags":["Content"],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","description":"This is company id"},"examples":{"success":{"value":1},"failure":{"value":10},"success1":{"value":1},"success2":{"value":2},"duplicateFieldExample":{"value":11},"validationErrorExample":{"value":12},"failure2":{"value":10}}},{"name":"resource","in":"path","required":true,"schema":{"type":"string","description":"This is the name of resource for which you want to fetch custom fields eg. product, collection, customer etc."},"examples":{"success":{"value":"product"},"failure":{"value":"inventory"}}},{"name":"resource_id","in":"path","required":true,"schema":{"type":"string","description":"This is the resource id for which custom fields created"},"examples":{"success":{"value":"64bb987e9a3c4b6c29d676bc"},"failure":{"value":"64bb987e9a3c4b6c29d67eee"}}}],"responses":{"200":{"description":"Success. Returns a list of custom fields. Refer `CustomFieldsResponseByResourceIdSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFieldsResponseByResourceIdSchema"},"examples":{"success":{"value":{"items":[{"_id":"65705772a20cc45d3f2585b3","namespace":"custom","key":"designer-name","resource":"product","creator":"company","value":["ramsons"],"resource_id":"7612437","type":"string_single_line","multi_value":false,"company_id":"2","definition_id":"65604cdb6a78c23f082c850b","has_invalid_values":false,"invalid_value_errors":[],"created_by":"bd7223b6727eb087987eece7","is_deleted":false,"created_at":"2023-12-06T11:13:54.217Z","updated_at":"2023-12-06T11:19:02.311Z","updated_by":"bd7223b6727eb087987eece7"},{"_id":"65705772a20cc45d3f2585b4","namespace":"custom","key":"manufactures","resource":"product","creator":"company","value":["kartik"],"resource_id":"7612437","type":"string_single_line","multi_value":false,"company_id":"2","definition_id":"655f53ddca37f5deb832a185","has_invalid_values":false,"invalid_value_errors":[],"created_by":"bd7223b6727eb087987eece7","is_deleted":false,"created_at":"2023-12-06T11:13:54.218Z","updated_at":"2023-12-06T11:19:02.311Z","updated_by":"bd7223b6727eb087987eece7"},{"_id":"65705772a20cc45d3f2585b1","namespace":"custom","key":"product-designer","resource":"product","creator":"company","value":["65702b4574c5764716ee671d"],"resource_id":"7612437","type":"metaobject","multi_value":true,"company_id":"2","definition_id":"656d6bc9766f9511345091a6","has_invalid_values":false,"invalid_value_errors":[],"created_by":"bd7223b6727eb087987eece7","is_deleted":false,"created_at":"2023-12-06T11:13:54.217Z","updated_at":"2023-12-06T11:19:02.311Z","updated_by":"bd7223b6727eb087987eece7"},{"_id":"65705772a20cc45d3f2585b2","namespace":"custom","key":"validation-check","resource":"product","creator":"company","value":["ram"],"resource_id":"7612437","type":"string_single_line","multi_value":false,"company_id":"2","definition_id":"656866a30152b0584464d547","has_invalid_values":false,"invalid_value_errors":[],"created_by":"bd7223b6727eb087987eece7","is_deleted":false,"created_at":"2023-12-06T11:13:54.217Z","updated_at":"2023-12-06T11:19:02.311Z","updated_by":"bd7223b6727eb087987eece7"}]}}}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"failure":{"$ref":"#/components/examples/4XXAPIError"}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"}}}}}},"put":{"summary":"createCustomFieldByResourceId | Create custom field entries for gives resource and resource_id","description":"Use this API to create the custom field entry for given resource and resource_id in param.","tags":["Content"],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","description":"This is company id"},"examples":{"success":{"value":1},"failure":{"value":10},"success1":{"value":1},"success2":{"value":2},"duplicateFieldExample":{"value":11},"validationErrorExample":{"value":12},"failure2":{"value":10}}},{"name":"resource","in":"path","required":true,"schema":{"type":"string","description":"This is the name of resource for which you want to fetch custom fields eg. product, collection, customer etc."},"examples":{"success":{"value":"product"},"failure":{"value":"inventory"}}},{"name":"resource_id","in":"path","required":true,"schema":{"type":"string","description":"This is the resource id for which custom fields created"},"examples":{"success":{"value":"64bb987e9a3c4b6c29d676bc"},"failure":{"value":"64bb987e9a3c4b6c29d67eee"}}}],"requestBody":{"description":"Custom field data","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFieldRequestSchema"},"examples":{"success":{"$ref":"#/components/examples/CustomFieldsSuccess"},"failure":{"$ref":"#/components/examples/CustomFieldFailureExample"}}}}},"responses":{"200":{"description":"Success. Returns a list of custom fields. Refer `CustomFieldsResponseByResourceIdSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFieldsResponseByResourceIdSchema"},"examples":{"success":{"value":{"items":[{"_id":"65705772a20cc45d3f2585b1","updated_by":"bd7223b6727eb087987eece7","namespace":"custom","key":"product-designer","resource":"product","resource_id":"7612437","type":"metaobject","multi_value":true,"company_id":"2","creator":"company","invalid_value_errors":[],"has_invalid_values":false,"definition_id":"656d6bc9766f9511345091a6","value":["65702b4574c5764716ee671d"]},{"_id":"65705772a20cc45d3f2585b2","updated_by":"bd7223b6727eb087987eece7","namespace":"custom","key":"validation-check","resource":"product","resource_id":"7612437","type":"string_single_line","multi_value":false,"company_id":"2","creator":"company","invalid_value_errors":[],"has_invalid_values":false,"definition_id":"656866a30152b0584464d547","value":["ram"]},{"_id":"65705772a20cc45d3f2585b3","updated_by":"bd7223b6727eb087987eece7","namespace":"custom","key":"designer-name","resource":"product","resource_id":"7612437","type":"string_single_line","multi_value":false,"company_id":"2","creator":"company","invalid_value_errors":[],"has_invalid_values":false,"definition_id":"65604cdb6a78c23f082c850b","value":["ramsons"]},{"_id":"65705772a20cc45d3f2585b4","updated_by":"bd7223b6727eb087987eece7","namespace":"custom","key":"manufactures","resource":"product","resource_id":"7612437","type":"string_single_line","multi_value":false,"company_id":"2","creator":"company","invalid_value_errors":[],"has_invalid_values":false,"definition_id":"655f53ddca37f5deb832a185","value":["kartik"]}]}}}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"}}}}}}},"/service/platform/content/v1.0/company/{company_id}/metaobjects/definitions":{"post":{"summary":"createCustomObjectDefinition | Create custom object definition","description":"Use this API to create custom object defintion","tags":["Content"],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","description":"This is company id"},"examples":{"success":{"value":1},"failure":{"value":10},"success1":{"value":1},"success2":{"value":2},"duplicateFieldExample":{"value":11},"validationErrorExample":{"value":12},"failure2":{"value":10}}}],"requestBody":{"description":"Custom object defintion data with custom fields in it","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomObjectDefinitionRequestSchema"},"examples":{"success":{"$ref":"#/components/examples/CustomObjectDefinitionSuccessExample"},"failure":{"$ref":"#/components/examples/CustomObjectDefintionFailureExample"},"failure2":{"$ref":"#/components/examples/CustomObjectDefintionFailureExample2"}}}}},"responses":{"200":{"description":"Success. Returns the saved custom object defintion","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomObjectDefinitionSchema"},"examples":{"success":{"value":{"_id":"656db530766f951134509542","name":"customObject1","type":"customobject1","display_name_key":"cocustomfield2","description":"","creator":"company","created_by":"bd7223b6727eb087987eece7","updated_by":"bd7223b6727eb087987eece7","field_definitions":[{"creator":"company","resource":"metaobject","name":"coCustomField1","namespace":"customobject1","key":"cocustomfield1","description":"","type":"string_single_line","multi_value":false,"validations":[{"name":"min","type":"integer","value":2},{"name":"max","type":"integer","value":10},{"name":"regex","type":"string","value":"^[a-zA-Z]+$"}],"company_id":"1","created_by":"bd7223b6727eb087987eece7","metaobject_definition_id":"656db530766f951134509542","required":false,"is_deleted":false,"_id":"656db530766f951134509545","created_at":"2023-12-04T11:17:04.153Z","updated_at":"2023-12-04T11:17:04.153Z"},{"creator":"company","resource":"metaobject","name":"coCustomField2","namespace":"customobject1","key":"cocustomfield2","description":"this is custom field 2 of custom object","type":"string_single_line","multi_value":false,"validations":[{"name":"min","type":"integer","value":1},{"name":"max","type":"integer","value":100}],"company_id":"1","created_by":"bd7223b6727eb087987eece7","metaobject_definition_id":"656db530766f951134509542","required":false,"is_deleted":false,"_id":"656db530766f951134509546","created_at":"2023-12-04T11:17:04.154Z","updated_at":"2023-12-04T11:17:04.154Z"}]}}}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"failure":{"value":{"status":400,"message":"Sorry, field(s) should be unique","code":"CX-2004","exception":"","request_id":"","info":"E11000 duplicate key error collection: meta.metafield_definitions index: namespace_1_key_1_resource_1_company_id_1_application_id_1 dup key: { namespace: \"customobject1\", key: \"cocustomfield1\", resource: \"metaobject\", company_id: \"1\", application_id: null }","stack_trace":"","meta":{}}},"failure2":{"value":{"status":400,"message":"Validation error","code":"CX-2","exception":"","request_id":"","info":{"name":{"name":"ValidatorError","message":"Path `name` is required.","properties":{"message":"Path `name` is required.","type":"required","path":"name","value":""},"kind":"required","path":"name","value":""}},"stack_trace":"","meta":{}}}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"}}}}}},"get":{"summary":"getCustomObjectDefinitions | Get custom object definitions","description":"Use this API to retrieve the custom object definitions","tags":["Content"],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","description":"This is company id"},"examples":{"success":{"value":1},"failure":{"value":10},"success1":{"value":1},"success2":{"value":2},"duplicateFieldExample":{"value":11},"validationErrorExample":{"value":12},"failure2":{"value":10}}},{"name":"page_no","in":"query","required":true,"schema":{"type":"string","description":"This is the page number"},"examples":{"success":{"value":1},"failure":{"value":1}}},{"name":"page_size","in":"query","required":true,"schema":{"type":"string","description":"This is the page size"},"examples":{"success":{"value":10},"failure":{"value":10}}},{"name":"search","in":"query","required":false,"schema":{"type":"string","description":"This is the search text to filter custom fields definitions"},"examples":{"success":{"value":"sometext"},"failure":{"value":"sometext"}}}],"responses":{"200":{"description":"Success. Returns a list custom object definitions.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomObjectDefinitionsSchema"},"examples":{"success":{"value":{"items":[{"_id":"656db530766f951134509542","name":"customObject1","type":"customobject1","updated_at":"2023-12-04T11:17:04.136Z","entries_count":0,"fields_count":2},{"_id":"656db2d9766f95113450952b","name":"sample","type":"sample","updated_at":"2023-12-04T11:07:05.705Z","entries_count":0,"fields_count":1},{"_id":"656495b58d3278a7c24260f8","name":"address","type":"address","updated_at":"2023-11-27T13:12:21.999Z","entries_count":1,"fields_count":3},{"_id":"655c706ad5ff69fd3b95a1d9","name":"coCustomObject","type":"cocustomobject","updated_at":"2023-11-21T08:55:06.013Z","entries_count":0,"fields_count":2}],"page":{"type":"number","current":1,"size":10,"item_total":4,"has_next":false}}}}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"failure":{"$ref":"#/components/examples/4XXAPIError"}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"}}}}}}},"/service/platform/content/v1.0/company/{company_id}/metaobjects/definitions/{definition_id}":{"get":{"summary":"getCustomObjectDefinition | get custom object definition by id","description":"Use this API to update a custom object definition for your application.","tags":["Content"],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","description":"This is company id"},"examples":{"success":{"value":1},"failure":{"value":10},"success1":{"value":1},"success2":{"value":2},"duplicateFieldExample":{"value":11},"validationErrorExample":{"value":12},"failure2":{"value":10}}},{"name":"definition_id","in":"path","required":true,"schema":{"type":"string","description":"This is definition id"},"examples":{"success":{"value":"65369afad436ae0e54147e86"},"failure":{"value":"5eda528b97457fe43a733acd"}}}],"responses":{"200":{"description":"Custom object definition details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomObjectDefinitionSchema"},"examples":{"success":{"value":{"_id":"656d67de766f95113450917b","name":"Designer","type":"designer","display_name_key":"name","description":"","creator":"company","created_by":"9759643b65ebc6bacb5275f5","updated_by":"bd7223b6727eb087987eece7","field_definitions":[{"creator":"company","resource":"metaobject","name":"city2","namespace":"designer","key":"city","type":"string_single_line","description":"","multi_value":false,"validations":[],"company_id":"2","metaobject_definition_id":"656d67de766f95113450917b","required":false},{"creator":"company","resource":"metaobject","name":"mobile","namespace":"designer","key":"mobile","type":"string_single_line","description":"","multi_value":false,"validations":[],"company_id":"2","metaobject_definition_id":"656d67de766f95113450917b","required":false},{"creator":"company","resource":"metaobject","name":"name","namespace":"designer","key":"name","type":"string_single_line","description":"This is name of designer","multi_value":false,"validations":[],"company_id":"2","metaobject_definition_id":"656d67de766f95113450917b","required":true}]}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"}}}}}},"put":{"summary":"updateCustomObjectDefinition | Update custom object definition","description":"Use this API to update a custom object definition for your application.","tags":["Content"],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","description":"This is company id"},"examples":{"success":{"value":1},"failure":{"value":10},"success1":{"value":1},"success2":{"value":2},"duplicateFieldExample":{"value":11},"validationErrorExample":{"value":12},"failure2":{"value":10}}},{"name":"definition_id","in":"path","required":true,"schema":{"type":"string","description":"This is definition id"},"examples":{"success":{"value":"65369afad436ae0e54147e86"},"failure":{"value":"5eda528b97457fe43a733acd"}}}],"requestBody":{"description":"Custom object definition data","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomObjectDefinitionUpdateRequestSchema"},"examples":{"success1":{"$ref":"#/components/examples/CustomObjectDefinitionExample"},"failure":{"$ref":"#/components/examples/CustomObjectDefinitionExample"}}}}},"responses":{"200":{"description":"Custom field definition updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomObjectDefinitionSchema"},"examples":{"success":{"value":{"_id":"656d67de766f95113450917b","name":"Designer","type":"designer","display_name_key":"name","description":"","creator":"company","created_by":"9759643b65ebc6bacb5275f5","updated_by":"bd7223b6727eb087987eece7","field_definitions":[{"creator":"company","resource":"metaobject","name":"city2","namespace":"designer","key":"city","type":"string_single_line","description":"","multi_value":false,"validations":[],"company_id":"2","metaobject_definition_id":"656d67de766f95113450917b","required":false},{"creator":"company","resource":"metaobject","name":"mobile","namespace":"designer","key":"mobile","type":"string_single_line","description":"","multi_value":false,"validations":[],"company_id":"2","metaobject_definition_id":"656d67de766f95113450917b","required":false},{"creator":"company","resource":"metaobject","name":"name","namespace":"designer","key":"name","type":"string_single_line","description":"This is name of designer","multi_value":false,"validations":[],"company_id":"2","metaobject_definition_id":"656d67de766f95113450917b","required":true}]}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"}}}}}},"delete":{"summary":"deleteCustomObjectDefinition | delete custom object definition by id","description":"Use this API to delete a custom object definition and related data for your application.","tags":["Content"],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","description":"This is company id"},"examples":{"success":{"value":1},"failure":{"value":10},"success1":{"value":1},"success2":{"value":2},"duplicateFieldExample":{"value":11},"validationErrorExample":{"value":12},"failure2":{"value":10}}},{"name":"definition_id","in":"path","required":true,"schema":{"type":"string","description":"This is definition id"},"examples":{"success":{"value":"65369afad436ae0e54147e86"},"failure":{"value":"5eda528b97457fe43a733acd"}}}],"responses":{"200":{"description":"Custom object definition details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomObjectDefinitionDeleteResponseSchema"},"examples":{"success":{"value":{"success":true,"message":"MetaObjectDefinition deleted successfully"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"}}}}}}},"/service/platform/content/v1.0/company/{company_id}/metaobjects":{"get":{"summary":"getCustomObjects | Get list of custom objects","description":"Use this API to retrieve the custom objects.","tags":["Content"],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","description":"This is company id"},"examples":{"success":{"value":1},"failure":{"value":10},"success1":{"value":1},"success2":{"value":2},"duplicateFieldExample":{"value":11},"validationErrorExample":{"value":12},"failure2":{"value":10}}},{"name":"definition_id","in":"query","required":false,"schema":{"type":"string","description":"This is definition id"},"examples":{"success":{"value":"65369afad436ae0e54147e86"},"failure":{"value":"5eda528b97457fe43a733acd"}}},{"name":"page_no","in":"query","required":true,"schema":{"type":"string","description":"This is the page number"},"examples":{"success":{"value":1},"failure":{"value":1}}},{"name":"page_size","in":"query","required":true,"schema":{"type":"string","description":"This is the page size"},"examples":{"success":{"value":10},"failure":{"value":10}}}],"responses":{"200":{"description":"Success. Returns a list of custom objects. Refer `CustomObjectsSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomObjectsSchema"},"examples":{"success":{"$ref":"#/components/examples/CustomObjects"}}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"}}}}}},"post":{"summary":"createCustomObject | Create custom object entries","description":"Use this API to create the custom object entry.","tags":["Content"],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","description":"This is company id"},"examples":{"success":{"value":1},"failure":{"value":10},"success1":{"value":1},"success2":{"value":2},"duplicateFieldExample":{"value":11},"validationErrorExample":{"value":12},"failure2":{"value":10}}}],"requestBody":{"description":"Custom object data with field entry","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomObjectRequestSchema"},"examples":{"success1":{"$ref":"#/components/examples/CustomObjectSuccessExample1"},"success2":{"$ref":"#/components/examples/CustomObjectSuccessExample2"},"failure":{"$ref":"#/components/examples/CustomObjectFailureExample"}}}}},"responses":{"200":{"description":"Success. Returns a list of custom objects. Refer `CustomObjectSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomObjectSchema"},"examples":{"success":{"$ref":"#/components/examples/CustomObject"}}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"failure":{"value":{"status":400,"message":"Sorry, field(s) should be unique","code":"CX-2004","exception":"","request_id":"","info":"E11000 duplicate key error collection: meta.metafield_definitions index: namespace_1_key_1_resource_1_company_id_1_application_id_1 dup key: { namespace: \"abcd10\", key: \"llll\", resource: \"metaobject\", company_id: \"1\", application_id: null }","stack_trace":"","meta":{}}}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"}}}}}}},"/service/platform/content/v1.0/company/{company_id}/metaobjects/{metaobject_id}":{"get":{"summary":"getCustomObject | Get custom object details","description":"Use this API to retrieve the custom object details and their fields details and definitions and references.","tags":["Content"],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","description":"This is company id"},"examples":{"success":{"value":1},"failure":{"value":10},"success1":{"value":1},"success2":{"value":2},"duplicateFieldExample":{"value":11},"validationErrorExample":{"value":12},"failure2":{"value":10}}},{"name":"metaobject_id","in":"path","required":true,"schema":{"type":"string","description":"This is meta object id"},"examples":{"success":{"value":"65392bd912376081aafa90ff"},"failure":{"value":"5eda528b97457fe43a733acd"}}}],"responses":{"200":{"description":"Success. Returns a custom object. Refer `CustomObjectByIdSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomObjectByIdSchema"},"examples":{"success":{"$ref":"#/components/examples/CustomObjectByIdRes"}}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"}}}}}},"delete":{"summary":"deleteCustomObject | Delete custom object","description":"Use this API to delete the custom object entry by id. This will also delete related custom fields entries related to this custom object.","tags":["Content"],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","description":"This is company id"},"examples":{"success":{"value":1},"failure":{"value":10},"success1":{"value":1},"success2":{"value":2},"duplicateFieldExample":{"value":11},"validationErrorExample":{"value":12},"failure2":{"value":10}}},{"name":"metaobject_id","in":"path","required":true,"schema":{"type":"string","description":"This is meta object id"},"examples":{"success":{"value":"65392bd912376081aafa90ff"},"failure":{"value":"5eda528b97457fe43a733acd"}}}],"responses":{"200":{"description":"Success. It will returns the message for delete successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomDataDeleteSchema"},"examples":{"success":{"$ref":"#/components/examples/CustomDataDeleteResponse"}}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"failure":{"value":{"status":404,"message":"MetaObject Definition Not Found","code":"CX-1027","exception":"","request_id":"","stack_trace":"","meta":{}}}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"}}}}}},"put":{"summary":"updateCustomObject | Update custom object details","description":"Use this API to update a custom object detail for your application.","tags":["Content"],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","description":"This is company id"},"examples":{"success":{"value":1},"failure":{"value":10},"success1":{"value":1},"success2":{"value":2},"duplicateFieldExample":{"value":11},"validationErrorExample":{"value":12},"failure2":{"value":10}}},{"name":"metaobject_id","in":"path","required":true,"schema":{"type":"string","description":"This is meta object id"},"examples":{"success":{"value":"65392bd912376081aafa90ff"},"failure":{"value":"5eda528b97457fe43a733acd"}}}],"requestBody":{"description":"Custom object definition data","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomObjectRequestSchema"},"examples":{"success1":{"$ref":"#/components/examples/CustomObjectRequestExample"},"failure":{"$ref":"#/components/examples/CustomObjectRequestExampleFailure"}}}}},"responses":{"200":{"description":"Custom field definition created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomObjectByIdSchema"},"examples":{"success":{"value":{"_id":"656d67de766f95113450917b","name":"Designer","type":"designer","display_name_key":"name","description":"","creator":"company","created_by":"9759643b65ebc6bacb5275f5","updated_by":"bd7223b6727eb087987eece7","field_definitions":[{"creator":"company","resource":"metaobject","name":"city2","namespace":"designer","key":"city","type":"string_single_line","description":"","multi_value":false,"validations":[],"company_id":"2","metaobject_definition_id":"656d67de766f95113450917b","required":false},{"creator":"company","resource":"metaobject","name":"mobile","namespace":"designer","key":"mobile","type":"string_single_line","description":"","multi_value":false,"validations":[],"company_id":"2","metaobject_definition_id":"656d67de766f95113450917b","required":false},{"creator":"company","resource":"metaobject","name":"name","namespace":"designer","key":"name","type":"string_single_line","description":"This is name of designer","multi_value":false,"validations":[],"company_id":"2","metaobject_definition_id":"656d67de766f95113450917b","required":true}]}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"}}}}}}},"/service/platform/content/v1.0/company/{company_id}/metaobjects/jobs":{"get":{"summary":"getJobs | Fetch bulk import and export job list.","description":"Use this api to get list of jobs of bulk import and exports","tags":["Content"],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","description":"This is company id"},"examples":{"success":{"value":1},"failure":{"value":10},"success1":{"value":1},"success2":{"value":2},"duplicateFieldExample":{"value":11},"validationErrorExample":{"value":12},"failure2":{"value":10}}},{"name":"page","in":"query","required":true,"schema":{"type":"string","description":"This is the page number"},"examples":{"success":{"value":1},"failure":{"value":1}}},{"name":"page_size","in":"query","required":true,"schema":{"type":"string","description":"This is the page size"},"examples":{"success":{"value":10},"failure":{"value":10}}},{"name":"action_type","in":"query","required":true,"schema":{"type":"string","description":"This is the action type"},"examples":{"success":{"value":"upload"},"failure":{"value":"upload"}}}],"responses":{"200":{"description":"Success. Returns all bulk entries history. ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomObjectBulkEntry"},"examples":{"success":{"value":{"items":[{"_id":"6570124da20cc45d3f2582a7","jobs":["2311"],"finished_jobs":["2311"],"error_jobs":[],"errors_occured":[],"company_id":"2","creator":"company","URL":"https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/misc/custom-data/CustomObject-designer-import-6570124da20cc45d3f2582a7.csv","status":"completed","action_type":"upload","entity":"metaobject","error_url":"","finished_count":0,"error_count":0,"success_count":0,"total_jobs":1,"meta":{"mo_total_count":2,"mo_success_count":2,"mo_error_count":0,"mo_defintion_type":"designer"},"created_by":"bd7223b6727eb087987eece7","created_at":"2023-12-06T06:18:53.219Z","updated_at":"2023-12-06T06:20:23.560Z","id":"6570124da20cc45d3f2582a7"},{"_id":"6558b8c49340c43a7015b4af","jobs":["2297"],"finished_jobs":["2297"],"error_jobs":[],"errors_occured":[],"company_id":"2","creator":"company","URL":"https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/misc/custom-data/CustomObject-kuldeep-custom-import-6558b8c49340c43a7015b4af.csv","status":"completed","action_type":"upload","entity":"metaobject","error_url":"","finished_count":0,"error_count":0,"success_count":0,"total_jobs":1,"meta":{"mo_total_count":1,"mo_success_count":0,"mo_error_count":1,"mo_defintion_type":"kuldeep-custom"},"created_by":"9759643b65ebc6bacb5275f5","created_at":"2023-11-18T13:14:44.360Z","updated_at":"2023-11-18T13:17:19.765Z","id":"6558b8c49340c43a7015b4af"}],"page":{"type":"number","current":1,"size":20,"item_total":2,"has_next":false}}}}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"}}}}}}},"/service/platform/content/v1.0/company/{company_id}/metaobjects/bulk/{definition_id}/upload":{"post":{"summary":"importCustomObjectEntries | Bulk custom object entries upload","description":"Use this API to upload custom object entries","tags":["Content"],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","description":"This is company id"},"examples":{"success":{"value":1},"failure":{"value":10},"success1":{"value":1},"success2":{"value":2},"duplicateFieldExample":{"value":11},"validationErrorExample":{"value":12},"failure2":{"value":10}}},{"name":"definition_id","in":"path","required":true,"schema":{"type":"string","description":"This is definition id"},"examples":{"success":{"value":"65369afad436ae0e54147e86"},"failure":{"value":"5eda528b97457fe43a733acd"}}}],"requestBody":{"description":"Custom Object bulk entires url and total counts.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomObjectBulkSchema"},"examples":{"success":{"$ref":"#/components/examples/CustomObjectBulkUploadExample"},"failure":{"$ref":"#/components/examples/CustomObjectBulkUploadFailureExample"}}}}},"responses":{"200":{"description":"Success. Returns confirmation that the upload has started","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomObjectEntryBulkUploadResponse"},"examples":{"success":{"value":{"message":"Bulk upload of Meta objects started successfully","task_id":"6570124da20cc45d3f2582a7"}}}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"failure":{"value":{"status":400,"message":"Invalid MetaObject Request","code":"CX-1028","exception":"","request_id":"","info":"Total records is required","stack_trace":"","meta":{}}}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"}}}}}}},"/service/platform/content/v1.0/company/{company_id}/metaobjects/bulk/{definition_id}/download":{"get":{"summary":"exportCustomObjectEntries | Initiate download for bulk custom object entries","description":"Use this api to initiate download of bulk entries","tags":["Content"],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","description":"This is company id"},"examples":{"success":{"value":1},"failure":{"value":10},"success1":{"value":1},"success2":{"value":2},"duplicateFieldExample":{"value":11},"validationErrorExample":{"value":12},"failure2":{"value":10}}},{"name":"definition_id","in":"path","required":true,"schema":{"type":"string","description":"This is definition id"},"examples":{"success":{"value":"65369afad436ae0e54147e86"},"failure":{"value":"5eda528b97457fe43a733acd"}}}],"responses":{"200":{"description":"Success. Initiates bulk entries download ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomObjectBulkEntryInitiateDownload"},"examples":{"success":{"value":{"message":"Bulk download of Meta Objects started successfully","task_id":"65702d2aa20cc45d3f258358"}}}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"}}}}}}},"/service/platform/content/v1.0/company/{company_id}/metaobjects/bulk/{definition_id}/sample":{"get":{"summary":"sampleCustomObjectBulkEntry | download sample for custom object bulk entry","description":"Use this api to get sample csv file ","tags":["Content"],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","description":"This is company id"},"examples":{"success":{"value":1},"failure":{"value":10},"success1":{"value":1},"success2":{"value":2},"duplicateFieldExample":{"value":11},"validationErrorExample":{"value":12},"failure2":{"value":10}}},{"name":"definition_id","in":"path","required":true,"schema":{"type":"string","description":"This is definition id"},"examples":{"success":{"value":"65369afad436ae0e54147e86"},"failure":{"value":"5eda528b97457fe43a733acd"}}}],"responses":{"200":{"description":"Success. Get headers of custom object definition","content":{"application/json":{"schema":{"type":"string"},"examples":{"success":{"value":"city,mobile,name,custom_object_status"}}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"}}}}}}},"/service/platform/content/v1.0/company/{company_id}/application/{application_id}/metafields/types":{"get":{"summary":"getAppCustomFieldTypes | Get custom field types","description":"Use this API to retrieve the custom field types ","tags":["Content"],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","description":"This is company id"},"examples":{"success":{"value":1},"failure":{"value":10},"success1":{"value":1},"success2":{"value":2},"duplicateFieldExample":{"value":11},"validationErrorExample":{"value":12},"failure2":{"value":10}}},{"name":"application_id","in":"path","required":true,"schema":{"type":"string","description":"This is application id"},"examples":{"success":{"value":"5eda528b97457fe43a733ace"},"failure":{"value":"5eda528b97457fe43a733acd"}}}],"responses":{"200":{"description":"Success. Returns all custom field types. ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomObjectByIdSchema"},"examples":{"success":{"value":{"metafield_types":{"string_single_line":{"name":"Single Line Text","list_enabled":true,"category":"TEXT","type":"string","supported_validations":[{"name":"min","type":"integer","display":"Minimum Characters"},{"name":"max","type":"integer","display":"Maximum Characters"},{"name":"regex","type":"string","display":"Regular Expression","meta":{"examples":[{"name":"Alphabet Characters","value":"^[a-zA-Z]+$"},{"name":"Alphanumeric Characters","value":"^[a-zA-Z0-9]+$"},{"name":"Numeric Characters","value":"^[0-9]+$"},{"name":"Email Address","value":"^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$"}]}},{"name":"choices","type":"string_array","display":"Choices"}]},"string_multi_line":{"name":"Multi Line Text","list_enabled":true,"category":"TEXT","type":"string","supported_validations":[{"name":"min","type":"integer","display":"Minimum Characters"},{"name":"max","type":"integer","display":"Maximum Characters"}]},"dropdown":{"name":"Dropdown","list_enabled":true,"category":"TEXT","type":"string","supported_validations":[{"name":"choices","type":"string_array","display":"Choices","required":true}]},"integer":{"name":"Integer","list_enabled":true,"type":"integer","category":"NUMBER","supported_validations":[{"name":"min","type":"integer","display":"Minimum Value"},{"name":"max","type":"integer","display":"Maximum Value"},{"name":"choices","type":"integer_array","display":"Choices"}]},"float_type":{"name":"Decimal","list_enabled":true,"type":"float","category":"NUMBER","supported_validations":[{"name":"min","type":"float","display":"Minimum Value"},{"name":"max","type":"float","display":"Maximum Value"},{"name":"choices","type":"float_array","display":"Choices"}]},"boolean_type":{"name":"Boolean","category":"TRUE_FALSE","list_enabled":false,"type":"boolean","supported_validations":[]},"date":{"name":"Date","list_enabled":true,"category":"DATETIME","type":"date","supported_validations":[{"name":"min","type":"date","display":"From Date"},{"name":"max","type":"date","display":"To Date"}]},"datetime":{"name":"Date - Time","category":"DATETIME","list_enabled":true,"type":"datetime","supported_validations":[{"name":"min","type":"date","display":"From Date & Time"},{"name":"max","type":"date","display":"To Date & Time"}]},"json":{"name":"JSON","list_enabled":false,"category":"ADVANCED","type":"json","supported_validations":[{"name":"schema","type":"json","display":"JSON Schema"}]},"file":{"name":"File","category":"REFERENCE","list_enabled":true,"type":"string","supported_validations":[{"name":"file_type_options","type":"string_array","meta":{"options":[{"image":{"supported_types":["jpeg","jpg","png","svg+xml","tiff","webp","gif"],"max_size":20971520},"video":{"supported_types":["x-flv","mp4","x-mpegURL","MP2T","3gpp","/quicktime","x-msvideo","x-ms-wmv","webm"],"max_size":1048576000}}]}}]},"url":{"name":"URL","list_enabled":true,"type":"string","supported_validations":[{"name":"allowed_domains","display":"Allowed Domains","type":"string_array"}]},"metaobject":{"name":"Custom Object","list_enabled":true,"category":"REFERENCE","type":"string","supported_validations":[{"name":"metaobject_definition_id","display":"Reference","type":"string","required":true}]},"product":{"name":"Product","list_enabled":true,"category":"REFERENCE","type":"string","supported_validations":[],"scope":["company","application"]}}}}}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"}}}}}}},"/service/platform/content/v1.0/company/{company_id}/application/{application_id}/metafields/resources":{"get":{"summary":"getAppResources | Get resources","description":"Use this API to retrieve the resources, such as products, collections, customers, selling locations, etc.","tags":["Content"],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","description":"This is company id"},"examples":{"success":{"value":1},"failure":{"value":10},"success1":{"value":1},"success2":{"value":2},"duplicateFieldExample":{"value":11},"validationErrorExample":{"value":12},"failure2":{"value":10}}},{"name":"application_id","in":"path","required":true,"schema":{"type":"string","description":"This is application id"},"examples":{"success":{"value":"5eda528b97457fe43a733ace"},"failure":{"value":"5eda528b97457fe43a733acd"}}}],"responses":{"200":{"description":"Success. Returns a JSON object of resources. Refer `ResourcesSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourcesSchema"},"examples":{"success":{"$ref":"#/components/examples/ResourceResponse"}}}}},"4XX":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"5XX":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/5XXAPIError"}}}}}}}},"/service/platform/content/v1.0/company/{company_id}/application/{application_id}/metafields/definitions":{"get":{"summary":"getAppCustomFieldDefinitions | Get custom fields definitions","description":"Use this API to retrieve the definitions of custom fields.","tags":["Content"],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","description":"This is company id"},"examples":{"success":{"value":1},"failure":{"value":10},"success1":{"value":1},"success2":{"value":2},"duplicateFieldExample":{"value":11},"validationErrorExample":{"value":12},"failure2":{"value":10}}},{"name":"application_id","in":"path","required":true,"schema":{"type":"string","description":"This is application id"},"examples":{"success":{"value":"5eda528b97457fe43a733ace"},"failure":{"value":"5eda528b97457fe43a733acd"}}},{"name":"page_no","in":"query","required":true,"schema":{"type":"string","description":"This is the page number"},"examples":{"success":{"value":1},"failure":{"value":1}}},{"name":"page_size","in":"query","required":true,"schema":{"type":"string","description":"This is the page size"},"examples":{"success":{"value":10},"failure":{"value":10}}},{"name":"resource","in":"query","required":false,"schema":{"type":"string","description":"This is the resource for which we are fetching definitions"},"examples":{"success":{"value":"product"},"failure":{"value":"some"}}},{"name":"type","in":"query","required":false,"schema":{"type":"string","description":"This is the type of the custom fields definitions"},"examples":{"success":{"value":"string_single_line"},"failure":{"value":"string_single"}}},{"name":"search","in":"query","required":false,"schema":{"type":"string","description":"This is the search text to filter custom fields definitions"},"examples":{"success":{"value":"sometext"},"failure":{"value":"sometext"}}}],"responses":{"200":{"description":"Success. Returns a list of custom fields definitions. Refer `CustomFieldDefinitionsSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFieldDefinitionsSchema"},"examples":{"success":{"$ref":"#/components/examples/CustomFieldDefinitionsResponse"}}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"failure":{"$ref":"#/components/examples/4XXAPIError"}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"}}}}}},"post":{"summary":"createAppCustomFieldDefinition | Create custom field definition","description":"Use this API to create a custom field definition for your application.","tags":["Content"],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","description":"This is company id"},"examples":{"success":{"value":1},"failure":{"value":10},"success1":{"value":1},"success2":{"value":2},"duplicateFieldExample":{"value":11},"validationErrorExample":{"value":12},"failure2":{"value":10}}},{"name":"application_id","in":"path","required":true,"schema":{"type":"string","description":"This is application id"},"examples":{"success":{"value":"5eda528b97457fe43a733ace"},"failure":{"value":"5eda528b97457fe43a733acd"}}}],"requestBody":{"description":"Custom field definition data","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFieldDefinitionRequestSchema"},"examples":{"success1":{"value":{"resource":"product","type":"string_single_line","key":"fname","namespace":"fname","multi_value":false,"name":"name","description":"First name"}},"success2":{"value":{"resource":"product","type":"boolean","key":"isActive","namespace":"isactive","multi_value":false,"name":"isActive","description":"Is Active"}},"failure":{"value":{"resource":"product","type":"metaobject","key":"color","namespace":"custom_app2i","multi_value":true,"name":"Color","description":"test description","validations":[{"name":"metaobject_definition_id","value":"65070612a6d40266c48baac3"}]}},"duplicateFieldExample":{"value":{"resource":"product","type":"string_single_line","namespace":"custom","description":"","name":"test","multi_value":false,"key":"test","validations":[]}},"validationErrorExample":{"value":{"resource":"product","type":"string_single_line","namespace":"custom","description":"","name":"","multi_value":false,"key":"test","validations":[]}}}}}},"responses":{"200":{"description":"Custom field definition created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFieldDefinitionDetailResSchema"},"examples":{"success1":{"$ref":"#/components/examples/CustomFieldDefinitionDetailResponse"},"success2":{"$ref":"#/components/examples/CustomFieldDefinitionDetailResponse"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"duplicateFieldExample":{"$ref":"#/components/examples/CustomFieldDefinitionDuplicateFieldError"},"validationErrorExample":{"$ref":"#/components/examples/CustomFieldDefinitionValidationErrorExample"}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"}}}}}}},"/service/platform/content/v1.0/company/{company_id}/application/{application_id}/metafields/definitions/{definition_id}":{"get":{"summary":"getAppCustomFieldDefinition | Get custom fields definition by id","description":"Use this API to retrieve the definitions of custom fields using definition_id.","tags":["Content"],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","description":"This is company id"},"examples":{"success":{"value":1},"failure":{"value":10},"success1":{"value":1},"success2":{"value":2},"duplicateFieldExample":{"value":11},"validationErrorExample":{"value":12},"failure2":{"value":10}}},{"name":"application_id","in":"path","required":true,"schema":{"type":"string","description":"This is application id"},"examples":{"success":{"value":"5eda528b97457fe43a733ace"},"failure":{"value":"5eda528b97457fe43a733acd"}}},{"name":"definition_id","in":"path","required":true,"schema":{"type":"string","description":"This is definition id"},"examples":{"success":{"value":"65369afad436ae0e54147e86"},"failure":{"value":"5eda528b97457fe43a733acd"}}}],"responses":{"200":{"description":"Success. Returns a object of custom field definition. Refer `CustomFieldDefinitionsSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFieldDefinitionDetailResSchema"},"examples":{"success":{"$ref":"#/components/examples/CustomFieldDefinitionsResponse"}}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"failure":{"$ref":"#/components/examples/4XXAPIError"}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"}}}}}},"put":{"summary":"updateAppCustomFieldDefinition | Update custom field definition","description":"Use this API to update a custom field definition for your application.","tags":["Content"],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","description":"This is company id"},"examples":{"success":{"value":1},"failure":{"value":10},"success1":{"value":1},"success2":{"value":2},"duplicateFieldExample":{"value":11},"validationErrorExample":{"value":12},"failure2":{"value":10}}},{"name":"application_id","in":"path","required":true,"schema":{"type":"string","description":"This is application id"},"examples":{"success":{"value":"5eda528b97457fe43a733ace"},"failure":{"value":"5eda528b97457fe43a733acd"}}},{"name":"definition_id","in":"path","required":true,"schema":{"type":"string","description":"This is definition id"},"examples":{"success":{"value":"65369afad436ae0e54147e86"},"failure":{"value":"5eda528b97457fe43a733acd"}}}],"requestBody":{"description":"Custom field definition data","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFieldDefinitionRequestSchema"},"examples":{"success1":{"$ref":"#/components/examples/CustomFieldCreationSuccessExample1"},"success2":{"$ref":"#/components/examples/CustomFieldCreationSuccessExample2"},"failure":{"$ref":"#/components/examples/CustomFieldCreationsFailureExample"}}}}},"responses":{"200":{"description":"Custom field definition created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFieldDefinitionDetailResSchema"},"examples":{"success":{"$ref":"#/components/examples/CustomFieldDefinitionDetailResponse"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"}}}}}},"delete":{"summary":"deleteAppCustomFieldDefinition | Delete custom fields definition.","description":"Use this API to delete the definitions of custom fields using definition_id. This will also delete related custom fields entries related to this definition.","tags":["Content"],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","description":"This is company id"},"examples":{"success":{"value":1},"failure":{"value":10},"success1":{"value":1},"success2":{"value":2},"duplicateFieldExample":{"value":11},"validationErrorExample":{"value":12},"failure2":{"value":10}}},{"name":"application_id","in":"path","required":true,"schema":{"type":"string","description":"This is application id"},"examples":{"success":{"value":"5eda528b97457fe43a733ace"},"failure":{"value":"5eda528b97457fe43a733acd"}}},{"name":"definition_id","in":"path","required":true,"schema":{"type":"string","description":"This is definition id"},"examples":{"success":{"value":"65369afad436ae0e54147e86"},"failure":{"value":"5eda528b97457fe43a733acd"}}}],"responses":{"200":{"description":"Success. It will returns the message for delete successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomDataDeleteSchema"},"examples":{"success":{"$ref":"#/components/examples/CustomDataDeleteResponse"}}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"failure":{"value":{"status":404,"message":"No such metafield definition found","code":"CX-1013","exception":"","request_id":"","stack_trace":"","meta":{}}}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"}}}}}}},"/service/platform/content/v1.0/company/{company_id}/application/{application_id}/metafields/{resource}":{"get":{"summary":"getAppCustomFields | Get list of custom fields of given resource","description":"Use this API to retrieve the custom fields for given resource in param.","tags":["Content"],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","description":"This is company id"},"examples":{"success":{"value":1},"failure":{"value":10},"success1":{"value":1},"success2":{"value":2},"duplicateFieldExample":{"value":11},"validationErrorExample":{"value":12},"failure2":{"value":10}}},{"name":"application_id","in":"path","required":true,"schema":{"type":"string","description":"This is application id"},"examples":{"success":{"value":"5eda528b97457fe43a733ace"},"failure":{"value":"5eda528b97457fe43a733acd"}}},{"name":"resource","in":"path","required":true,"schema":{"type":"string","description":"This is the name of resource for which you want to fetch custom fields eg. product, collection, customer etc."},"examples":{"success":{"value":"product"},"failure":{"value":"inventory"}}}],"responses":{"200":{"description":"Success. Returns a list of custom fields. Refer `CustomFieldsResponseSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFieldsResponseSchema"},"examples":{"success":{"$ref":"#/components/examples/CustomFieldsResponse"}}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"failure":{"$ref":"#/components/examples/4XXAPIError"}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/5XXAPIError"}}}}}}}},"/service/platform/content/v1.0/company/{company_id}/application/{application_id}/metafields/{resource}/{resource_id}":{"get":{"summary":"getAppCustomFieldsByResourceId | Get list of custom fields of given resource and resource id","description":"Use this API to retrieve the custom fields for given resource in param.","tags":["Content"],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","description":"This is company id"},"examples":{"success":{"value":1},"failure":{"value":10},"success1":{"value":1},"success2":{"value":2},"duplicateFieldExample":{"value":11},"validationErrorExample":{"value":12},"failure2":{"value":10}}},{"name":"application_id","in":"path","required":true,"schema":{"type":"string","description":"This is application id"},"examples":{"success":{"value":"5eda528b97457fe43a733ace"},"failure":{"value":"5eda528b97457fe43a733acd"}}},{"name":"resource","in":"path","required":true,"schema":{"type":"string","description":"This is the name of resource for which you want to fetch custom fields eg. product, collection, customer etc."},"examples":{"success":{"value":"product"},"failure":{"value":"inventory"}}},{"name":"resource_id","in":"path","required":true,"schema":{"type":"string","description":"This is the resource id for which custom fields created"},"examples":{"success":{"value":"64bb987e9a3c4b6c29d676bc"},"failure":{"value":"64bb987e9a3c4b6c29d67eee"}}}],"responses":{"200":{"description":"Success. Returns a list of custom fields. Refer `CustomFieldsResponseByResourceIdSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFieldsResponseByResourceIdSchema"},"examples":{"success":{"value":{"items":[{"_id":"65705772a20cc45d3f2585b3","namespace":"custom","key":"designer-name","resource":"product","creator":"company","value":["ramsons"],"resource_id":"7612437","type":"string_single_line","multi_value":false,"company_id":"2","definition_id":"65604cdb6a78c23f082c850b","has_invalid_values":false,"invalid_value_errors":[],"created_by":"bd7223b6727eb087987eece7","is_deleted":false,"created_at":"2023-12-06T11:13:54.217Z","updated_at":"2023-12-06T11:19:02.311Z","updated_by":"bd7223b6727eb087987eece7"},{"_id":"65705772a20cc45d3f2585b4","namespace":"custom","key":"manufactures","resource":"product","creator":"company","value":["kartik"],"resource_id":"7612437","type":"string_single_line","multi_value":false,"company_id":"2","definition_id":"655f53ddca37f5deb832a185","has_invalid_values":false,"invalid_value_errors":[],"created_by":"bd7223b6727eb087987eece7","is_deleted":false,"created_at":"2023-12-06T11:13:54.218Z","updated_at":"2023-12-06T11:19:02.311Z","updated_by":"bd7223b6727eb087987eece7"},{"_id":"65705772a20cc45d3f2585b1","namespace":"custom","key":"product-designer","resource":"product","creator":"company","value":["65702b4574c5764716ee671d"],"resource_id":"7612437","type":"metaobject","multi_value":true,"company_id":"2","definition_id":"656d6bc9766f9511345091a6","has_invalid_values":false,"invalid_value_errors":[],"created_by":"bd7223b6727eb087987eece7","is_deleted":false,"created_at":"2023-12-06T11:13:54.217Z","updated_at":"2023-12-06T11:19:02.311Z","updated_by":"bd7223b6727eb087987eece7"},{"_id":"65705772a20cc45d3f2585b2","namespace":"custom","key":"validation-check","resource":"product","creator":"company","value":["ram"],"resource_id":"7612437","type":"string_single_line","multi_value":false,"company_id":"2","definition_id":"656866a30152b0584464d547","has_invalid_values":false,"invalid_value_errors":[],"created_by":"bd7223b6727eb087987eece7","is_deleted":false,"created_at":"2023-12-06T11:13:54.217Z","updated_at":"2023-12-06T11:19:02.311Z","updated_by":"bd7223b6727eb087987eece7"}]}}}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"failure":{"$ref":"#/components/examples/4XXAPIError"}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"}}}}}},"put":{"summary":"createAppCustomFieldByResourceId | Create custom field entries for gives resource and resource_id","description":"Use this API to create the custom field entry for given resource and resource_id in param.","tags":["Content"],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","description":"This is company id"},"examples":{"success":{"value":1},"failure":{"value":10},"success1":{"value":1},"success2":{"value":2},"duplicateFieldExample":{"value":11},"validationErrorExample":{"value":12},"failure2":{"value":10}}},{"name":"application_id","in":"path","required":true,"schema":{"type":"string","description":"This is application id"},"examples":{"success":{"value":"5eda528b97457fe43a733ace"},"failure":{"value":"5eda528b97457fe43a733acd"}}},{"name":"resource","in":"path","required":true,"schema":{"type":"string","description":"This is the name of resource for which you want to fetch custom fields eg. product, collection, customer etc."},"examples":{"success":{"value":"product"},"failure":{"value":"inventory"}}},{"name":"resource_id","in":"path","required":true,"schema":{"type":"string","description":"This is the resource id for which custom fields created"},"examples":{"success":{"value":"64bb987e9a3c4b6c29d676bc"},"failure":{"value":"64bb987e9a3c4b6c29d67eee"}}}],"requestBody":{"description":"Custom field data","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFieldRequestSchema"},"examples":{"success":{"$ref":"#/components/examples/CustomFieldsSuccess"},"failure":{"$ref":"#/components/examples/CustomFieldFailureExample"}}}}},"responses":{"200":{"description":"Success. Returns a list of custom fields. Refer `CustomFieldsResponseByResourceIdSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFieldsResponseByResourceIdSchema"},"examples":{"success":{"value":{"items":[{"_id":"65705772a20cc45d3f2585b1","updated_by":"bd7223b6727eb087987eece7","namespace":"custom","key":"product-designer","resource":"product","resource_id":"7612437","type":"metaobject","multi_value":true,"company_id":"2","creator":"company","invalid_value_errors":[],"has_invalid_values":false,"definition_id":"656d6bc9766f9511345091a6","value":["65702b4574c5764716ee671d"]},{"_id":"65705772a20cc45d3f2585b2","updated_by":"bd7223b6727eb087987eece7","namespace":"custom","key":"validation-check","resource":"product","resource_id":"7612437","type":"string_single_line","multi_value":false,"company_id":"2","creator":"company","invalid_value_errors":[],"has_invalid_values":false,"definition_id":"656866a30152b0584464d547","value":["ram"]},{"_id":"65705772a20cc45d3f2585b3","updated_by":"bd7223b6727eb087987eece7","namespace":"custom","key":"designer-name","resource":"product","resource_id":"7612437","type":"string_single_line","multi_value":false,"company_id":"2","creator":"company","invalid_value_errors":[],"has_invalid_values":false,"definition_id":"65604cdb6a78c23f082c850b","value":["ramsons"]},{"_id":"65705772a20cc45d3f2585b4","updated_by":"bd7223b6727eb087987eece7","namespace":"custom","key":"manufactures","resource":"product","resource_id":"7612437","type":"string_single_line","multi_value":false,"company_id":"2","creator":"company","invalid_value_errors":[],"has_invalid_values":false,"definition_id":"655f53ddca37f5deb832a185","value":["kartik"]}]}}}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"}}}}}}},"/service/platform/content/v1.0/company/{company_id}/application/{application_id}/metaobjects/definitions":{"post":{"summary":"createAppCustomObjectDefinition | Create custom object definition","description":"Use this API to create custom object defintion","tags":["Content"],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","description":"This is company id"},"examples":{"success":{"value":1},"failure":{"value":10},"success1":{"value":1},"success2":{"value":2},"duplicateFieldExample":{"value":11},"validationErrorExample":{"value":12},"failure2":{"value":10}}},{"name":"application_id","in":"path","required":true,"schema":{"type":"string","description":"This is application id"},"examples":{"success":{"value":"5eda528b97457fe43a733ace"},"failure":{"value":"5eda528b97457fe43a733acd"}}}],"requestBody":{"description":"Custom object defintion data with custom fields in it","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomObjectDefinitionRequestSchema"},"examples":{"success":{"$ref":"#/components/examples/CustomObjectDefinitionSuccessExample"},"failure":{"$ref":"#/components/examples/CustomObjectDefintionFailureExample"},"failure2":{"$ref":"#/components/examples/CustomObjectDefintionFailureExample2"}}}}},"responses":{"200":{"description":"Success. Returns the saved custom object defintion","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomObjectDefinitionSchema"},"examples":{"success":{"value":{"_id":"656db530766f951134509542","name":"customObject1","type":"customobject1","display_name_key":"cocustomfield2","description":"","creator":"company","created_by":"bd7223b6727eb087987eece7","updated_by":"bd7223b6727eb087987eece7","field_definitions":[{"creator":"company","resource":"metaobject","name":"coCustomField1","namespace":"customobject1","key":"cocustomfield1","description":"","type":"string_single_line","multi_value":false,"validations":[{"name":"min","type":"integer","value":2},{"name":"max","type":"integer","value":10},{"name":"regex","type":"string","value":"^[a-zA-Z]+$"}],"company_id":"1","created_by":"bd7223b6727eb087987eece7","metaobject_definition_id":"656db530766f951134509542","required":false,"is_deleted":false,"_id":"656db530766f951134509545","created_at":"2023-12-04T11:17:04.153Z","updated_at":"2023-12-04T11:17:04.153Z"},{"creator":"company","resource":"metaobject","name":"coCustomField2","namespace":"customobject1","key":"cocustomfield2","description":"this is custom field 2 of custom object","type":"string_single_line","multi_value":false,"validations":[{"name":"min","type":"integer","value":1},{"name":"max","type":"integer","value":100}],"company_id":"1","created_by":"bd7223b6727eb087987eece7","metaobject_definition_id":"656db530766f951134509542","required":false,"is_deleted":false,"_id":"656db530766f951134509546","created_at":"2023-12-04T11:17:04.154Z","updated_at":"2023-12-04T11:17:04.154Z"}]}}}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"failure":{"value":{"status":400,"message":"Sorry, field(s) should be unique","code":"CX-2004","exception":"","request_id":"","info":"E11000 duplicate key error collection: meta.metafield_definitions index: namespace_1_key_1_resource_1_company_id_1_application_id_1 dup key: { namespace: \"customobject1\", key: \"cocustomfield1\", resource: \"metaobject\", company_id: \"1\", application_id: null }","stack_trace":"","meta":{}}},"failure2":{"value":{"status":400,"message":"Validation error","code":"CX-2","exception":"","request_id":"","info":{"name":{"name":"ValidatorError","message":"Path `name` is required.","properties":{"message":"Path `name` is required.","type":"required","path":"name","value":""},"kind":"required","path":"name","value":""}},"stack_trace":"","meta":{}}}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"}}}}}},"get":{"summary":"getAppCustomObjectDefinitions | Get custom object definitions","description":"Use this API to retrieve the custom object definitions","tags":["Content"],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","description":"This is company id"},"examples":{"success":{"value":1},"failure":{"value":10},"success1":{"value":1},"success2":{"value":2},"duplicateFieldExample":{"value":11},"validationErrorExample":{"value":12},"failure2":{"value":10}}},{"name":"application_id","in":"path","required":true,"schema":{"type":"string","description":"This is application id"},"examples":{"success":{"value":"5eda528b97457fe43a733ace"},"failure":{"value":"5eda528b97457fe43a733acd"}}},{"name":"page_no","in":"query","required":true,"schema":{"type":"string","description":"This is the page number"},"examples":{"success":{"value":1},"failure":{"value":1}}},{"name":"page_size","in":"query","required":true,"schema":{"type":"string","description":"This is the page size"},"examples":{"success":{"value":10},"failure":{"value":10}}},{"name":"search","in":"query","required":false,"schema":{"type":"string","description":"This is the search text to filter custom fields definitions"},"examples":{"success":{"value":"sometext"},"failure":{"value":"sometext"}}}],"responses":{"200":{"description":"Success. Returns a list custom object definitions.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomObjectDefinitionsSchema"},"examples":{"success":{"value":{"items":[{"_id":"656db530766f951134509542","name":"customObject1","type":"customobject1","updated_at":"2023-12-04T11:17:04.136Z","entries_count":0,"fields_count":2},{"_id":"656db2d9766f95113450952b","name":"sample","type":"sample","updated_at":"2023-12-04T11:07:05.705Z","entries_count":0,"fields_count":1},{"_id":"656495b58d3278a7c24260f8","name":"address","type":"address","updated_at":"2023-11-27T13:12:21.999Z","entries_count":1,"fields_count":3},{"_id":"655c706ad5ff69fd3b95a1d9","name":"coCustomObject","type":"cocustomobject","updated_at":"2023-11-21T08:55:06.013Z","entries_count":0,"fields_count":2}],"page":{"type":"number","current":1,"size":10,"item_total":4,"has_next":false}}}}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"failure":{"$ref":"#/components/examples/4XXAPIError"}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"}}}}}}},"/service/platform/content/v1.0/company/{company_id}/application/{application_id}/metaobjects/definitions/{definition_id}":{"get":{"summary":"getAppCustomObjectDefinition | get custom object definition by id","description":"Use this API to update a custom object definition for your application.","tags":["Content"],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","description":"This is company id"},"examples":{"success":{"value":1},"failure":{"value":10},"success1":{"value":1},"success2":{"value":2},"duplicateFieldExample":{"value":11},"validationErrorExample":{"value":12},"failure2":{"value":10}}},{"name":"application_id","in":"path","required":true,"schema":{"type":"string","description":"This is application id"},"examples":{"success":{"value":"5eda528b97457fe43a733ace"},"failure":{"value":"5eda528b97457fe43a733acd"}}},{"name":"definition_id","in":"path","required":true,"schema":{"type":"string","description":"This is definition id"},"examples":{"success":{"value":"65369afad436ae0e54147e86"},"failure":{"value":"5eda528b97457fe43a733acd"}}}],"responses":{"200":{"description":"Custom object definition details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomObjectDefinitionSchema"},"examples":{"success":{"value":{"_id":"656d67de766f95113450917b","name":"Designer","type":"designer","display_name_key":"name","description":"","creator":"company","created_by":"9759643b65ebc6bacb5275f5","updated_by":"bd7223b6727eb087987eece7","field_definitions":[{"creator":"company","resource":"metaobject","name":"city2","namespace":"designer","key":"city","type":"string_single_line","description":"","multi_value":false,"validations":[],"company_id":"2","metaobject_definition_id":"656d67de766f95113450917b","required":false},{"creator":"company","resource":"metaobject","name":"mobile","namespace":"designer","key":"mobile","type":"string_single_line","description":"","multi_value":false,"validations":[],"company_id":"2","metaobject_definition_id":"656d67de766f95113450917b","required":false},{"creator":"company","resource":"metaobject","name":"name","namespace":"designer","key":"name","type":"string_single_line","description":"This is name of designer","multi_value":false,"validations":[],"company_id":"2","metaobject_definition_id":"656d67de766f95113450917b","required":true}]}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"}}}}}},"put":{"summary":"updateAppCustomObjectDefinition | Update custom object definition","description":"Use this API to update a custom object definition for your application.","tags":["Content"],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","description":"This is company id"},"examples":{"success":{"value":1},"failure":{"value":10},"success1":{"value":1},"success2":{"value":2},"duplicateFieldExample":{"value":11},"validationErrorExample":{"value":12},"failure2":{"value":10}}},{"name":"application_id","in":"path","required":true,"schema":{"type":"string","description":"This is application id"},"examples":{"success":{"value":"5eda528b97457fe43a733ace"},"failure":{"value":"5eda528b97457fe43a733acd"}}},{"name":"definition_id","in":"path","required":true,"schema":{"type":"string","description":"This is definition id"},"examples":{"success":{"value":"65369afad436ae0e54147e86"},"failure":{"value":"5eda528b97457fe43a733acd"}}}],"requestBody":{"description":"Custom object definition data","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomObjectDefinitionUpdateRequestSchema"},"examples":{"success1":{"$ref":"#/components/examples/CustomObjectDefinitionExample"},"failure":{"$ref":"#/components/examples/CustomObjectDefinitionExample"}}}}},"responses":{"200":{"description":"Custom field definition updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomObjectDefinitionSchema"},"examples":{"success":{"value":{"_id":"656d67de766f95113450917b","name":"Designer","type":"designer","display_name_key":"name","description":"","creator":"company","created_by":"9759643b65ebc6bacb5275f5","updated_by":"bd7223b6727eb087987eece7","field_definitions":[{"creator":"company","resource":"metaobject","name":"city2","namespace":"designer","key":"city","type":"string_single_line","description":"","multi_value":false,"validations":[],"company_id":"2","metaobject_definition_id":"656d67de766f95113450917b","required":false},{"creator":"company","resource":"metaobject","name":"mobile","namespace":"designer","key":"mobile","type":"string_single_line","description":"","multi_value":false,"validations":[],"company_id":"2","metaobject_definition_id":"656d67de766f95113450917b","required":false},{"creator":"company","resource":"metaobject","name":"name","namespace":"designer","key":"name","type":"string_single_line","description":"This is name of designer","multi_value":false,"validations":[],"company_id":"2","metaobject_definition_id":"656d67de766f95113450917b","required":true}]}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"}}}}}},"delete":{"summary":"deleteAppCustomObjectDefinition | delete custom object definition by id","description":"Use this API to delete a custom object definition and related data for your application.","tags":["Content"],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","description":"This is company id"},"examples":{"success":{"value":1},"failure":{"value":10},"success1":{"value":1},"success2":{"value":2},"duplicateFieldExample":{"value":11},"validationErrorExample":{"value":12},"failure2":{"value":10}}},{"name":"application_id","in":"path","required":true,"schema":{"type":"string","description":"This is application id"},"examples":{"success":{"value":"5eda528b97457fe43a733ace"},"failure":{"value":"5eda528b97457fe43a733acd"}}},{"name":"definition_id","in":"path","required":true,"schema":{"type":"string","description":"This is definition id"},"examples":{"success":{"value":"65369afad436ae0e54147e86"},"failure":{"value":"5eda528b97457fe43a733acd"}}}],"responses":{"200":{"description":"Custom object definition details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomObjectDefinitionDeleteResponseSchema"},"examples":{"success":{"value":{"success":true,"message":"MetaObjectDefinition deleted successfully"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"}}}}}}},"/service/platform/content/v1.0/company/{company_id}/application/{application_id}/metaobjects":{"get":{"summary":"getAppCustomObjects | Get list of custom objects","description":"Use this API to retrieve the custom objects.","tags":["Content"],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","description":"This is company id"},"examples":{"success":{"value":1},"failure":{"value":10},"success1":{"value":1},"success2":{"value":2},"duplicateFieldExample":{"value":11},"validationErrorExample":{"value":12},"failure2":{"value":10}}},{"name":"application_id","in":"path","required":true,"schema":{"type":"string","description":"This is application id"},"examples":{"success":{"value":"5eda528b97457fe43a733ace"},"failure":{"value":"5eda528b97457fe43a733acd"}}},{"name":"definition_id","in":"query","required":false,"schema":{"type":"string","description":"This is definition id"},"examples":{"success":{"value":"65369afad436ae0e54147e86"},"failure":{"value":"5eda528b97457fe43a733acd"}}},{"name":"page_no","in":"query","required":true,"schema":{"type":"string","description":"This is the page number"},"examples":{"success":{"value":1},"failure":{"value":1}}},{"name":"page_size","in":"query","required":true,"schema":{"type":"string","description":"This is the page size"},"examples":{"success":{"value":10},"failure":{"value":10}}}],"responses":{"200":{"description":"Success. Returns a list of custom objects. Refer `CustomObjectsSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomObjectsSchema"},"examples":{"success":{"$ref":"#/components/examples/CustomObjects"}}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"}}}}}},"post":{"summary":"createAppCustomObject | Create custom object entries","description":"Use this API to create the custom object entry.","tags":["Content"],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","description":"This is company id"},"examples":{"success":{"value":1},"failure":{"value":10},"success1":{"value":1},"success2":{"value":2},"duplicateFieldExample":{"value":11},"validationErrorExample":{"value":12},"failure2":{"value":10}}},{"name":"application_id","in":"path","required":true,"schema":{"type":"string","description":"This is application id"},"examples":{"success":{"value":"5eda528b97457fe43a733ace"},"failure":{"value":"5eda528b97457fe43a733acd"}}}],"requestBody":{"description":"Custom object data with field entry","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomObjectRequestSchema"},"examples":{"success1":{"$ref":"#/components/examples/CustomObjectSuccessExample1"},"success2":{"$ref":"#/components/examples/CustomObjectSuccessExample2"},"failure":{"$ref":"#/components/examples/CustomObjectFailureExample"}}}}},"responses":{"200":{"description":"Success. Returns a list of custom objects. Refer `CustomObjectSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomObjectSchema"},"examples":{"success":{"$ref":"#/components/examples/CustomObject"}}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"failure":{"value":{"status":400,"message":"Sorry, field(s) should be unique","code":"CX-2004","exception":"","request_id":"","info":"E11000 duplicate key error collection: meta.metafield_definitions index: namespace_1_key_1_resource_1_company_id_1_application_id_1 dup key: { namespace: \"abcd10\", key: \"llll\", resource: \"metaobject\", company_id: \"1\", application_id: null }","stack_trace":"","meta":{}}}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"}}}}}}},"/service/platform/content/v1.0/company/{company_id}/application/{application_id}/metaobjects/{metaobject_id}":{"get":{"summary":"getAppCustomObject | Get custom object details","description":"Use this API to retrieve the custom object details and their fields details and definitions and references.","tags":["Content"],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","description":"This is company id"},"examples":{"success":{"value":1},"failure":{"value":10},"success1":{"value":1},"success2":{"value":2},"duplicateFieldExample":{"value":11},"validationErrorExample":{"value":12},"failure2":{"value":10}}},{"name":"application_id","in":"path","required":true,"schema":{"type":"string","description":"This is application id"},"examples":{"success":{"value":"5eda528b97457fe43a733ace"},"failure":{"value":"5eda528b97457fe43a733acd"}}},{"name":"metaobject_id","in":"path","required":true,"schema":{"type":"string","description":"This is meta object id"},"examples":{"success":{"value":"65392bd912376081aafa90ff"},"failure":{"value":"5eda528b97457fe43a733acd"}}}],"responses":{"200":{"description":"Success. Returns a custom object. Refer `CustomObjectByIdSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomObjectByIdSchema"},"examples":{"success":{"$ref":"#/components/examples/CustomObjectByIdRes"}}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"}}}}}},"delete":{"summary":"deleteAppCustomObject | Delete custom object","description":"Use this API to delete the custom object entry by id. This will also delete related custom fields entries related to this custom object.","tags":["Content"],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","description":"This is company id"},"examples":{"success":{"value":1},"failure":{"value":10},"success1":{"value":1},"success2":{"value":2},"duplicateFieldExample":{"value":11},"validationErrorExample":{"value":12},"failure2":{"value":10}}},{"name":"application_id","in":"path","required":true,"schema":{"type":"string","description":"This is application id"},"examples":{"success":{"value":"5eda528b97457fe43a733ace"},"failure":{"value":"5eda528b97457fe43a733acd"}}},{"name":"metaobject_id","in":"path","required":true,"schema":{"type":"string","description":"This is meta object id"},"examples":{"success":{"value":"65392bd912376081aafa90ff"},"failure":{"value":"5eda528b97457fe43a733acd"}}}],"responses":{"200":{"description":"Success. It will returns the message for delete successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomDataDeleteSchema"},"examples":{"success":{"$ref":"#/components/examples/CustomDataDeleteResponse"}}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"failure":{"value":{"status":404,"message":"MetaObject Definition Not Found","code":"CX-1027","exception":"","request_id":"","stack_trace":"","meta":{}}}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"}}}}}},"put":{"summary":"updateAppCustomObject | Update custom object details","description":"Use this API to update a custom object detail for your application.","tags":["Content"],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","description":"This is company id"},"examples":{"success":{"value":1},"failure":{"value":10},"success1":{"value":1},"success2":{"value":2},"duplicateFieldExample":{"value":11},"validationErrorExample":{"value":12},"failure2":{"value":10}}},{"name":"application_id","in":"path","required":true,"schema":{"type":"string","description":"This is application id"},"examples":{"success":{"value":"5eda528b97457fe43a733ace"},"failure":{"value":"5eda528b97457fe43a733acd"}}},{"name":"metaobject_id","in":"path","required":true,"schema":{"type":"string","description":"This is meta object id"},"examples":{"success":{"value":"65392bd912376081aafa90ff"},"failure":{"value":"5eda528b97457fe43a733acd"}}}],"requestBody":{"description":"Custom object definition data","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomObjectRequestSchema"},"examples":{"success1":{"$ref":"#/components/examples/CustomObjectRequestExample"},"failure":{"$ref":"#/components/examples/CustomObjectRequestExampleFailure"}}}}},"responses":{"200":{"description":"Custom field definition created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomObjectByIdSchema"},"examples":{"success":{"value":{"_id":"656d67de766f95113450917b","name":"Designer","type":"designer","display_name_key":"name","description":"","creator":"company","created_by":"9759643b65ebc6bacb5275f5","updated_by":"bd7223b6727eb087987eece7","field_definitions":[{"creator":"company","resource":"metaobject","name":"city2","namespace":"designer","key":"city","type":"string_single_line","description":"","multi_value":false,"validations":[],"company_id":"2","metaobject_definition_id":"656d67de766f95113450917b","required":false},{"creator":"company","resource":"metaobject","name":"mobile","namespace":"designer","key":"mobile","type":"string_single_line","description":"","multi_value":false,"validations":[],"company_id":"2","metaobject_definition_id":"656d67de766f95113450917b","required":false},{"creator":"company","resource":"metaobject","name":"name","namespace":"designer","key":"name","type":"string_single_line","description":"This is name of designer","multi_value":false,"validations":[],"company_id":"2","metaobject_definition_id":"656d67de766f95113450917b","required":true}]}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"}}}}}}},"/service/platform/content/v1.0/company/{company_id}/application/{application_id}/metaobjects/jobs":{"get":{"summary":"getAppJobs | Fetch bulk import and export job list.","description":"Use this api to get list of jobs of bulk import and exports","tags":["Content"],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","description":"This is company id"},"examples":{"success":{"value":1},"failure":{"value":10},"success1":{"value":1},"success2":{"value":2},"duplicateFieldExample":{"value":11},"validationErrorExample":{"value":12},"failure2":{"value":10}}},{"name":"application_id","in":"path","required":true,"schema":{"type":"string","description":"This is application id"},"examples":{"success":{"value":"5eda528b97457fe43a733ace"},"failure":{"value":"5eda528b97457fe43a733acd"}}},{"name":"page","in":"query","required":true,"schema":{"type":"string","description":"This is the page number"},"examples":{"success":{"value":1},"failure":{"value":1}}},{"name":"page_size","in":"query","required":true,"schema":{"type":"string","description":"This is the page size"},"examples":{"success":{"value":10},"failure":{"value":10}}},{"name":"action_type","in":"query","required":true,"schema":{"type":"string","description":"This is the action type"},"examples":{"success":{"value":"upload"},"failure":{"value":"upload"}}}],"responses":{"200":{"description":"Success. Returns all bulk entries history. ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomObjectBulkEntry"},"examples":{"success":{"value":{"items":[{"_id":"6570124da20cc45d3f2582a7","jobs":["2311"],"finished_jobs":["2311"],"error_jobs":[],"errors_occured":[],"company_id":"2","creator":"company","URL":"https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/misc/custom-data/CustomObject-designer-import-6570124da20cc45d3f2582a7.csv","status":"completed","action_type":"upload","entity":"metaobject","error_url":"","finished_count":0,"error_count":0,"success_count":0,"total_jobs":1,"meta":{"mo_total_count":2,"mo_success_count":2,"mo_error_count":0,"mo_defintion_type":"designer"},"created_by":"bd7223b6727eb087987eece7","created_at":"2023-12-06T06:18:53.219Z","updated_at":"2023-12-06T06:20:23.560Z","id":"6570124da20cc45d3f2582a7"},{"_id":"6558b8c49340c43a7015b4af","jobs":["2297"],"finished_jobs":["2297"],"error_jobs":[],"errors_occured":[],"company_id":"2","creator":"company","URL":"https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/misc/custom-data/CustomObject-kuldeep-custom-import-6558b8c49340c43a7015b4af.csv","status":"completed","action_type":"upload","entity":"metaobject","error_url":"","finished_count":0,"error_count":0,"success_count":0,"total_jobs":1,"meta":{"mo_total_count":1,"mo_success_count":0,"mo_error_count":1,"mo_defintion_type":"kuldeep-custom"},"created_by":"9759643b65ebc6bacb5275f5","created_at":"2023-11-18T13:14:44.360Z","updated_at":"2023-11-18T13:17:19.765Z","id":"6558b8c49340c43a7015b4af"}],"page":{"type":"number","current":1,"size":20,"item_total":2,"has_next":false}}}}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"}}}}}}},"/service/platform/content/v1.0/company/{company_id}/application/{application_id}/metaobjects/bulk/{definition_id}/upload":{"post":{"summary":"importAppCustomObjectEntries | Bulk custom object entries upload","description":"Use this API to upload custom object entries","tags":["Content"],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","description":"This is company id"},"examples":{"success":{"value":1},"failure":{"value":10},"success1":{"value":1},"success2":{"value":2},"duplicateFieldExample":{"value":11},"validationErrorExample":{"value":12},"failure2":{"value":10}}},{"name":"application_id","in":"path","required":true,"schema":{"type":"string","description":"This is application id"},"examples":{"success":{"value":"5eda528b97457fe43a733ace"},"failure":{"value":"5eda528b97457fe43a733acd"}}},{"name":"definition_id","in":"path","required":true,"schema":{"type":"string","description":"This is definition id"},"examples":{"success":{"value":"65369afad436ae0e54147e86"},"failure":{"value":"5eda528b97457fe43a733acd"}}}],"requestBody":{"description":"Custom Object bulk entires url and total counts.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomObjectBulkSchema"},"examples":{"success":{"$ref":"#/components/examples/CustomObjectBulkUploadExample"},"failure":{"$ref":"#/components/examples/CustomObjectBulkUploadFailureExample"}}}}},"responses":{"200":{"description":"Success. Returns confirmation that the upload has started","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomObjectEntryBulkUploadResponse"},"examples":{"success":{"value":{"message":"Bulk upload of Meta objects started successfully","task_id":"6570124da20cc45d3f2582a7"}}}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"failure":{"value":{"status":400,"message":"Invalid MetaObject Request","code":"CX-1028","exception":"","request_id":"","info":"Total records is required","stack_trace":"","meta":{}}}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"}}}}}}},"/service/platform/content/v1.0/company/{company_id}/application/{application_id}/metaobjects/bulk/{definition_id}/download":{"get":{"summary":"exportAppCustomObjectEntries | Initiate download for bulk custom object entries","description":"Use this api to initiate download of bulk entries","tags":["Content"],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","description":"This is company id"},"examples":{"success":{"value":1},"failure":{"value":10},"success1":{"value":1},"success2":{"value":2},"duplicateFieldExample":{"value":11},"validationErrorExample":{"value":12},"failure2":{"value":10}}},{"name":"application_id","in":"path","required":true,"schema":{"type":"string","description":"This is application id"},"examples":{"success":{"value":"5eda528b97457fe43a733ace"},"failure":{"value":"5eda528b97457fe43a733acd"}}},{"name":"definition_id","in":"path","required":true,"schema":{"type":"string","description":"This is definition id"},"examples":{"success":{"value":"65369afad436ae0e54147e86"},"failure":{"value":"5eda528b97457fe43a733acd"}}}],"responses":{"200":{"description":"Success. Initiates bulk entries download ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomObjectBulkEntryInitiateDownload"},"examples":{"success":{"value":{"message":"Bulk download of Meta Objects started successfully","task_id":"65702d2aa20cc45d3f258358"}}}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"}}}}}}},"/service/platform/content/v1.0/company/{company_id}/application/{application_id}/metaobjects/bulk/{definition_id}/sample":{"get":{"summary":"sampleAppCustomObjectBulkEntry | download sample for custom object bulk entry","description":"Use this api to get sample csv file ","tags":["Content"],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","description":"This is company id"},"examples":{"success":{"value":1},"failure":{"value":10},"success1":{"value":1},"success2":{"value":2},"duplicateFieldExample":{"value":11},"validationErrorExample":{"value":12},"failure2":{"value":10}}},{"name":"application_id","in":"path","required":true,"schema":{"type":"string","description":"This is application id"},"examples":{"success":{"value":"5eda528b97457fe43a733ace"},"failure":{"value":"5eda528b97457fe43a733acd"}}},{"name":"definition_id","in":"path","required":true,"schema":{"type":"string","description":"This is definition id"},"examples":{"success":{"value":"65369afad436ae0e54147e86"},"failure":{"value":"5eda528b97457fe43a733acd"}}}],"responses":{"200":{"description":"Success. Get headers of custom object definition","content":{"application/json":{"schema":{"type":"string"},"examples":{"success":{"value":"city,mobile,name,custom_object_status"}}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"},"examples":{"default":{"$ref":"#/components/examples/4XXAPIError"}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentAPIError"}}}}}}},"/service/platform/discount/v1.0/company/{company_id}/job/":{"get":{"description":"Fetch discount list.","summary":"getDiscounts | Fetch discount list.","tags":["Discount"],"parameters":[{"name":"company_id","in":"path","description":"company_id","required":true,"schema":{"type":"integer"},"examples":{"400":{"value":90},"success_basic":{"value":90},"success_custom":{"value":90}}},{"name":"view","in":"query","description":"listing or calender.  Default is listing.","required":false,"schema":{"type":"string","enum":["listing","calender"]},"examples":{"400":{"value":"test"}}},{"name":"q","in":"query","description":"The search query. This can be a partial or complete name of a discount.","required":false,"schema":{"type":"string"},"examples":{"400":{"value":"Contract Test Custom"},"success_basic":{"value":"Contract Test Basic"},"success_custom":{"value":"Contract Test Custom"}}},{"name":"page_no","in":"query","description":"page number. Default is 1.","required":false,"schema":{"type":"integer"},"examples":{"400":{"value":1},"success_basic":{"value":1},"success_custom":{"value":1}}},{"name":"page_size","in":"query","description":"page size. Default is 12.","required":false,"schema":{"type":"integer"},"examples":{"400":{"value":10},"success_basic":{"value":10},"success_custom":{"value":10}}},{"name":"archived","in":"query","description":"archived. Default is false.","required":false,"schema":{"type":"boolean","enum":[true,false]}},{"name":"month","in":"query","description":"month. Default is current month.","required":false,"schema":{"type":"integer"},"examples":{"400":{"value":1},"success_basic":{"value":1},"success_custom":{"value":1}}},{"name":"year","in":"query","description":"year. Default is current year.","required":false,"schema":{"type":"integer"},"examples":{"400":{"value":2090},"success_basic":{"value":2090},"success_custom":{"value":2090}}},{"name":"type","in":"query","description":"basic or custom.","required":false,"schema":{"type":"string"},"examples":{"400":{"value":"basic"},"success_basic":{"value":"basic"},"success_custom":{"value":"custom"}}},{"name":"app_ids","in":"query","description":"application ids.","required":false,"schema":{"type":"array","items":{"type":"string"}},"examples":{"400":{"value":["646f43ee3b7f8c2847e31fb0"]},"success_basic":{"value":["646f43ee3b7f8c2847e31fb0"]},"success_custom":{"value":["646f43ee3b7f8c2847e31fb0"]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListOrCalender"},"examples":{"success_basic":{"value":{"items":[{"is_active":false,"app_ids":["646f43ee3b7f8c2847e31fb0"],"_id":"xxxxxxxxxxxx","name":"Discount Basic","job_type":"app","discount_type":"percentage","discount_level":"application","company_id":90,"validity":{"start":"2021-04-06T08:25:34.110Z","end":"2021-04-22T18:30:00.000Z"},"value":0,"created_by":{"username":"narutouzumaki","user_id":"0"},"modified_by":{"username":"narutouzumaki","user_id":"0"},"created_on":"2021-04-06T08:10:16.609Z","modified_on":"2021-04-07T08:19:12.007Z","brand_ids":[90],"store_ids":[1001]}],"page":{"current":1,"item_total":1,"type":"number","size":1,"has_previous":true,"has_next":false}}},"success_custom":{"value":{"items":[{"is_active":false,"app_ids":["646f43ee3b7f8c2847e31fb0"],"_id":"xxxxxxxxxxxx","name":"Discount","job_type":"app|brand|product","discount_type":"percentage","discount_level":"application","company_id":90,"validity":{"start":"2021-04-06T08:25:34.110Z","end":"2021-04-22T18:30:00.000Z"},"value":0,"file_path":"https://xxx.xxx.xxx/file.xlsx","created_by":{"username":"narutouzumaki","user_id":"0"},"modified_by":{"username":"narutouzumaki","user_id":"0"},"created_on":"2021-04-06T08:10:16.609Z","modified_on":"2021-04-07T08:19:12.007Z","brand_ids":[90],"store_ids":[1001]}],"page":{"current":1,"item_total":1,"type":"number","size":1,"has_previous":true,"has_next":false}}}}}}},"400":{"description":"Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestObjectGet"},"examples":{"400":{"value":"company id missing."}}}}}}},"post":{"description":"Create Discount.","summary":"createDiscount | Create Discount.","tags":["Discount"],"parameters":[{"name":"company_id","in":"path","description":"company_id","required":true,"schema":{"type":"integer"},"examples":{"400":{"value":90},"success_basic":{"value":90},"success_custom":{"value":90}}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUpdateDiscount"},"examples":{"400":{"value":{"name":"Contract Discount Custom","company_id":90,"is_active":true,"app_ids":["646f43ee3b7f8c2847e31fb0"],"job_type":"app|brand|store|product","discount_type":"flat","discount_level":"application","value":10,"file_path":"http://xxx.xxx.xxx/file.csv","brand_ids":[90],"store_ids":[1001],"discount_meta":{"timer":true,"hours":20,"minutes":35},"validity":{"start":"2090-04-11T08:19:12.007Z","end":"2090-04-11T08:20:12.007Z"}}},"success_basic":{"value":{"name":"Contract Discount Basic","company_id":90,"is_active":true,"app_ids":["646f43ee3b7f8c2847e31fb0"],"job_type":"app","discount_type":"flat","discount_level":"application","value":10,"brand_ids":[90],"store_ids":[1001],"discount_meta":{"timer":true,"hours":20,"minutes":35},"validity":{"start":"2090-04-07T08:19:12.007Z","end":"2090-04-10T08:19:12.007Z"}}},"success_custom":{"value":{"name":"Contract Discount Custom","company_id":90,"is_active":true,"app_ids":["646f43ee3b7f8c2847e31fb0"],"job_type":"app|brand|store|product","discount_type":"flat","discount_level":"application","value":10,"file_path":"http://xxx.xxx.xxx/file.csv","brand_ids":[90],"store_ids":[1001],"discount_meta":{"timer":true,"hours":20,"minutes":35},"validity":{"start":"2090-04-11T08:19:12.007Z","end":"2090-04-13T08:19:12.007Z"}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscountJob"},"examples":{"success_basic":{"value":{"_id":"64a7c915c160922f34ba4f12","name":"Contract Discount Name","company_id":90,"is_active":true,"app_ids":["646f43ee3b7f8c2847e31fb0"],"job_type":"app","discount_type":"flat","discount_level":"application","value":10,"brand_ids":[90],"store_ids":[1001],"discount_meta":{"timer":true,"hours":20,"minutes":35},"validity":{"start":"2090-04-07T08:19:12.007Z","end":"2090-04-10T08:19:12.007Z"},"created_on":"2021-04-06T08:19:12.007Z","modified_on":"2021-04-06T08:19:12.007Z","created_by":{"username":"narutouzumaki","user_id":"0"},"modified_by":{"username":"narutouzumaki","user_id":"0"}}},"success_custom":{"value":{"_id":"64a7c915c160922f34ba4f12","name":"Contract Discount Name","company_id":90,"is_active":true,"app_ids":["646f43ee3b7f8c2847e31fb0"],"job_type":"app","discount_type":"flat","discount_level":"application","value":10,"brand_ids":[90],"store_ids":[1001],"discount_meta":{"timer":true,"hours":20,"minutes":35},"validity":{"start":"2090-04-07T08:19:12.007Z","end":"2090-04-10T08:19:12.007Z"},"created_on":"2021-04-06T08:19:12.007Z","modified_on":"2021-04-06T08:19:12.007Z","created_by":{"username":"narutouzumaki","user_id":"0"},"modified_by":{"username":"narutouzumaki","user_id":"0"}}}}}}},"400":{"description":"Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestObject"},"examples":{"400":{"value":{"message":"The end time of discount should be at least 15 minutes ahead of the start time."}}}}}}}}},"/service/platform/discount/v1.0/company/{company_id}/job/{id}/":{"get":{"description":"Fetch discount.","summary":"getDiscount | Fetch discount.","tags":["Discount"],"parameters":[{"name":"company_id","in":"path","description":"company_id","required":true,"schema":{"type":"integer"},"examples":{"400":{"value":90},"success_basic":{"value":90},"success_custom":{"value":90}}},{"name":"id","in":"path","description":"unique id.","required":true,"schema":{"type":"string"},"examples":{"400":{"value":"test"},"success_basic":{"value":"64a7c915c160922f34ba4f12"},"success_custom":{"value":"62c538dd6c0f710007ac6dbf"}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscountJob"},"examples":{"success_basic":{"value":{"_id":"64a7c915c160922f34ba4f12","name":"Discount Name","company_id":90,"is_active":true,"app_ids":["646f43ee3b7f8c2847e31fb0"],"job_type":"app","discount_type":"flat","discount_level":"application","value":10,"brand_ids":[90],"store_ids":[1001],"discount_meta":{"timer":true,"hours":20,"minutes":35},"validity":{"start":"2021-04-07T08:19:12.007Z","end":"2021-04-10T08:19:12.007Z"},"created_on":"2021-04-06T08:19:12.007Z","modified_on":"2021-04-06T08:19:12.007Z","created_by":{"username":"narutouzumaki","user_id":"0"},"modified_by":{"username":"narutouzumaki","user_id":"0"}}},"success_custom":{"value":{"_id":"62c538dd6c0f710007ac6dbf","name":"Discount Name","company_id":90,"is_active":true,"app_ids":["646f43ee3b7f8c2847e31fb0"],"job_type":"app|brand|product","file_path":"https://xxx.xxx.xxx/file.xlsx","discount_type":"flat","discount_level":"application","value":10,"brand_ids":[90],"store_ids":[1001],"discount_meta":{"timer":true,"hours":20,"minutes":35},"validity":{"start":"2021-04-07T08:19:12.007Z","end":"2021-04-10T08:19:12.007Z"},"created_on":"2021-04-06T08:19:12.007Z","modified_on":"2021-04-06T08:19:12.007Z","created_by":{"username":"narutouzumaki","user_id":"0"},"modified_by":{"username":"narutouzumaki","user_id":"0"}}}}}}},"400":{"description":"Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestObject"},"examples":{"400":{"value":{"message":"Invalid Id."}}}}}}}},"put":{"description":"Update Discount.","summary":"updateDiscount | Update Discount.","tags":["Discount"],"parameters":[{"name":"company_id","in":"path","description":"company_id","required":true,"schema":{"type":"integer"},"examples":{"400":{"value":90},"success_basic":{"value":90},"success_custom":{"value":90}}},{"name":"id","in":"path","description":"id","required":true,"schema":{"type":"string"},"examples":{"400":{"value":"62c538dd6c0f710007ac6dbf"},"success_basic":{"value":"64a7c915c160922f34ba4f12"},"success_custom":{"value":"62c538dd6c0f710007ac6dbf"}}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUpdateDiscount"},"examples":{"400":{"value":{"name":"Discount Name Custom","company_id":90,"is_active":true,"app_ids":["646f43ee3b7f8c2847e31fb0"],"job_type":"app|brand|store|inventory","discount_type":"flat","discount_level":"application","file_path":"https://xxx.xxx.xxx/file.xlsx","value":10,"brand_ids":[90],"store_ids":[1001],"discount_meta":{"timer":true,"hours":20,"minutes":35},"validity":{"start":"2090-05-11T08:19:12.007Z","end":"2090-05-13T08:19:12.007Z"}}},"success_basic":{"value":{"name":"Discount Name","company_id":90,"is_active":true,"app_ids":["646f43ee3b7f8c2847e31fb0"],"job_type":"app","discount_type":"flat","discount_level":"application","value":10,"brand_ids":[90],"store_ids":[1001],"discount_meta":{"timer":true,"hours":20,"minutes":35},"validity":{"start":"2090-05-07T08:19:12.007Z","end":"2090-05-10T08:19:12.007Z"}}},"success_custom":{"value":{"name":"Discount Name Custom","company_id":90,"is_active":true,"app_ids":["646f43ee3b7f8c2847e31fb0"],"job_type":"app|brand|store|product","discount_type":"flat","discount_level":"application","file_path":"https://xxx.xxx.xxx/file.xlsx","value":10,"brand_ids":[90],"store_ids":[1001],"discount_meta":{"timer":true,"hours":20,"minutes":35},"validity":{"start":"2090-05-11T08:19:12.007Z","end":"2090-05-13T08:19:12.007Z"}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscountJob"},"examples":{"success_basic":{"value":{"_id":"64a7c915c160922f34ba4f12","name":"Discount Name","company_id":90,"is_active":true,"app_ids":["646f43ee3b7f8c2847e31fb0"],"job_type":"app","discount_type":"flat","discount_level":"application","value":10,"brand_ids":[90],"store_ids":[1001],"discount_meta":{"timer":true,"hours":20,"minutes":35},"validity":{"start":"2021-04-07T08:19:12.007Z","end":"2021-04-10T08:19:12.007Z"},"created_by":{"username":"narutouzumaki","user_id":"0"},"modified_by":{"username":"narutouzumaki","user_id":"0"}}},"success_custom":{"value":{"_id":"64a7c915c160922f34ba4f12","name":"Discount Name","company_id":90,"is_active":true,"app_ids":["646f43ee3b7f8c2847e31fb0"],"job_type":"app","discount_type":"flat","discount_level":"application","file_path":"https://xxx.xxx.xxx/file.xlsx","value":10,"brand_ids":[90],"store_ids":[1001],"discount_meta":{"timer":true,"hours":20,"minutes":35},"validity":{"start":"2021-04-07T08:19:12.007Z","end":"2021-04-10T08:19:12.007Z"},"created_by":{"username":"narutouzumaki","user_id":"0"},"modified_by":{"username":"narutouzumaki","user_id":"0"}}}}}}},"400":{"description":"Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestObject"},"examples":{"400":{"value":{"message":"Once a discount is created, its type cannot be changed. Try creating a new discount."}}}}}}}}},"/service/platform/discount/v1.0/company/{company_id}/job/{id}/items/":{"post":{"description":"Create custom discounts through API.","summary":"upsertDiscountItems | Create custom discount from bulk.","tags":["Discount"],"parameters":[{"name":"company_id","in":"path","description":"A `company_id` is the unique identifier of the company.","required":true,"schema":{"type":"integer"},"examples":{"400":{"value":90},"success_product":{"value":90},"success_inventory":{"value":90}}},{"name":"id","in":"path","description":"Job ID of the discount.","required":true,"schema":{"type":"string"},"examples":{"400":{"value":"64a7c915c160922f34ba4f12"},"success_product":{"value":"603f54c3f6f7fd000925925b"},"success_inventory":{"value":"6040f016099e3a0009fe591e"}}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkDiscount"},"examples":{"400":{"value":{"items":[{"value":500,"seller_identifier":"8907664561001","discount_type":"flat","discount_meta":{"timer":true,"hours":20,"minutes":35}}],"company_id":90}},"success_product":{"value":{"items":[{"value":500,"item_code":"XMSS0701001","brand_name":"Contract Being Human","discount_type":"flat","discount_meta":{"timer":true,"hours":20,"minutes":35}}],"company_id":90}},"success_inventory":{"value":{"items":[{"value":500,"seller_identifier":"8907664561001","discount_type":"flat","discount_meta":{"timer":true,"hours":20,"minutes":35}}],"company_id":90}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"}}},"examples":{"success_product":{"value":{"success":true}},"success_inventory":{"value":{"success":true}}}}}},"400":{"description":"Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestObject"},"examples":{"400":{"value":{"message":"Not a custom discount."}}}}}}}}},"/service/platform/discount/v1.0/company/{company_id}/file/validation/":{"post":{"description":"Validate File.","summary":"validateDiscountFile | Validate File.","tags":["Discount"],"parameters":[{"name":"company_id","in":"path","description":"company_id","required":true,"schema":{"type":"integer"},"examples":{"400":{"value":90},"success":{"value":"90"}}},{"name":"discount","in":"query","description":"discount","required":false,"schema":{"type":"string"},"examples":{"400":{"value":"6512735aa98e0ed14ef1f1fd"},"success":{"value":"6512735aa98e0ed14ef1f1fd"}}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileJobRequest"},"examples":{"400":{"value":{"name":"Discount Name","is_active":true,"company_id":90,"app_ids":["646f43ee3b7f8c2847e31fb0"],"job_type":"app|brand|product","discount_type":"flat","discount_level":"application","file_path":"http://xxx.xxx.xxx/file.jpg","brand_ids":[90],"store_ids":[1001],"validity":{"start":"2090-04-07T08:19:12.007Z","end":"2090-04-10T08:19:12.007Z"}}},"success":{"value":{"name":"Discount Name","is_active":true,"company_id":90,"app_ids":["646f43ee3b7f8c2847e31fb0"],"job_type":"app|brand|product","discount_type":"flat","discount_level":"application","file_path":"http://xxx.xxx.xxx/file.csv","brand_ids":[90],"store_ids":[1001],"validity":{"start":"2090-04-07T08:19:12.007Z","end":"2090-04-10T08:19:12.007Z"}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileJobResponse"},"examples":{"success":{"value":{"_id":"xxxxxxxxxxxx","stage":"processing","total":10,"failed":0,"company_id":90,"file_path":"https://xxx.xxx.xxx/file.xlsx","body":{"is_active":false,"app_ids":["646f43ee3b7f8c2847e31fb0"],"_id":"xxxxxxxxxxxx","name":"Discount","job_type":"app|brand|product","discount_type":"percentage","discount_level":"application","company_id":90,"file_path":"https://xxx.xxx.xxx/file.xlsx","validity":{"start":"2090-04-06T08:25:34.110Z","end":"2090-04-22T18:30:00.000Z"},"value":null,"created_by":{"username":"narutouzumaki","user_id":"0"},"modified_by":{"username":"narutouzumaki","user_id":"0"},"created_on":"2021-04-06T08:10:16.609Z","modified_on":"2021-04-07T08:19:12.007Z","brand_ids":[90],"store_ids":[1001]},"type":"download","file_type":"product"}}}}}},"400":{"description":"Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestObject"},"examples":{"400":{"value":{"message":"Invalid File"}}}}}}}}},"/service/platform/discount/v1.0/company/{company_id}/file/{type}/download/":{"post":{"description":"Validate File.","summary":"downloadDiscountFile | Validate File.","tags":["Discount"],"parameters":[{"name":"company_id","in":"path","description":"company_id","required":true,"schema":{"type":"integer"},"examples":{"400":{"value":90},"success":{"value":90}}},{"name":"type","in":"path","description":"type","required":true,"schema":{"type":"string","enum":["product","inventory"]},"examples":{"400":{"value":"test"}}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DownloadFileJob"},"examples":{"400":{"value":{"brand_ids":[90],"store_ids":[1001]}},"success":{"value":{"brand_ids":[90],"store_ids":[1001]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileJobResponse"},"examples":{"success":{"value":{"_id":"xxxxxxxxxxxx","stage":"processing","total":10,"failed":0,"company_id":90,"file_path":"https://xxx.xxx.xxx/file.xlsx","body":{"is_active":false,"app_ids":["646f43ee3b7f8c2847e31fb0"],"_id":"xxxxxxxxxxxx","name":"Discount","job_type":"app","discount_type":"percentage","discount_level":"application","company_id":90,"file_path":"https://xxx.xxx.xxx/file.xlsx","validity":{"start":"2021-04-06T08:25:34.110Z","end":"2021-04-22T18:30:00.000Z"},"value":null,"created_by":{"username":"narutouzumaki","user_id":"0"},"modified_by":{"username":"narutouzumaki","user_id":"0"},"created_on":"2021-04-06T08:10:16.609Z","modified_on":"2021-04-07T08:19:12.007Z","brand_ids":[90],"store_ids":[1001]},"type":"download","file_type":"product"}}}}}},"400":{"description":"Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestObject"},"examples":{"400":{"value":{"message":"Not a valid choice. Choices are Product or Inventory"}}}}}}}}},"/service/platform/discount/v1.0/company/{company_id}/file/validation/{id}/":{"get":{"description":"Validate File Job.","summary":"getValidationJob | Validate File Job.","tags":["Discount"],"parameters":[{"name":"company_id","in":"path","description":"company_id","required":true,"schema":{"type":"integer"},"examples":{"400":{"value":90},"success":{"value":90}}},{"name":"id","in":"path","description":"id","required":true,"schema":{"type":"string"},"examples":{"400":{"value":"652b7d4fd25ec5b4acd798c1"},"success":{"value":"6519669e7fc0cd03ce111ab9"}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileJobResponse"},"examples":{"success":{"value":{"_id":"6519669e7fc0cd03ce111ab9","stage":"processing","total":10,"failed":0,"company_id":90,"file_path":"https://xxx.xxx.xxx/file.xlsx","body":{"is_active":false,"app_ids":["646f43ee3b7f8c2847e31fb0"],"_id":"64a7c915c160922f34ba4f12","name":"Discount","job_type":"app","discount_type":"percentage","discount_level":"application","company_id":90,"file_path":"https://xxx.xxx.xxx/file.xlsx","validity":{"start":"2021-04-06T08:25:34.110Z","end":"2021-04-22T18:30:00.000Z"},"value":null,"created_by":{"username":"narutouzumaki","user_id":"0"},"modified_by":{"username":"narutouzumaki","user_id":"0"},"created_on":"2021-04-06T08:10:16.609Z","modified_on":"2021-04-07T08:19:12.007Z","brand_ids":[90],"store_ids":[1001]},"type":"download","file_type":"product"}}}}}},"400":{"description":"Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestObjectGet"},"examples":{"400":{"value":{"data":{"message":"Job Not Found."}}}}}}}}},"delete":{"description":"Cancel Validation Job.","summary":"cancelValidationJob | Cancel Validation Job.","tags":["Discount"],"parameters":[{"name":"company_id","in":"path","description":"company_id","required":true,"schema":{"type":"integer"},"examples":{"400":{"value":90},"success":{"value":90}}},{"name":"id","in":"path","description":"id","required":true,"schema":{"type":"string"},"examples":{"400":{"value":"652b7d4fd25ec5b4acd798c1"},"success":{"value":"6519669e7fc0cd03ce111ab9"}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelJobResponse"},"examples":{"success":{"value":{"success":true}}}}}},"400":{"description":"Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestObjectGet"},"examples":{"400":{"value":{"data":{"message":"Job Not Found."}}}}}}}}}},"/service/platform/discount/v1.0/company/{company_id}/file/download/{id}/":{"get":{"description":"Download File Job.","summary":"getDownloadJob | Download File Job.","tags":["Discount"],"parameters":[{"name":"company_id","in":"path","description":"company_id","required":true,"schema":{"type":"integer"},"examples":{"400":{"value":90},"success":{"value":90}}},{"name":"id","in":"path","description":"id","required":true,"schema":{"type":"string"},"examples":{"400":{"value":"test"},"success":{"value":"651b00ef29aedf98f98a8cbd"}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileJobResponse"},"examples":{"success":{"value":{"_id":"651b00ef29aedf98f98a8cbd","stage":"processing","total":10,"failed":0,"company_id":90,"file_path":"https://xxx.xxx.xxx/file.xlsx","body":{"is_active":false,"app_ids":["646f43ee3b7f8c2847e31fb0"],"_id":"64a7c915c160922f34ba4f12","name":"Discount","job_type":"app","discount_type":"percentage","discount_level":"application","company_id":90,"file_path":"https://xxx.xxx.xxx/file.xlsx","validity":{"start":"2021-04-06T08:25:34.110Z","end":"2021-04-22T18:30:00.000Z"},"value":null,"created_by":{"username":"narutouzumaki","user_id":"0"},"modified_by":{"username":"narutouzumaki","user_id":"0"},"created_on":"2021-04-06T08:10:16.609Z","modified_on":"2021-04-07T08:19:12.007Z","brand_ids":[90],"store_ids":[1001]},"type":"download","file_type":"product"}}}}}},"400":{"description":"Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestObjectGet"},"examples":{"400":{"value":{"data":{"message":"Invalid Id."}}}}}}}}},"delete":{"description":"Cancel Download Job.","summary":"cancelDownloadJob | Cancel Download Job.","tags":["Discount"],"parameters":[{"name":"company_id","in":"path","description":"company_id","required":true,"schema":{"type":"integer"},"examples":{"400":{"value":1},"success":{"value":1}}},{"name":"id","in":"path","description":"id","required":true,"schema":{"type":"string"},"examples":{"400":{"value":"test"},"success":{"value":"651b00ef29aedf98f98a8cbd"}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelJobResponse"},"examples":{"success":{"value":{"success":true}}}}}},"400":{"description":"Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestObjectGet"},"examples":{"400":{"value":{"data":{"message":"Invalid Id."}}}}}}}}}},"/service/platform/assets/v1.0/company/{company_id}/namespaces/{namespace}/upload/start":{"post":{"summary":"startUpload | This operation initiates upload and returns storage link which is valid for 30 Minutes. You can use that storage link to make subsequent upload request with file buffer or blob.","description":"Uploads an arbitrarily sized buffer or blob.\n\nIt has three Major Steps:\n* Start\n* Upload\n* Complete\n\n### Start\nInitiates the assets upload using `startUpload`.\nIt returns the storage link in response.\n\n### Upload\nUse the storage link to upload a file (Buffer or Blob) to the File Storage.\nMake a `PUT` request on storage link received from `startUpload` api with file (Buffer or Blob) as a request body.\n\n### Complete\nAfter successfully upload, call `completeUpload` api to complete the upload process.\nThis operation will return the url for the uploaded file.\n","tags":["FileStorage"],"parameters":[{"name":"namespace","in":"path","description":"Segregation of different types of files(products, orders, logistics etc), Required for validating the data of the file being uploaded, decides where exactly the file will be stored inside the storage bucket.","required":true,"schema":{"type":"string"},"examples":{"success":{"value":"test"},"failure":{"value":"test123"}}},{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","description":"This is company id"},"examples":{"success":{"value":2}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartRequest"},"examples":{"success":{"value":{"file_name":"shirt.png","content_type":"application/pdf","size":500,"params":{"subpath":"test"},"tags":["clothing","men"]}},"failure":{"value":{"file_name":"shirt.png","content_type":"image/png","namespace":"products-item-assets","size":500,"params":{"subpath":"test"},"tags":["clothing","men"]}}}}}},"responses":{"200":{"description":"Success. Returns a response containing relaving and absolute_url of storage service","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartResponse"},"examples":{"success":{"value":{"file_name":"shirt.png","file_path":"/path/qwertyuiop-shirt.png","content_type":"image/png","method":"PUT","namespace":"products-item-images","operation":"putObject","tags":["clothing","shirt"],"size":9999,"cdn":{"url":"https://xxx.xxx.xxx/products/pictures/free/original/qwertyuiop-shirt.png","absolute_url":"https://xxx.xxx.xxx/products/pictures/free/original/qwertyuiop-shirt.png","relative_url":"products/pictures/free/original/qwertyuiop-shirt.png"},"upload":{"expiry":5000,"url":"https://xxx.xxx.xxx/products/pictures/free/original/qwertyuiop-shirt.png?AWSAccessKeyId=xxx&Content-Type=image%2Fpng&Expires=5000&Signature=xxx&x-amz-acl=public-read"}}}}}}},"400":{"description":"Missing or incorrect required field","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"},"status":{"type":"string"},"valid_namespaces":{"type":"array","items":{"type":"string"}}}},"examples":{"failure":{"value":{"status":"error","message":"params.subpath required","valid_namespaces":["misc","admin-catalogue-import-export","admin-catalogue-assets"]}}}}}}}}},"/service/platform/assets/v1.0/company/{company_id}/namespaces/{namespace}/upload/complete":{"post":{"summary":"completeUpload | This will complete the upload process. After successfully uploading file, you can call this operation to complete the upload process.","description":"Uploads an arbitrarily sized buffer or blob.\n\nIt has three Major Steps:\n* Start\n* Upload\n* Complete\n\n### Start\nInitiates the assets upload using `startUpload`.\nIt returns the storage link in response.\n\n### Upload\nUse the storage link to upload a file (Buffer or Blob) to the File Storage.\nMake a `PUT` request on storage link received from `startUpload` api with file (Buffer or Blob) as a request body.\n\n### Complete\nAfter successfully upload, call `completeUpload` api to complete the upload process.\nThis operation will return the url for the uploaded file.\n","tags":["FileStorage"],"parameters":[{"name":"namespace","in":"path","description":"Segregation of different types of files(products, orders, logistics etc), Required for validating the data of the file being uploaded, decides where exactly the file will be stored inside the storage bucket.","required":true,"schema":{"type":"string"},"examples":{"success":{"value":"test"},"failure":{"value":"test123"}}},{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","description":"This is company id"},"examples":{"success":{"value":2}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartResponse"},"examples":{"success":{"value":{"file_name":"shirt.png","file_path":"/path/qwertyuiop-shirt.png","content_type":"image/png","method":"PUT","namespace":"test","operation":"putObject","tags":["clothing","shirt"],"size":9999,"cdn":{"url":"https://hdn-1.jiomarketx0.de/x0/support-ticket-private/file/free/original/myl1-tBeF-download.jpeg\",","absolute_url":"https://hdn-1.jiomarketx0.de/x0/support-ticket-private/file/free/original/myl1-tBeF-download.jpeg\",","relative_url":"addsale/support-ticket-private/file/free/original/myl1-tBeF-download.jpeg"},"upload":{"expiry":5000,"url":"https://hdn-1.jiomarketx0.de/x0/support-ticket-private/file/free/original/myl1-tBeF-download.jpeg"}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompleteResponse"},"examples":{"success":{"value":{"success":true,"_id":"xxxxxxxxxxxxxxxxxxxxxx","file_name":"shirt.png","file_path":"/path/qwertyuiop-shirt.png","content_type":"image/png","namespace":"products-item-images","operation":"putObject","company_id":2,"tags":["clothing","shirt"],"size":9999,"cdn":{"url":"https://xxx.xxx.xxx/products/pictures/free/original/qwertyuiop-shirt.png","absolute_url":"https://xxx.xxx.xxx/products/pictures/free/original/qwertyuiop-shirt.png","relative_url":"products/pictures/free/original/qwertyuiop-shirt.png"},"upload":{"expiry":5000,"url":"https://xxx.xxx.xxx/products/pictures/free/original/qwertyuiop-shirt.png?AWSAccessKeyId=xxx&Content-Type=image%2Fpng&Expires=5000&Signature=xxx&x-amz-acl=public-read"},"created_on":"2020-02-03T09:50:04.240Z","modified_on":"2020-02-03T09:50:04.240Z"}}}}}},"400":{"description":"cdn is not passed correctly","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"},"_message":{"type":"string"},"name":{"type":"string"},"errors":{"type":"object","properties":{"namespace":{"type":"object","properties":{"message":{"type":"string"},"name":{"type":"string"},"value":{"type":"string"},"kind":{"type":"string"},"path":{"type":"string"},"properties":{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"},"path":{"type":"string"},"enumValues":{"type":"array","items":{"type":"string"}}}}}}}}}},"examples":{"failure":{"value":{"errors":{"namespace":{"name":"ValidatorError","message":"`test123` is not a valid enum value for path `namespace`.","properties":{"message":"`test123` is not a valid enum value for path `namespace`.","type":"enum","enumValues":["misc","admin-catalogue-import-export","admin-catalogue-assets"],"path":"namespace","value":"test123"},"kind":"enum","path":"namespace","value":"test123"}},"_message":"Assets validation failed","name":"ValidationError","message":"Assets validation failed: namespace: `test123` is not a valid enum value for path `namespace`."}}}}}}}}},"/service/platform/assets/v1.0/company/{company_id}/application/{application_id}/namespaces/{namespace}/upload/start":{"post":{"summary":"appStartUpload | This operation initiates upload and returns storage link which is valid for 30 Minutes. You can use that storage link to make subsequent upload request with file buffer or blob.","description":"Uploads an arbitrarily sized buffer or blob.\n\nIt has three Major Steps:\n* Start\n* Upload\n* Complete\n\n### Start\nInitiates the assets upload using `appStartUpload`.\nIt returns the storage link in response.\n\n### Upload\nUse the storage link to upload a file (Buffer or Blob) to the File Storage.\nMake a `PUT` request on storage link received from `appStartUpload` api with file (Buffer or Blob) as a request body.\n\n### Complete\nAfter successfully upload, call `appCompleteUpload` api to complete the upload process.\nThis operation will return the url for the uploaded file.\n","tags":["FileStorage"],"parameters":[{"name":"namespace","in":"path","description":"Segregation of different types of files(products, orders, logistics etc), Required for validating the data of the file being uploaded, decides where exactly the file will be stored inside the storage bucket.","required":true,"schema":{"type":"string"},"examples":{"success":{"value":"test"},"failure":{"value":"test123"}}},{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","description":"This is company id"},"examples":{"success":{"value":2}}},{"name":"application_id","in":"path","required":true,"schema":{"type":"string","description":"This is application id"},"examples":{"success":{"value":"5eda528b97457fe43a733ace"},"failure":{"value":"5eda528b97457fe43a733acd"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartRequest"},"examples":{"success":{"value":{"file_name":"shirt.png","content_type":"image/png","size":500,"params":{"subpath":"test"},"tags":["clothing","men"]}},"failure":{"value":{"file_name":"shirt.png","content_type":"image/png","namespace":{"value":"products-item-assets","summary":"Segregation of different types of files(products, orders, logistics etc)"},"size":500,"params":{"subpath":"test"},"tags":["clothing","men"]}}}}}},"responses":{"200":{"description":"Success. Returns a response containing relaving and absolute_url of storage service","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartResponse"},"examples":{"success":{"value":{"file_name":"shirt.png","file_path":"/path/qwertyuiop-shirt.png","content_type":"image/png","method":"PUT","namespace":"products-item-images","operation":"putObject","tags":["clothing","shirt"],"size":9999,"cdn":{"url":"https://xxx.xxx.xxx/products/pictures/free/original/qwertyuiop-shirt.png","absolute_url":"https://xxx.xxx.xxx/products/pictures/free/original/qwertyuiop-shirt.png","relative_url":"products/pictures/free/original/qwertyuiop-shirt.png"},"upload":{"expiry":5000,"url":"https://xxx.xxx.xxx/products/pictures/free/original/qwertyuiop-shirt.png?AWSAccessKeyId=xxx&Content-Type=image%2Fpng&Expires=5000&Signature=xxx&x-amz-acl=public-read"}}}}}}},"400":{"description":"Missing or incorrect required field","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"},"status":{"type":"string"},"valid_namespaces":{"type":"array","items":{"type":"string"}}}},"examples":{"failure":{"value":{"status":"error","message":"params.subpath required","valid_namespaces":["misc","admin-catalogue-import-export","admin-catalogue-assets"]}}}}}}}}},"/service/platform/assets/v1.0/company/{company_id}/application/{application_id}/namespaces/{namespace}/upload/complete":{"post":{"summary":"appCompleteUpload | This will complete the upload process. After successfully uploading file, you can call this operation to complete the upload process.","description":"Uploads an arbitrarily sized buffer or blob.\n\nIt has three Major Steps:\n* Start\n* Upload\n* Complete\n\n### Start\nInitiates the assets upload using `appStartUpload`.\nIt returns the storage link in response.\n\n### Upload\nUse the storage link to upload a file (Buffer or Blob) to the File Storage.\nMake a `PUT` request on storage link received from `appStartUpload` api with file (Buffer or Blob) as a request body.\n\n### Complete\nAfter successfully upload, call `appCompleteUpload` api to complete the upload process.\nThis operation will return the url for the uploaded file.\n","tags":["FileStorage"],"parameters":[{"name":"namespace","in":"path","description":"Segregation of different types of files(products, orders, logistics etc), Required for validating the data of the file being uploaded, decides where exactly the file will be stored inside the storage bucket.","required":true,"schema":{"type":"string"},"examples":{"success":{"value":"test"},"failure":{"value":"test123"}}},{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","description":"This is company id"},"examples":{"success":{"value":2}}},{"name":"application_id","in":"path","required":true,"schema":{"type":"string","description":"This is application id"},"examples":{"success":{"value":"5eda528b97457fe43a733ace"},"failure":{"value":"5eda528b97457fe43a733acd"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartResponse"},"examples":{"success":{"value":{"file_name":"shirt.png","file_path":"/path/qwertyuiop-shirt.png","content_type":"image/png","method":"PUT","namespace":"test","operation":"putObject","tags":["clothing","shirt"],"size":9999,"cdn":{"url":"https://xxx.xxx.xxx/products/pictures/free/original/qwertyuiop-shirt.png","absolute_url":"https://xxx.xxx.xxx/products/pictures/free/original/qwertyuiop-shirt.png","relative_url":"products/pictures/free/original/qwertyuiop-shirt.png"},"upload":{"expiry":5000,"url":"https://xxx.xxx.xxx/products/pictures/free/original/qwertyuiop-shirt.png?AWSAccessKeyId=xxx&Content-Type=image%2Fpng&Expires=5000&Signature=xxx&x-amz-acl=public-read"}}},"failure":{"value":{"file_name":"shirt.png","file_path":"/path/qwertyuiop-shirt.png","content_type":"image/png","method":"PUT","namespace":"test123","operation":"putObject","tags":["clothing","shirt"],"size":9999,"cdn":{"url":"https://xxx.xxx.xxx/products/pictures/free/original/qwertyuiop-shirt.png","absolute_url":"https://xxx.xxx.xxx/products/pictures/free/original/qwertyuiop-shirt.png","relative_url":"products/pictures/free/original/qwertyuiop-shirt.png"},"upload":{"expiry":5000,"url":"https://xxx.xxx.xxx/products/pictures/free/original/qwertyuiop-shirt.png?AWSAccessKeyId=xxx&Content-Type=image%2Fpng&Expires=5000&Signature=xxx&x-amz-acl=public-read"}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompleteResponse"},"examples":{"success":{"value":{"success":true,"_id":"xxxxxxxxxxxxxxxxxxxxxx","file_name":"shirt.png","file_path":"/path/qwertyuiop-shirt.png","content_type":"image/png","namespace":"products-item-images","operation":"putObject","company_id":2,"tags":["clothing","shirt"],"size":9999,"cdn":{"url":"https://xxx.xxx.xxx/products/pictures/free/original/qwertyuiop-shirt.png","absolute_url":"https://xxx.xxx.xxx/products/pictures/free/original/qwertyuiop-shirt.png","relative_url":"products/pictures/free/original/qwertyuiop-shirt.png"},"upload":{"expiry":5000,"url":"https://xxx.xxx.xxx/products/pictures/free/original/qwertyuiop-shirt.png?AWSAccessKeyId=xxx&Content-Type=image%2Fpng&Expires=5000&Signature=xxx&x-amz-acl=public-read"},"created_on":"2020-02-03T09:50:04.240Z","modified_on":"2020-02-03T09:50:04.240Z"}}}}}},"400":{"description":"cdn is not passed correctly","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"},"_message":{"type":"string"},"name":{"type":"string"},"errors":{"type":"object","properties":{"namespace":{"type":"object","properties":{"message":{"type":"string"},"name":{"type":"string"},"value":{"type":"string"},"kind":{"type":"string"},"path":{"type":"string"},"properties":{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"},"path":{"type":"string"},"enumValues":{"type":"array","items":{"type":"string"}}}}}}}}}},"examples":{"failure":{"value":{"errors":{"namespace":{"name":"ValidatorError","message":"`test123` is not a valid enum value for path `namespace`.","properties":{"message":"`test123` is not a valid enum value for path `namespace`.","type":"enum","enumValues":["misc","admin-catalogue-import-export","admin-catalogue-assets"],"path":"namespace","value":"test123"},"kind":"enum","path":"namespace","value":"test123"}},"_message":"Assets validation failed","name":"ValidationError","message":"Assets validation failed: namespace: `test123` is not a valid enum value for path `namespace`."}}}}}}}}},"/service/platform/assets/v1.0/company/{company_id}/sign-urls":{"post":{"summary":"getSignUrls | Gives signed urls to access private files","description":"Describe here","tags":["FileStorage"],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","description":"This is company id"},"examples":{"success":{"value":2}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignUrlRequest"},"examples":{"success":{"value":{"expiry":5000,"urls":["https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/fyndnp/wrkr/x0/documents/manifest/PDFs/test/s3EtYk5p9-new_fee.pdf"]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignUrlResponse"},"examples":{"success":{"value":{"urls":[{"url":"https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/fyndnp/wrkr/x0/documents/manifest/PDFs/test/s3EtYk5p9-new_fee.pdf","signed_url":"https://fynd-staging-assets-private.s3-accelerate.amazonaws.com/addsale/v2/falling-surf-7c8bb8/fyndnp/wrkr/x0/documents/manifest/PDFs/test/s3EtYk5p9-new_fee.pdf","expiry":1800}]}}}}}}}}},"/service/platform/assets/v1.0/company/{company_id}/uploads/copy":{"post":{"summary":"copyFiles | Copy Files","description":"Copy Files","tags":["FileStorage"],"parameters":[{"name":"sync","in":"query","required":false,"schema":{"type":"boolean","description":"Copy files operation should run in sync mode or not"},"examples":{"nonSyncMode":{"value":false},"failure":{"value":false}}},{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","description":"This is company id"},"examples":{"success":{"value":2}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CopyFiles"},"examples":{"nonSyncMode":{"value":{"destination":{"namespace":"test"},"urls":["https://hdn-1.fynd.com/platform/pictures/free-logo/original/7qdHNTFe--platform-logo.png"]}},"failure":{"value":{"destination":{"namespace":"test"}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"tracking_url":{"type":"string"},"task":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"data":{"type":"object","properties":{"urls":{"type":"array","items":{"type":"string"}},"destination":{"type":"object","properties":{"namespace":{"type":"string"},"basepath":{"type":"string"}}}}},"opts":{"type":"object","properties":{"attempts":{"type":"number"},"backoff":{"type":"object","properties":{"type":{"type":"string"},"delay":{"type":"number"}}},"delay":{"type":"number"},"timestamp":{"type":"number"}}},"progress":{"type":"number"},"delay":{"type":"number"},"timestamp":{"type":"number"},"attemptsMade":{"type":"number"},"returnvalue":{"type":"string","nullable":true},"finishedOn":{"type":"string","nullable":true},"processedOn":{"type":"string","nullable":true},"stacktrace":{"type":"array","items":{"type":"object"}}}}}},"examples":{"nonSyncMode":{"$ref":"#/components/examples/uploadCopySuccessPayload"}}}}},"400":{"description":"Failed","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}},"examples":{"failure":{"value":{"message":"Please provide aleast one url"}}}}}}}}},"/service/platform/assets/v1.0/company/{company_id}/application/{application_id}/uploads/copy":{"post":{"summary":"appCopyFiles | Copy Files","description":"Copy Files","tags":["FileStorage"],"parameters":[{"name":"sync","in":"query","description":"sync","required":false,"schema":{"type":"boolean"},"examples":{"nonSyncMode":{"value":false},"failure":{"value":true}}},{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","description":"This is company id"},"examples":{"success":{"value":2}}},{"name":"application_id","in":"path","required":true,"schema":{"type":"string","description":"This is application id"},"examples":{"success":{"value":"5eda528b97457fe43a733ace"},"failure":{"value":"5eda528b97457fe43a733acd"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CopyFiles"},"examples":{"nonSyncMode":{"value":{"destination":{"namespace":"test"},"urls":["https://hdn-1.fynd.com/platform/pictures/free-logo/original/7qdHNTFe--platform-logo.png"]}},"failure":{"value":{"destination":{"namespace":"test"}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"tracking_url":{"type":"string"},"task":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"data":{"type":"object","properties":{"urls":{"type":"array","items":{"type":"string"}},"destination":{"type":"object","properties":{"namespace":{"type":"string"},"basepath":{"type":"string"}}}}},"opts":{"type":"object","properties":{"attempts":{"type":"number"},"backoff":{"type":"object","properties":{"type":{"type":"string"},"delay":{"type":"number"}}},"delay":{"type":"number"},"timestamp":{"type":"number"}}},"progress":{"type":"number"},"delay":{"type":"number"},"timestamp":{"type":"number"},"attemptsMade":{"type":"number"},"returnvalue":{"type":"string","nullable":true},"finishedOn":{"type":"string","nullable":true},"processedOn":{"type":"string","nullable":true},"stacktrace":{"type":"array","items":{"type":"object"}}}}}},"examples":{"nonSyncMode":{"$ref":"#/components/examples/uploadCopySuccessPayload"}}}}},"400":{"description":"Failed","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}},"examples":{"failure":{"value":{"message":"Please provide aleast one url"}}}}}}}}},"/service/platform/assets/v1.0/company/{company_id}/namespaces/{namespace}/browse":{"get":{"summary":"browse | Browse Files","description":"Browse Files","tags":["FileStorage"],"parameters":[{"name":"namespace","in":"path","description":"Segregation of different types of files(products, orders, logistics etc), Required for validating the data of the file being uploaded, decides where exactly the file will be stored inside the storage bucket.","required":true,"schema":{"type":"string"},"examples":{"success":{"value":"test"},"failure":{"value":"test123"}}},{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","description":"This is company id"},"examples":{"success":{"value":2}}},{"name":"page","in":"query","description":"page no","required":false,"schema":{"type":"integer"},"examples":{"success":{"value":1}}},{"name":"limit","in":"query","description":"Limit","required":false,"schema":{"type":"integer"},"examples":{"success":{"value":1}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["items","page"],"properties":{"items":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string"},"file_name":{"type":"string"},"file_path":{"type":"string"},"success":{"type":"boolean"},"namespace":{"type":"string"},"content_type":{"type":"string"},"size":{"type":"number"},"operation":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"cdn":{"type":"object","properties":{"url":{"type":"string"}}},"upload":{"type":"object","properties":{"url":{"type":"string"},"expiry":{"type":"number"}}},"created_by":{"type":"object","properties":{"username":{"type":"string"}}},"company_id":{"type":"number"},"bucket_key":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"__v":{"type":"number"}}}},"page":{"type":"object","required":["type"],"properties":{"item_total":{"type":"integer","format":"int32"},"next_id":{"type":"string"},"has_previous":{"type":"boolean"},"has_next":{"type":"boolean"},"current":{"type":"integer","format":"int32"},"type":{"type":"string"},"size":{"type":"integer","format":"int32"}},"example":{"current":1,"item_total":15,"type":"number","has_next":true,"size":10}}}},"examples":{"success":{"$ref":"#/components/examples/BrowseResponseExample"}}}}},"400":{"description":"Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FailedResponse"},"examples":{"failure":{"value":{"message":"Invalid namespace"}}}}}}}}},"/service/platform/assets/v1.0/company/{company_id}/application/{application_id}/namespaces/{namespace}/browse":{"get":{"summary":"appbrowse | Browse Files","description":"Browse Files","tags":["FileStorage"],"parameters":[{"name":"namespace","in":"path","description":"Segregation of different types of files(products, orders, logistics etc), Required for validating the data of the file being uploaded, decides where exactly the file will be stored inside the storage bucket.","required":true,"schema":{"type":"string"},"examples":{"success":{"value":"test"},"failure":{"value":"test123"}}},{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","description":"This is company id"},"examples":{"success":{"value":2}}},{"name":"application_id","in":"path","required":true,"schema":{"type":"string","description":"This is application id"},"examples":{"success":{"value":"5eda528b97457fe43a733ace"},"failure":{"value":"5eda528b97457fe43a733acd"}}},{"name":"page","in":"query","description":"page no","required":false,"schema":{"type":"integer"},"examples":{"success":{"value":1}}},{"name":"limit","in":"query","description":"Limit","required":false,"schema":{"type":"integer"},"examples":{"success":{"value":1}}},{"name":"search","in":"query","description":"Search","required":false,"schema":{"type":"string"},"examples":{"success":{"value":"test"}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["items","page"],"properties":{"items":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string"},"file_name":{"type":"string"},"file_path":{"type":"string"},"success":{"type":"boolean"},"namespace":{"type":"string"},"content_type":{"type":"string"},"size":{"type":"number"},"operation":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"cdn":{"type":"object","properties":{"url":{"type":"string"}}},"upload":{"type":"object","properties":{"url":{"type":"string"},"expiry":{"type":"number"}}},"created_by":{"type":"object","properties":{"username":{"type":"string"}}},"company_id":{"type":"number"},"bucket_key":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"__v":{"type":"number"}}}},"page":{"type":"object","required":["type"],"properties":{"item_total":{"type":"integer","format":"int32"},"next_id":{"type":"string"},"has_previous":{"type":"boolean"},"has_next":{"type":"boolean"},"current":{"type":"integer","format":"int32"},"type":{"type":"string"},"size":{"type":"integer","format":"int32"}},"example":{"current":1,"item_total":15,"type":"number","has_next":true,"size":10}}}},"examples":{"success":{"$ref":"#/components/examples/BrowseResponseExample"}}}}},"400":{"description":"Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FailedResponse"},"examples":{"failure":{"value":{"message":"Invalid namespace"}}}}}}}},"post":{"summary":"browsefiles | Browse Files","description":"Browse Files","tags":["FileStorage"],"parameters":[{"name":"namespace","in":"path","description":"Segregation of different types of files(products, orders, logistics etc), Required for validating the data of the file being uploaded, decides where exactly the file will be stored inside the storage bucket.","required":true,"schema":{"type":"string"},"examples":{"success":{"value":"test"},"failure":{"value":"test123"}}},{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","description":"This is company id"},"examples":{"success":{"value":2}}},{"name":"application_id","in":"path","required":true,"schema":{"type":"string","description":"This is application id"},"examples":{"success":{"value":"5eda528b97457fe43a733ace"},"failure":{"value":"5eda528b97457fe43a733acd"}}},{"name":"page","in":"query","description":"page no","required":false,"schema":{"type":"integer"},"examples":{"success":{"value":1}}},{"name":"limit","in":"query","description":"Limit","required":false,"schema":{"type":"integer"},"examples":{"success":{"value":1}}},{"name":"search","in":"query","description":"Search","required":false,"schema":{"type":"string"},"examples":{"success":{"value":"test"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExtensionSlug"},"examples":{"success":{"value":{"extension_slug":"test"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["items","page"],"properties":{"items":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string"},"file_name":{"type":"string"},"file_path":{"type":"string"},"success":{"type":"boolean"},"namespace":{"type":"string"},"content_type":{"type":"string"},"size":{"type":"number"},"operation":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"cdn":{"type":"object","properties":{"url":{"type":"string"}}},"upload":{"type":"object","properties":{"url":{"type":"string"},"expiry":{"type":"number"}}},"created_by":{"type":"object","properties":{"username":{"type":"string"}}},"company_id":{"type":"number"},"bucket_key":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"__v":{"type":"number"}}}},"page":{"type":"object","required":["type"],"properties":{"item_total":{"type":"integer","format":"int32"},"next_id":{"type":"string"},"has_previous":{"type":"boolean"},"has_next":{"type":"boolean"},"current":{"type":"integer","format":"int32"},"type":{"type":"string"},"size":{"type":"integer","format":"int32"}},"example":{"current":1,"item_total":15,"type":"number","has_next":true,"size":10}}}},"examples":{"success":{"$ref":"#/components/examples/BrowseResponseExample"}}}}},"400":{"description":"Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FailedResponse"},"examples":{"failure":{"value":{"message":"Invalid namespace"}}}}}}}}},"/service/platform/assets/v1.0/company/{company_id}/proxy":{"get":{"summary":"proxy | Proxy","description":"Proxy","tags":["FileStorage"],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","description":"This is company id"},"examples":{"success":{"value":2}}},{"name":"url","in":"query","description":"url","required":true,"schema":{"type":"string"},"examples":{"success":{"value":"https://hdn-1.fynd.com/platform/pictures/free-logo/original/7qdHNTFe--platform-logo.png"},"failure":{"value":"platform/pictures/free-logo/original/7qdHNTFe--platform-logo.png"}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string","format":"binary"},"examples":{"success":{"value":"Binary stream data"}}}}}}}},"/service/platform/assets/v1.0/company/{company_id}/application/{application_id}/pdf/types":{"get":{"summary":"getPdfTypes | Get all the supported invoice pdf types","description":"Get all the supported invoice pdf types such as Invoice, Label, Delivery challan","tags":["FileStorage"],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","description":"This is company id"},"examples":{"success":{"value":2}}},{"name":"application_id","in":"path","required":true,"schema":{"type":"string","description":"This is application id"},"examples":{"success":{"value":"5eda528b97457fe43a733ace"},"failure":{"value":"5eda528b97457fe43a733acd"}}},{"name":"country_code","in":"query","schema":{"type":"string","description":"This is country_code for which data needs to be displayed on UI"},"examples":{"success":{"value":"IN"},"failure":{"value":"NA"}}}],"responses":{"200":{"description":"Get all the invoice types and its format","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceTypesResponse"},"examples":{"success":{"$ref":"#/components/examples/InvoiceTypesResponseExample"}}}}}}}},"/service/platform/assets/v1.0/company/{company_id}/application/{application_id}/pdf/mapper":{"get":{"summary":"getDefaultPdfData | Get Dummy pdf data for invoice or label","description":"Get Dummy pdf data for invoice or label","tags":["FileStorage"],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","description":"This is company id"},"examples":{"success":{"value":2}}},{"name":"application_id","in":"path","required":true,"schema":{"type":"string","description":"This is application id"},"examples":{"success":{"value":"5eda528b97457fe43a733ace"},"failure":{"value":"5eda528b97457fe43a733acd"}}},{"name":"pdf_type_id","in":"query","required":true,"schema":{"type":"integer","description":"This is invoice unique id"},"examples":{"success":{"value":1},"successEmptyValue":{"value":-1}}},{"name":"country_code","in":"query","schema":{"type":"string","description":"This is country_code for which data needs to be displayed on UI"},"examples":{"success":{"value":"IN"},"failure":{"value":"NA"}}}],"responses":{"200":{"description":"Get dummy json data for invoice","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DummyTemplateDataItems"},"examples":{"success":{"$ref":"#/components/examples/DummyTemplateDataItemsExample"},"successEmptyValue":{"value":{"data":[],"success":true}}}}}}}}},"/service/platform/assets/v1.0/company/{company_id}/application/{application_id}/pdf/config/{id}":{"put":{"summary":"updateHtmlTemplate | Update html template for invoice or label","description":"Update html template for invoice such as Invoice, Label, Deliver challan","tags":["FileStorage"],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","description":"This is company id"},"examples":{"success":{"value":2}}},{"name":"application_id","in":"path","required":true,"schema":{"type":"string","description":"This is application id"},"examples":{"success":{"value":"5eda528b97457fe43a733ace"},"failure":{"value":"5eda528b97457fe43a733acd"}}},{"name":"id","in":"path","required":true,"schema":{"type":"string","description":"This is mongo id"},"examples":{"success":{"value":"64dfd8fc8f3b8b5ae5beb72c"},"failure":{"value":"64dfd8fc8f3b8b5a"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PdfConfig"},"examples":{"success":{"value":{"pdf_type_id":1,"format":"A4","template":"PGRpdj4KICAKPC9kaXY+"}}}}}},"responses":{"200":{"description":"Update html template for invoice","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PdfConfigSaveSuccess"},"examples":{"success":{"$ref":"#/components/examples/PdfConfigSaveSuccessExample"}}}}},"500":{"description":"Failed","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"success":{"type":"boolean"}}},"examples":{"failure":{"value":{"message":"Error in Updating PDF Config for id","success":false}}}}}}}}},"/service/platform/assets/v1.0/company/{company_id}/application/{application_id}/pdf/config":{"get":{"summary":"getDefaultHtmlTemplate | Get html template for sales channel","description":"Get default html template for invoice or label","tags":["FileStorage"],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","description":"This is company id"},"examples":{"success":{"value":2}}},{"name":"application_id","in":"path","required":true,"schema":{"type":"string","description":"This is application id"},"examples":{"success":{"value":"5eda528b97457fe43a733ace"},"failure":{"value":"5eda528b97457fe43a733acd"}}},{"name":"pdf_type_id","in":"query","required":true,"schema":{"type":"integer","description":"This is invoice unique id"},"examples":{"success":{"value":1},"successEmptyValue":{"value":-1}}},{"name":"format","in":"query","required":true,"schema":{"type":"string","enum":["A4","A6","POS","A3"],"description":"This is invoice document format such as A4, A6, POS"},"examples":{"success":{"value":"A4"},"failure":{"value":"A3"}}},{"name":"country_code","in":"query","schema":{"type":"string","description":"This is country_code for which data needs to be displayed on UI"},"examples":{"success":{"value":"IN"},"failure":{"value":"NA"}}}],"responses":{"200":{"description":"Get last saved html template for invoice","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PdfConfigSuccess"},"examples":{"success":{"$ref":"#/components/examples/PdfConfigSuccessExample"},"failure":{"value":{"data":[],"success":true}}}}}}}},"post":{"summary":"saveHtmlTemplate | Update html template for invoice or label","description":"Update html template for invoice such as Invoice, Label, Deliver challan","tags":["FileStorage"],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","description":"This is company id"},"examples":{"success":{"value":2}}},{"name":"application_id","in":"path","required":true,"schema":{"type":"string","description":"This is application id"},"examples":{"success":{"value":"5eda528b97457fe43a733ace"},"failure":{"value":"5eda528b97457fe43a733acd"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PdfConfig"},"examples":{"success":{"value":{"pdf_type_id":30,"format":"A4","template":"PGRpdj4KICAgIEJpcGluCjwvZGl2Pg=="}},"failure":{"value":{"pdf_type_id":-1,"format":"A4","template":""}}}}}},"responses":{"201":{"description":"Saved html template for invoice","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PdfConfigSaveSuccess"},"examples":{"success":{"$ref":"#/components/examples/PdfConfigSaveSuccessExample"}}}}},"500":{"description":"Failed","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"success":{"type":"boolean"}}},"examples":{"failure":{"value":{"message":"Error in Updating PDF Config for id","success":false}}}}}}}}},"/service/platform/assets/v1.0/company/{company_id}/application/{application_id}/pdf/default-template":{"get":{"summary":"getDefaultPdfTemplate | Default html template","description":"Get default html template data for invoice or label","tags":["FileStorage"],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","description":"This is company id"},"examples":{"success":{"value":2}}},{"name":"application_id","in":"path","required":true,"schema":{"type":"string","description":"This is application id"},"examples":{"success":{"value":"5eda528b97457fe43a733ace"},"failure":{"value":"5eda528b97457fe43a733acd"}}},{"name":"pdf_type_id","in":"query","required":true,"schema":{"type":"integer","description":"This is invoice unique id"},"examples":{"success":{"value":1},"successEmptyValue":{"value":-1}}},{"name":"format","in":"query","required":true,"schema":{"type":"string","enum":["A4","A6","POS","A3"],"description":"This is invoice document format such as A4, A6, POS"},"examples":{"success":{"value":"A4"},"failure":{"value":"A3"}}},{"name":"country_code","in":"query","schema":{"type":"string","description":"This is country_code for which data needs to be displayed on UI"},"examples":{"success":{"value":"IN"},"failure":{"value":"NA"}}}],"responses":{"200":{"description":"Get rendered html with dummy json payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PdfDefaultTemplateSuccess"},"examples":{"success":{"value":{"data":[{"_id":"64b7f52d56a0cba5231964b0","pdf_type_id":1,"format":"A4","template":"<!DOCTYPE html>\n<html lang=\"en\">\n\n<head>\n    <meta charset=\"UTF-8\" />\n    <meta http-equiv=\"X-UA-Compatible\" content=\"IE=edge\" />\n    <meta name=\"viewport\" content=\"width=device-width, initial-scale=1.0\" />\n    <title>Invoice A4</title>\n    <link rel=\"preconnect\" href=\"https://fonts.googleapis.com\" />\n    <link rel=\"preconnect\" href=\"https://fonts.gstatic.com\" crossorigin />\n    <link href='https://fonts.googleapis.com/css?family=Noto Sans' rel='stylesheet'>\n    <style>\n        :root {\n            --black: #000;\n        }\n\n        html {\n            font-size: 10px;\n            display: flex;\n            justify-content: center;\n            word-break: break-all;\n        }\n\n        body {\n            width: 297mm;\n        }\n\n        * {\n            margin: 0;\n            padding: 0;\n            font-family: \"Montserrat\", sans-serif;\n            color: black;\n        }\n\n        p,\n        span {\n            font-size: 1.4rem;\n            line-height: 1.5;\n        }\n\n        .bold {\n            font-weight: bold;\n        }\n\n        .invoice-a4.wrapper {\n            padding: 1em;\n        }\n\n        .invoice-heading {\n            display: flex;\n            justify-content: space-between;\n        }\n\n        .invoice-heading .heading {\n            margin: 0.5rem 0;\n            font-size: 3rem;\n        }\n\n        #qrcode {\n            margin: auto;\n            width: 12rem;\n            height: 12rem;\n        }\n\n        .payment-qr-code {\n            display: flex;\n            flex-direction: column;\n            align-items: flex-end;\n            justify-content: flex-end;\n        }\n\n        .invoice-heading .sub-heading {\n            margin: 0.25rem 0;\n            font-size: 1.5rem;\n            font-weight: normal;\n        }\n\n        .invoice-heading .amount-to-be-collected {\n            margin: 0.25rem 0;\n        }\n\n        .invoice-heading .shipment-id {\n            margin: 0.25rem 0;\n        }\n\n        .invoice-heading .center-block {\n            margin-right: 10rem;\n        }\n\n        .center-block {\n            height: 53px;\n            width: 100px;\n        }\n\n        .center-block img {\n            max-width: 100%;\n            max-height: 100%;\n        }\n\n        .seller-customer-details {\n            margin: 1em 0;\n        }\n\n        .seller-customer-details h2 {\n            font-size: 1.5rem;\n            margin-bottom: 0.5rem;\n        }\n\n        .seller-customer-details .seller-customer-details-block {\n            width: 30%;\n            padding-right: 3%;\n            margin-top: 0.5rem;\n        }\n\n        .seller-customer-details .seller-customer-details-block p {\n            line-height: 1.5;\n        }\n\n        .seller-customer-details .primary-details {\n            display: flex;\n            flex-direction: row;\n        }\n\n        .seller-customer-details .secondary-details {\n            display: flex;\n            flex-direction: row;\n            margin-top: 0.5rem;\n        }\n\n        .product-breakup {\n            margin: 0.5rem 0;\n        }\n\n        .product-breakup table {\n            border: 0.15rem solid var(--black);\n            font-size: 1.5rem;\n            width: 100%;\n            border-collapse: collapse;\n        }\n\n        .product-breakup table td,\n        .product-breakup table th {\n            border: 0.15rem solid var(--black);\n            padding: 0.1rem;\n            font-size: 13px;\n        }\n\n        .product-breakup .product-finance-breakup {\n            text-align: center;\n        }\n\n        .product-breakup .product-finance-breakup .cod-charges .left-block,\n        .product-breakup .product-finance-breakup .delivery-charges .left-block,\n        .product-breakup .product-finance-breakup .total .left-block {\n            text-align: left;\n        }\n\n        .total-in-words {\n            text-align: right;\n        }\n\n        .product-hsn-table-breakup {\n            margin-top: 2rem;\n            text-align: center;\n        }\n\n        .product-hsn-table-breakup .products {\n            text-align: center;\n        }\n\n        .total-text {\n            text-align: left;\n            padding-left: 35px;\n        }\n\n        .declarations {\n            margin: 0.5rem 0;\n            font-size: 1.3rem;\n        }\n\n        .declarations .pointers {\n            margin-top: 0.5rem;\n            margin-left: 0.5rem;\n        }\n\n        .invoice-footer-section {\n            display: flex;\n            justify-content: space-between;\n            max-width: 75%;\n            margin-top: 1rem;\n        }\n\n        .invoice-footer-section .company-registered-address {\n            padding-left: 1rem;\n            margin-right: 1.5rem;\n        }\n        \n        .company-registered-address, .company-contact-number, .brand-logo{\n            max-width: 33%;\n        }\n\n        .invoice-disclaimer {\n            margin-top: 0.5rem;\n        }\n\n        .qr-code-size {\n            max-width: 100px;\n            margin-left: 15px;\n        }\n\n        .primary-details {\n            font-size: 5px;\n        }\n\n        .sign-text {\n            font-size: 1rem;\n            margin-top: 5px;\n        }\n        .brand_logo>img , .digital-signature>img{\n            height: 100px;\n            width: 100px;\n        }\n\n        @media print {\n            table {\n                page-break-after: auto;\n            }\n\n            tr {\n                page-break-inside: avoid;\n                page-break-after: auto;\n            }\n\n            td {\n                page-break-inside: avoid;\n                page-break-after: auto;\n            }\n\n            thead {\n                display: table-header-group;\n            }\n\n            tfoot {\n                display: table-footer-group;\n            }\n        }\n    </style>\n</head>\n\n<body>\n    {% if is_international %}\n    <div class=\"invoice-a4 wrapper\">\n        <div class=\"invoice-heading\">\n            <div class=\"left-block\">\n                <h1 class=\"heading\">Tax Invoice</h1>\n                {% if payload.mode === \"development\" %}\n                <h3 class=\"sub-heading\">Original for Recipient | Test Order</h3>\n                {% else %}\n                <h3 class=\"sub-heading\">Original for Recipient</h3>\n                {% endif %}\n                <p class=\"delivery-partner-name-awb-number-block\">\n                    {% if is_self_ship or is_self_pickup %}\n                    <span class=\"dp-name\">\n                        {{ delivery_partner_detail.name | upper }}\n                    </span>\n                    {% else %}\n                    <span class=\"dp-name\">\n                        {{ delivery_partner_detail.name | upper }} | AWB:\n                        {{ delivery_partner_detail.awb_number }}\n                    </span>\n                    {% endif %}\n                </p>\n                <p class=\"amount-to-be-collected\">\n                    <span>Amount to be collected:\n                    </span>\n                    <span class=\"bold\">{{ currency_code }}{{ (conversion_rate.rates[currency_code].value*amount_to_be_collected).toFixed(2) }}</span>\n                </p>\n                <p>\n                    <span class=\"invoice-no\">\n                        Invoice ID: {{ invoice_detail.invoice_id }}</span>\n                    <span class=\"horizontal-divider\">\n                        |\n                    </span>\n                    <span class=\"payment-type\">\n                        {% for payment in payments %}\n                        {% if loop.last %}\n                        {{ payment.payment_type }}\n                        {% else %}\n                        {{ payment.payment_type }},\n                        {% endif %}\n                        {% endfor %}\n                    </span>\n                <p>Invoice Date: {{ invoice_detail.invoice_date }}</p>\n                </p>\n                <p class=\"shipment-id\">\n                    Shipment Id - {{ invoice_detail.shipment_id }}\n                </p>\n                {% if invoice_detail.irn %}\n                <p class=\"irn-number\">IRN - {{ invoice_detail.irn }}</p>\n                {% endif %}\n            </div>\n            {% if image.sales_channel_logo %}\n            <div class=\"center-block\">\n                <img src=\"{{ image.sales_channel_logo }}\" alt=\"Platform Logo\" width=\"54px\" />\n            </div>\n            {% endif %}\n            <div class=\"right-block\">\n                {% if not is_self_ship and not is_self_pickup %}\n                <div class=\"awb-barcode\">\n                    <img src=\"{{ awb_number_barcode }}\" alt=\"{{ delivery_partner_detail.awb_number }}\" />\n                </div>\n                {% endif %}\n                {% if signed_qrcode %}\n                <div id=\"qrcode\">\n                    <img src=\"{{ signed_qrcode }}\" alt=\"IRN QR Code\" width=\"120px\" height=\"120px\" />\n                </div>\n                <div style=\"text-align: center; margin-top: 5px; margin-left: 10px; margin-bottom:5px\">\n                    IRN QR\n                </div>\n                {% endif %}\n            </div>\n        </div>\n        <hr />\n        <div class=\"seller-customer-details\">\n            <div class=\"first-row primary-details\">\n                <div class=\"sold-by seller-details seller-customer-details-block\">\n                    <h2>Sold By</h2>\n                    <p class=\"name\">{{ company_detail.name }}</p>\n                    <p class=\"address\">{{ store_detail.address }}</p>\n                    <p class=\"state-code\">State Code - {{ store_detail.state_code }}</p>\n                    {% if store_detail.gstin %}\n                    <p class=\"gst-number\">GSTIN - {{ store_detail.gstin }}</p>\n                    {% endif %}\n                    {% if company_detail.pan %}\n                    <p class=\"pan-no\">PAN - {{ company_detail.pan }}</p>\n                    {% endif %}\n                    {% if company_detail.phone_no %}\n                    <p class=\"phone_no\">Phone No: {{ company_detail.phone_no }}</p>\n                    {% endif %}\n                    {% if company_detail.cin %}\n                    <p>CIN: {{ company_detail.cin }}</p>\n                    {% endif %}\n                </div>\n                <div class=\"seller-customer-details-block fulfilling-store-details\">\n                    <h2>Ship From</h2>\n                    <p class=\"company-name\">{{ company_detail.name }}</p>\n                    <p class=\"address\">C/o {{ store_detail.address }}</p>\n                    <p class=\"state-code\">State Code - {{ store_detail.state_code }}</p>\n                    {% if store_detail.gstin %}\n                    <p class=\"gst-number\">GSTIN - {{ store_detail.gstin }}</p>\n                    {% endif %}\n                </div>\n            </div>\n            <div class=\"second-row secondary-details\">\n                <div class=\"billing-details seller-customer-details-block\">\n                    <h2>Bill To</h2>\n                    <p class=\"name\">\n                        {{ customer_billing_detail.name }} | Mobile:\n                        {{ customer_billing_detail.phone_no }}\n                    </p>\n                    <p class=\"address\">{{ customer_billing_detail.address }}</p>\n                </div>\n                <div class=\"customer-details ship-to seller-customer-details-block\">\n                    <h2>Ship To</h2>\n                    <p class=\"name\">\n                        {{ customer_shipping_detail.name }} | Mobile:\n                        {{ customer_shipping_detail.phone_no }}\n                    </p>\n                    <p class=\"address\">{{ customer_shipping_detail.address }}</p>\n                    {% if customer_shipping_detail.state_code %}\n                    <p class=\"place-of-supply\">\n                        Place of Supply: {{ customer_shipping_detail.state }}, {{ customer_shipping_detail.state_code }}\n                    </p>\n                    {% else %}\n                    <p class=\"place-of-supply\">\n                        Place of Supply: {{ customer_shipping_detail.state }}\n                    </p>\n                    {% endif %}\n                </div>\n            </div>\n        </div>\n        <p style=\"text-align: right\">\n            Total Items: {{ product_table.total_items }}\n        </p>\n        <div class=\"product-breakup\">\n            <table class=\"product-finance-breakup\">\n                <tr class=\"heading-row\">\n                    <th>Product</th>\n                    <th>Size</th>\n                    <th>Seller Identifier</th>\n                    <th>HSN Code</th>\n                    <th>Total Units</th>\n                    <th>MRP (Unit)</th>\n                    <th>Discount (Unit)</th>\n                    <th>Taxable Amount (Unit)</th>\n                    <th>Total Taxable Amount</th>\n                    {% if product_table.products[0].tax.igst.value>0 %}\n                    <th>Total IGST</th>\n                    {% else %}\n                    <th>Total CGST</th>\n                    <th>Total SGST</th>\n                    {% endif %}\n                    <th>Total</th>\n                </tr>\n                {% for product in product_table.products %}\n                <tr>\n                    <td>{{ product.name }}</td>\n                    <td>{{ product.size }}</td>\n                    <td>{{ product.seller_identifier }}</td>\n                    <td>{{ product.hsn_code }}</td>\n                    <td>{{ product.total_units }}</td>\n                    <td>{{ currency_code }}{{ (conversion_rate.rates[currency_code].value*product.mrp).toFixed(2) }}</td>\n                    <td>{{ currency_code }}{{ (conversion_rate.rates[currency_code].value*product.discount).toFixed(2) }}</td>\n                    <td>{{ currency_code }}{{ (conversion_rate.rates[currency_code].value*product.taxable_amount).toFixed(2) }}</td>\n                    <td>{{ currency_code }}{{ (conversion_rate.rates[currency_code].value*product.total_taxable_amount).toFixed(2) }}</td>\n                    {% if product.tax.igst.value>0 %}\n                    <td>\n                        {{ currency_code }}{{ (conversion_rate.rates[currency_code].value*product.tax.igst.value).toFixed(2) }} ({{ product.tax.igst.percent.toFixed(2) }}%)\n                    </td>\n                    {% else %}\n                    <td>\n                        {{ currency_code }}{{ (conversion_rate.rates[currency_code].value*product.tax.cgst.value).toFixed(2) }} ({{ product.tax.cgst.percent.toFixed(2) }}%)\n                    </td>\n                    <td>\n                        {{ currency_code }}{{ (conversion_rate.rates[currency_code].value*product.tax.sgst.value).toFixed(2) }} ({{ product.tax.sgst.percent.toFixed(2) }}%)\n                    </td>\n                    {% endif %}\n                    <td>{{ currency_code }}{{ (conversion_rate.rates[currency_code].value*product.total).toFixed(2) }}</td>\n                </tr>\n                {% endfor %}\n                {% if product_table.delivery_charges > 0 %}\n                <tr class=\"delivery-charges\">\n                    <td class=\"left-block\" colspan=\"3\" style=\"padding-left: 5px;\">{{product_table.delivery_charge_text}}\n                    </td>\n                    <td colspan=\"1\">996819</td>\n                    {% if product_table.products[0].tax.igst.value >0 %}\n                    <td colspan=\"6\"></td>\n                    {% else %}\n                    <td colspan=\"7\"></td>\n                    {% endif %}\n                    <td class=\"right-block\" colspan=\"1\">\n                        {{ currency_code }}{{ (conversion_rate.rates[currency_code].value*product_table.delivery_charges).toFixed(2) }}\n                    </td>\n                </tr>\n                {% endif %}\n                {% if product_table.cod_charges > 0 %}\n                <tr class=\"cod-charges\">\n                    {% if product_table.products[0].tax.igst.value >0 %}\n                    <td class=\"left-block\" colspan=\"10\" style=\"padding-left: 5px;\">COD Charges</td>\n                    {% else %}\n                    <td class=\"left-block\" colspan=\"11\" style=\"padding-left: 5px;\">COD Charges</td>\n                    {% endif %}\n                    <td class=\"right-block\">\n                        {{ currency_code }}{{ (conversion_rate.rates[currency_code].value*product_table.cod_charges).toFixed(2) }}\n                    </td>\n                </tr>\n                {% endif %}\n                <tr class=\"total\">\n                    {% if product_table.products[0].tax.igst.value >0 %}\n                    <td class=\"left-block\" colspan=\"10\" style=\"padding-left: 5px;\">Total</td>\n                    {% else %}\n                    <td class=\"left-block\" colspan=\"11\" style=\"padding-left: 5px;\">Total</td>\n                    {% endif %}\n                    <td class=\"right-block\">\n                        {{ currency_code }}{{ (conversion_rate.rates[currency_code].value*product_table.grand_total).toFixed(2) }}\n                    </td>\n                </tr>\n            </table>\n        </div>\n        <div class=\"declarations\">\n            <p class=\"bold\">Declaration</p>\n            <ol class=\"pointers\">\n                {% for declaration in declaration_texts %}\n                <li class=\"pointer\">{{ declaration }}</li>\n                {% endfor %}\n            </ol>\n        </div>\n        <div style=\"\n                          display: flex;\n                          justify-content: space-between;\n                          align-items: center;\n                        \">\n            <div class=\"invoice-footer-section\">\n                <div class=\"brand-logo\">\n                    <img src=\"{{ product_table.products[0].brand.logo }}\" alt=\"Brand Logo\" width=\"100px\" />\n                </div>\n                <div class=\"company-registered-address\">\n                    <p class=\"address\">\n                        Registered Address:\n                    </p>\n                    <p>{{ company_detail.name}}</p>\n                    <p> {{ registered_company_detail.address }}</p>\n                    {% if company_detail.cin %}\n                    <p>CIN - {{ company_detail.cin }}</p>\n                    {% endif %}\n                    {% if company_detail.website_url %}\n                    <p>\n                        {{company_detail.website_url}}\n                    </p>\n                    {% endif %}\n                </div>\n                <div class=\"company-contact-number\">\n                    {% if company_detail.email %}\n                    <p class=\"email\">Email: {{ company_detail.email }}</p>\n                    {% endif %}\n                    {% if company_detail.phone_no %}\n                    <p class=\"phone\">Phone No: {{ company_detail.phone_no }}</p>\n                    {% endif %}\n                    {% if app_domain_name %}\n                    <p class=\"phone\">{{app_domain_name}}</p>\n                    {% endif %}\n                </div>\n                {% if digitalsignature %}\n                <div class=\"digital-signature\">\n                    <img src=\"{{ digitalsignature }}\" alt=\"signature-image\" />\n                    <p class=\"sign-text\">Authorised Signatory</p>\n                </div>\n                {% endif %}\n            </div>\n            {% if upi_qrcode %}\n            <div>\n                <img src=\"{{ upi_qrcode }}\" alt=\"Payment QR Code\" class=\"qr-code-size\" />\n                <p>Scan to pay delivery partner</p>\n            </div>\n            {% endif %}\n        </div>\n        {% if payments[0].payment_type | upper !== \"CASH ON DELIVERY\" and payments[0].payment_type | upper !== \"COD\" %}\n        <div class=\"invoice-details\">\n            <span>\n                Payment Date: {{ payments[0].date }}\n            </span>\n            <span>\n                |\n            </span>\n            <span>\n                Transaction Id: {{ payments[0].transaction_id }}\n            </span>\n            <span>\n                |\n            </span>\n            <span>\n                Payment Amount: {{ currency_code }}{{ (conversion_rate.rates[currency_code].value*amount_paid).toFixed(2) }}\n            </span>\n            <span>\n                |\n            </span>\n            <span>\n                Mode of Payment:\n                {% for payment in payments %}\n                {% if loop.last %}\n                {{ payment.payment_type }}\n                {% else %}\n                {{ payment.payment_type }},\n                {% endif %}\n                {% endfor %}\n            </span>\n        </div>\n        {% endif %}\n        <div class=\"invoice-disclaimer\">\n            <p class=\"bold\">{{ disclaimer }}</p>\n        </div>\n    </div>\n    {% else %}\n    <div class=\"invoice-a4 wrapper\">\n        <div class=\"invoice-heading\">\n            <div class=\"left-block\">\n                <h1 class=\"heading\">Tax Invoice</h1>\n                {% if payload.mode === \"development\" %}\n                <h3 class=\"sub-heading\">Original for Recipient | Test Order</h3>\n                {% else %}\n                <h3 class=\"sub-heading\">Original for Recipient</h3>\n                {% endif %}\n                <p class=\"delivery-partner-name-awb-number-block\">\n                    {% if is_self_ship or is_self_pickup %}\n                    <span class=\"dp-name\">\n                        {{ delivery_partner_detail.name | upper }}\n                    </span>\n                    {% else %}\n                    <span class=\"dp-name\">\n                        {{ delivery_partner_detail.name | upper }} | AWB:\n                        {{ delivery_partner_detail.awb_number }}\n                    </span>\n                    {% endif %}\n                </p>\n                <p class=\"amount-to-be-collected\">\n                    <span>Amount to be collected:\n                    </span>\n                    <span class=\"bold\">{{ currency_code }}{{ amount_to_be_collected.toFixed(2) }}</span>\n                </p>\n                <p>\n                    <span class=\"invoice-no\">\n                        Invoice ID: {{ invoice_detail.invoice_id }}</span>\n                    <span class=\"horizontal-divider\">\n                        |\n                    </span>\n                    <span class=\"payment-type\">\n                        {% for payment in payments %}\n                        {% if loop.last %}\n                        {{ payment.payment_type }}\n                        {% else %}\n                        {{ payment.payment_type }},\n                        {% endif %}\n                        {% endfor %}\n                    </span>\n                <p>Invoice Date: {{ invoice_detail.invoice_date }}</p>\n                </p>\n                <p class=\"shipment-id\">\n                    Shipment Id - {{ invoice_detail.shipment_id }}\n                </p>\n                {% if invoice_detail.irn %}\n                <p class=\"irn-number\">IRN - {{ invoice_detail.irn }}</p>\n                {% endif %}\n            </div>\n            {% if image.sales_channel_logo %}\n            <div class=\"center-block\">\n                <img src=\"{{ image.sales_channel_logo }}\" alt=\"Platform Logo\" width=\"54px\" />\n            </div>\n            {% endif %}\n            <div class=\"right-block\">\n                {% if not is_self_ship and not is_self_pickup %}\n                <div class=\"awb-barcode\">\n                    <img src=\"{{ awb_number_barcode }}\" alt=\"{{ delivery_partner_detail.awb_number }}\" />\n                </div>\n                {% endif %}\n                {% if signed_qrcode %}\n                <div id=\"qrcode\">\n                    <img src=\"{{ signed_qrcode }}\" alt=\"IRN QR Code\" width=\"120px\" height=\"120px\" />\n                </div>\n                <div style=\"text-align: center; margin-top: 5px; margin-left: 10px; margin-bottom:5px\">\n                    IRN QR\n                </div>\n                {% endif %}\n            </div>\n        </div>\n        <hr />\n        <div class=\"seller-customer-details\">\n            <div class=\"first-row primary-details\">\n                <div class=\"sold-by seller-details seller-customer-details-block\">\n                    <h2>Sold By</h2>\n                    <p class=\"name\">{{ company_detail.name }}</p>\n                    <p class=\"address\">{{ store_detail.address }}</p>\n                    <p class=\"state-code\">State Code - {{ store_detail.state_code }}</p>\n                    {% if store_detail.gstin %}\n                    <p class=\"gst-number\">GSTIN - {{ store_detail.gstin }}</p>\n                    {% endif %}\n                    {% if company_detail.pan %}\n                    <p class=\"pan-no\">PAN - {{ company_detail.pan }}</p>\n                    {% endif %}\n                    {% if company_detail.phone_no %}\n                    <p class=\"phone_no\">Phone No: {{ company_detail.phone_no }}</p>\n                    {% endif %}\n                    {% if company_detail.cin %}\n                    <p>CIN: {{ company_detail.cin }}</p>\n                    {% endif %}\n                </div>\n                <div class=\"seller-customer-details-block fulfilling-store-details\">\n                    <h2>Ship From</h2>\n                    <p class=\"company-name\">{{ company_detail.name }}</p>\n                    <p class=\"address\">C/o {{ store_detail.address }}</p>\n                    <p class=\"state-code\">State Code - {{ store_detail.state_code }}</p>\n                    {% if store_detail.gstin %}\n                    <p class=\"gst-number\">GSTIN - {{ store_detail.gstin }}</p>\n                    {% endif %}\n                </div>\n            </div>\n            <div class=\"second-row secondary-details\">\n                <div class=\"billing-details seller-customer-details-block\">\n                    <h2>Bill To</h2>\n                    <p class=\"name\">\n                        {{ customer_billing_detail.name }} | Mobile:\n                        {{ customer_billing_detail.phone_no }}\n                    </p>\n                    <p class=\"address\">{{ customer_billing_detail.address }}</p>\n                    <p class=\"state-code\">\n                        State Code - {{ customer_billing_detail.state_code }}\n                    </p>\n                    {% if customer_billing_detail.gstin %}\n                    <p class=\"gst-no\">GSTIN - {{ customer_billing_detail.gstin }}</p>\n                    {% endif %}\n                </div>\n                <div class=\"customer-details ship-to seller-customer-details-block\">\n                    <h2>Ship To</h2>\n                    <p class=\"name\">\n                        {{ customer_shipping_detail.name }} | Mobile:\n                        {{ customer_shipping_detail.phone_no }}\n                    </p>\n                    <p class=\"address\">{{ customer_shipping_detail.address }}</p>\n                    <p class=\"state-code\">\n                        State Code - {{ customer_shipping_detail.state_code }}\n                    </p>\n                    {% if customer_shipping_detail.gstin %}\n                    <p class=\"gst-no\">GSTIN - {{ customer_shipping_detail.gstin }}</p>\n                    {% endif %}\n                    <p class=\"place-of-supply\">\n                        Place of Supply: {{ customer_shipping_detail.state }}, {{ customer_shipping_detail.state_code }}\n                    </p>\n                </div>\n            </div>\n        </div>\n        <p style=\"text-align: right\">\n            Total Items: {{ product_table.total_items }}\n        </p>\n        <div class=\"product-breakup\">\n            <table class=\"product-finance-breakup\">\n                <tr class=\"heading-row\">\n                    <th>Product</th>\n                    <th>Size</th>\n                    <th>Seller Identifier</th>\n                    <th>HSN Code</th>\n                    <th>Total Units</th>\n                    <th>MRP (Unit)</th>\n                    <th>Discount (Unit)</th>\n                    <th>Taxable Amount (Unit)</th>\n                    <th>Total Taxable Amount</th>\n                    {% if product_table.products[0].tax.igst.value>0 %}\n                    <th>Total IGST</th>\n                    {% else %}\n                    <th>Total CGST</th>\n                    <th>Total SGST</th>\n                    {% endif %}\n                    <th>Total</th>\n                </tr>\n                {% for product in product_table.products %}\n                <tr>\n                    <td>{{ product.name }}</td>\n                    <td>{{ product.size }}</td>\n                    <td>{{ product.seller_identifier }}</td>\n                    <td>{{ product.hsn_code }}</td>\n                    <td>{{ product.total_units }}</td>\n                    <td>{{ currency_code }}{{ product.mrp.toFixed(2) }}</td>\n                    <td>{{ currency_code }}{{ product.discount.toFixed(2) }}</td>\n                    <td>{{ currency_code }}{{ product.taxable_amount.toFixed(2) }}</td>\n                    <td>{{ currency_code }}{{ product.total_taxable_amount.toFixed(2) }}</td>\n                    {% if product.tax.igst.value>0 %}\n                    <td>\n                        {{ currency_code }}{{ product.tax.igst.value.toFixed(2) }} ({{ product.tax.igst.percent.toFixed(2) }}%)\n                    </td>\n                    {% else %}\n                    <td>\n                        {{ currency_code }}{{ product.tax.cgst.value.toFixed(2) }} ({{ product.tax.cgst.percent.toFixed(2) }}%)\n                    </td>\n                    <td>\n                        {{ currency_code }}{{ product.tax.sgst.value.toFixed(2) }} ({{ product.tax.sgst.percent.toFixed(2) }}%)\n                    </td>\n                    {% endif %}\n                    <td>{{ currency_code }}{{ product.total.toFixed(2) }}</td>\n                </tr>\n                {% endfor %}\n                {% if product_table.delivery_charges > 0 %}\n                <tr class=\"delivery-charges\">\n                    <td class=\"left-block\" colspan=\"3\" style=\"padding-left: 5px;\">{{product_table.delivery_charge_text}}\n                    </td>\n                    <td colspan=\"1\">996819</td>\n                    {% if product_table.products[0].tax.igst.value >0 %}\n                    <td colspan=\"6\"></td>\n                    {% else %}\n                    <td colspan=\"7\"></td>\n                    {% endif %}\n                    <td class=\"right-block\" colspan=\"1\">\n                        {{ currency_code }}{{ product_table.delivery_charges.toFixed(2) }}\n                    </td>\n                </tr>\n                {% endif %}\n                {% if product_table.cod_charges > 0 %}\n                <tr class=\"cod-charges\">\n                    {% if product_table.products[0].tax.igst.value >0 %}\n                    <td class=\"left-block\" colspan=\"10\" style=\"padding-left: 5px;\">COD Charges</td>\n                    {% else %}\n                    <td class=\"left-block\" colspan=\"11\" style=\"padding-left: 5px;\">COD Charges</td>\n                    {% endif %}\n                    <td class=\"right-block\">\n                        {{ currency_code }}{{ product_table.cod_charges.toFixed(2) }}\n                    </td>\n                </tr>\n                {% endif %}\n                <tr class=\"total\">\n                    {% if product_table.products[0].tax.igst.value >0 %}\n                    <td class=\"left-block\" colspan=\"10\" style=\"padding-left: 5px;\">Total</td>\n                    {% else %}\n                    <td class=\"left-block\" colspan=\"11\" style=\"padding-left: 5px;\">Total</td>\n                    {% endif %}\n                    <td class=\"right-block\">\n                        {{ currency_code }}{{ product_table.grand_total.toFixed(2) }}\n                    </td>\n                </tr>\n                <tr class=\"total-in-words\">\n                    {% if product_table.products[0].tax.igst.value >0 %}\n                    <td class=\"right-block\" colspan=\"11\">\n                        {{ product_table.total_in_words }}\n                    </td>\n                    {% else %}\n                    <td class=\"right-block\" colspan=\"12\">\n                        {{ product_table.total_in_words }}\n                    </td>\n                    {% endif %}\n                </tr>\n            </table>\n            <table class=\"product-hsn-table-breakup\">\n                <th colspan=\"5\" style=\"font-weight: normal\">Tax Summary</th>\n                <tr class=\"heading-row\">\n                    <th>HSN CODE</th>\n                    <th>CGST</th>\n                    <th>SGST</th>\n                    <th>IGST</th>\n                    <th>Total Tax Value</th>\n                </tr>\n                {% for taxes in tax_table.taxes %}\n                <tr class=\"products\">\n                    <td>{{ taxes.hsn_code }}</td>\n                    <td>\n                        {{ currency_code }}{{ taxes.tax.cgst.value.toFixed(2) }} ({{ taxes.tax.cgst.percent.toFixed(2) }}%)\n                    </td>\n                    <td>\n                        {{ currency_code }}{{ taxes.tax.sgst.value.toFixed(2) }} ({{ taxes.tax.sgst.percent.toFixed(2) }}%)\n                    </td>\n                    <td>\n                        {{ currency_code }}{{ taxes.tax.igst.value.toFixed(2) }} ({{ taxes.tax.igst.percent.toFixed(2) }}%)\n                    </td>\n                    <td>{{ currency_code }}{{ taxes.total_tax_value.toFixed(2) }}</td>\n                </tr>\n                {% endfor %}\n                <tr class=\"total-row\">\n                    <td class=\"total-text\" colspan=\"4\" style=\"padding-left: 35px;\">Total Tax</td>\n                    <td>{{ currency_code }}{{ tax_table.total_tax.toFixed(2) }}</td>\n                </tr>\n                <tr class=\"total-in-words\">\n                    <td class=\"right-block\" colspan=\"5\">\n                        {{ tax_table.tax_in_words }}\n                    </td>\n                </tr>\n            </table>\n        </div>\n        <div class=\"declarations\">\n            <p class=\"bold\">Declaration</p>\n            <ol class=\"pointers\">\n                {% for declaration in declaration_texts %}\n                <li class=\"pointer\">{{ declaration }}</li>\n                {% endfor %}\n            </ol>\n        </div>\n        <div style=\"\n                          display: flex;\n                          justify-content: space-between;\n                          align-items: center;\n                        \">\n            <div class=\"invoice-footer-section\">\n                <div class=\"brand-logo\">\n                    <img src=\"{{ product_table.products[0].brand.logo }}\" alt=\"Brand Logo\" width=\"100px\" />\n                </div>\n                <div class=\"company-registered-address\">\n                    <p class=\"address\">\n                        Registered Address:\n                    </p>\n                    <p>{{ company_detail.name}}</p>\n                    <p> {{ registered_company_detail.address }}</p>\n                    {% if company_detail.cin %}\n                    <p>CIN - {{ company_detail.cin }}</p>\n                    {% endif %}\n                    {% if company_detail.website_url %}\n                    <p>\n                        {{company_detail.website_url}}\n                    </p>\n                    {% endif %}\n                </div>\n                <div class=\"company-contact-number\">\n                    {% if company_detail.email %}\n                    <p class=\"email\">Email: {{ company_detail.email }}</p>\n                    {% endif %}\n                    {% if company_detail.phone_no %}\n                    <p class=\"phone\">Phone No: {{ company_detail.phone_no }}</p>\n                    {% endif %}\n                    {% if app_domain_name %}\n                    <p class=\"phone\">{{app_domain_name}}</p>\n                    {% endif %}\n                </div>\n                {% if digitalsignature %}\n                <div class=\"digital-signature\">\n                    <img src=\"{{ digitalsignature }}\" alt=\"signature-image\" />\n                    <p class=\"sign-text\">Authorised Signatory</p>\n                </div>\n                {% endif %}\n            </div>\n            {% if upi_qrcode %}\n            <div>\n                <img src=\"{{ upi_qrcode }}\" alt=\"Payment QR Code\" class=\"qr-code-size\" />\n                <p>Scan to pay delivery partner</p>\n            </div>\n            {% endif %}\n        </div>\n        {% if payments[0].payment_type | upper !== \"CASH ON DELIVERY\" and payments[0].payment_type | upper !== \"COD\" %}\n        <div class=\"invoice-details\">\n            <span>\n                Payment Date: {{ payments[0].date }}\n            </span>\n            <span>\n                |\n            </span>\n            <span>\n                Transaction Id: {{ payments[0].transaction_id }}\n            </span>\n            <span>\n                |\n            </span>\n            <span>\n                Payment Amount: {{ currency_code }}{{ amount_paid.toFixed(2) }}\n            </span>\n            <span>\n                |\n            </span>\n            <span>\n                Mode of Payment:\n                {% for payment in payments %}\n                {% if loop.last %}\n                {{ payment.payment_type }}\n                {% else %}\n                {{ payment.payment_type }},\n                {% endif %}\n                {% endfor %}\n            </span>\n        </div>\n        {% endif %}\n        <div class=\"invoice-disclaimer\">\n            <p class=\"bold\">{{ disclaimer }}</p>\n        </div>\n    </div>\n    {% endif %}\n</body>\n\n</html>","country_code":"IN","__v":0}],"success":true}},"failure":{"value":{"data":[],"success":true}}}}}}}}},"/service/platform/assets/v1.0/company/{company_id}/application/{application_id}/pdf/payment-receipt":{"post":{"summary":"generatePaymentReceipt | Generate Payment Receipt for Jiomart Digital","description":"Generate Payment Receipt for Jiomart Digital","tags":["FileStorage"],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","description":"This is company id"},"examples":{"success":{"value":2}}},{"name":"application_id","in":"path","required":true,"schema":{"type":"string","description":"This is application id"},"examples":{"success":{"value":"5eda528b97457fe43a733ace"},"failure":{"value":"5eda528b97457fe43a733acd"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentReceiptRequestBody"},"examples":{"success":{"value":{"payload":{"uid":"FY64AC1B220E7AF70E11","order_detail":{"jiomart_order_id":"FY64AC1B220E7AF70E11","total_items":1,"final_amount":89910,"final_amount_in_words":"Sixty Nine Rupees Only","order_created_date":"27/10/2022","order_created_time":"11:17:08 pm","prm_id":"0760000255","receipt_no":"R696616043027102022","taxes":{"gstin":"","pancard":""}},"customer_detail":{"id":"422","email_id":"amarsalunke1994@gmail.com","last_name":"","first_name":"Amar S","mobile_number":"8308949396"},"payments":[{"payment_desc":"Net Banking","txn_date":"2023-07-10T14:53:00.604455"}]},"meta":{"job_type":"generate_pdf","action":"generate_pdf","event":{},"organizaton_id":"","company_id":163,"application_id":["5f74bc732792c06326f73a33"],"format":{"payment_receipt":["A5"]},"trace_id":["wildrider.80f0e90e-fedf-11ed-910b-ca75027abe60"],"created_timestamp":1685447141278,"service":{"name":"order"},"event_trace_info":{},"trace":"0000000000000000060ddcc3e3c8b161"}}},"failure":{"value":{"payload":{},"meta":{}}}}}}},"responses":{"200":{"description":"Kafka response published to generate payment receipt","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"}}},"examples":{"success":{"value":{"success":true}}}}}},"400":{"description":"Failed","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"success":{"type":"boolean"}}},"examples":{"failure":{"value":{"message":"payload or meta fields missing in body for ASP Payment Receipt","success":false}}}}}}}}},"/service/platform/finance/v1.0/company/{company_id}/generate-report":{"post":{"tags":["Finance"],"summary":"generateReport | Generate finance reports.","description":"Generate finance reports.","parameters":[{"in":"path","name":"company_id","description":"Company_id is required.","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateReportRequest"}}}},"responses":{"200":{"description":"We are processing the report!","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateReportJson"},"example":{"data":{"start_date":"2023-07-26","end_date":"2023-07-31","headers":["Company Id","Company","Brand","Ordering Channel","Bag ID","Sale Type","Recon Date","Settlement Date","Payout Date","Finance Status","ESP","Value Of Good","Transfer Price","Brand calculated Amount","Commission %","Flat Delivery Fee","Flat Cod Fee","Commission","Processing Fee","Closing Fee","Packaging Fee","Cancellation Fee","Return charges","Net Charges","Total GST","Total Charges","TDS","TCS","Net Payout"],"items":[["123","Supply RTI","Puma","ecomm","1865","sale","28-07-2023","01-08-2023","28-07-2023","reconciled","12.00","10.71","0.00","12.00","15","0.00","0.00","-1.80","0.00","0.00","-0.48",null,"0.00","-4.08","-0.72","-4.80","0.00","0.00","7.20"],["2","auto_company_120720232155193","Dreamworks","ecomm","1708","return","28-07-2023","01-08-2023","29-07-2023","reconciled","-3356.00","-3258.25","0.00","-3356.00","5","15.20","0.00","0.00","0.00","0.00","0.00",null,"0.00","0.00","0.00","0.00","0.00","0.00","-3356.00"],["..."]],"primary_headers":["Company Id","Company","Brand","Ordering Channel","Bag ID","Sale Type","Recon Date","Settlement Date","Payout Date","Finance Status"],"allowed_filters":["brand","channel","company","finance_status"],"item_count":35,"page":{"type":"number","size":10,"current":1,"has_next":true,"item_count":35}}}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"applicationId":[],"applicationToken":[]}]}},"/service/platform/finance/v1.0/company/{company_id}/download-report":{"post":{"tags":["Finance"],"summary":"downloadReport | Gives list of all downloaded reports.","description":"Gives list of all downloaded reports.","parameters":[{"in":"path","name":"company_id","description":"Company ID for which the data will be returned.Company_id is required.","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DownloadReport"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DownloadReportList"},"example":{"items":[{"request_dict":{},"report_config_id":"ff4cdb27-d674-4086-b982-1cdf9f17a5d7","report_name":"settlement_report","requested_by":"jayeshfansamkar_gofynd_com_17506","full_name":"jayesh fansamkar","display_name":"Settlement Report","created_at":"2023-07-26 22:38:04","filters":{"brand":[],"channel":[],"company":["61"]},"meta":{"brand":"","channel":"","company":"sumeetest","job_id":"export_1690391284747"},"status":"In Process","start_date":"2023-07-19","end_date":"2023-07-26","msg":null,"download_link":null}],"item_count":1,"page":{"type":"number","size":10,"current":1,"has_next":true,"item_count":1}}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"applicationId":[],"applicationToken":[]}]}},"/service/platform/finance/v1.0/company/{company_id}/get-data":{"post":{"tags":["Finance"],"summary":"getData | Gives list of columns for table provided.","description":"Gives list of columns for table provided.","parameters":[{"in":"path","name":"company_id","description":"Company ID for which the data will be returned.Company_id is required.","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetEngineRequest"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetEngineResponse"},"example":{"success":true,"items":[{"id":"53f18a1b-cbce-44a9-b2e0-69a7f144611a","name":"fynd_store","display_name":"Fynd Store"},{"id":"881fd2bc-ba55-4706-9371-438c06399765","name":"uniket","display_name":"Uniket"},{"id":"9a7d8e1c-4669-4905-9046-2e9518ae2f4b","name":"affiliate","display_name":"Affiliate"},{"id":"a945f1b3-1723-4a06-b6d6-a36c9db1e801","name":"ecomm","display_name":"Ecomm"},{"id":"ba839e34-d4cd-40f1-986e-ef276bc949da","name":"fynd","display_name":"Fynd"},{"id":"c6b07060-2d95-4f51-a9f8-5cd0976209a2","name":"marketplace","display_name":"Market Place"}],"item_count":6,"page":{"type":"number","size":10,"current":1,"has_next":true,"item_count":6}}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"applicationId":[],"applicationToken":[]}]}},"/service/platform/finance/v1.0/company/{company_id}/get-reason":{"post":{"tags":["Finance"],"summary":"getReason | Gives list of the reasons.","description":"Gives list of the reasons.","parameters":[{"in":"path","name":"company_id","description":"Company ID for which the data will be returned.Company_id is required.","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetReasonRequest"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetReasonResponse"},"example":{"success":true,"item_list":[{"id":"82d68950-5bdd-4a2b-a179-afc83454bde3","name":"DS01","display_name":"Bag Lost Reimbursement"},{"id":"8f90e0a1-c082-4c0e-b6e1-3640a4dfc69c","name":"DS02","display_name":"Wrong Product Reimbursement"}],"item_count":16,"page":{"type":"number","size":10,"current":1,"has_next":true,"item_count":16}}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"applicationId":[],"applicationToken":[]}]}},"/service/platform/finance/v1.0/company/{company_id}/get-report-list":{"post":{"tags":["Finance"],"summary":"getReportList | Get the list of available reports for a company.","description":"Gives list of reports.","parameters":[{"in":"path","name":"company_id","description":"Company ID for which the data will be returned. Company_id is required.","schema":{"type":"string"},"required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetReportListRequest"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetReportListResponse"},"example":{"success":true,"items":[{"id":"5565ed40-3265-40d8-9813-790efffa1091","name":"Ledger Report","description":"Ledger report","allowed_filters":["brand","channel","company","finance_status"],"config_meta":{},"report_type":"csv","display_date":null},{"id":"18161a3e-05ff-4e18-851b-d462225de333","name":"Lost Report","description":"It provides recon for bags on which claim is raised by seller","allowed_filters":["brand","channel","company"],"config_meta":{},"report_type":"csv","display_date":"Recon Date"},{"id":"ff4cdb27-d674-4086-b982-1cdf9f17a5d7","name":"Settlement Report","description":"It provides recon for bags on which commercials are applied by Fynd & which are settled or will be settled in future date","allowed_filters":["brand","channel","company"],"config_meta":{"brand":"name","channel":"text"},"report_type":"csv","display_date":null},{"id":"e0d07dcb-74bb-425d-884d-d41426c005fa","name":"Supporting Settlement Report V1","description":"It provides bag's info related to order, company, application, item, store, value & customer which can be further use as reference in other reports","allowed_filters":["brand","channel","company"],"config_meta":{"brand":"name","channel":"text"},"report_type":"csv","display_date":null}],"page":{"type":"number","size":10,"current":1,"has_next":true,"item_count":4},"total_count":4}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"applicationId":[],"applicationToken":[]}]}},"/service/platform/finance/v1.0/company/{company_id}/get-affiliate-list":{"post":{"tags":["Finance"],"summary":"getAffiliate | Gives list of affiliates for company.","description":"Gives list of affiliates for company.","parameters":[{"in":"path","name":"company_id","description":"Company ID for which the data will be returned.Company_id is reqired.","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAffiliate"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAffiliateResponse"},"example":{"success":true,"data":{"page":{"type":"number","current":1,"size":10,"item_total":11,"has_next":true},"docs":[{"website":{"enabled":true,"basepath":"/"},"cors":{"domains":[]},"auth":{"enabled":true},"_id":"5dd3aaeca6df502428f9341d","description":"fyndstore-dummy-test","channel_type":"store","cache_ttl":-1,"is_active":true,"company_id":20,"name":"fyndstore-dummy-test","owner":"5ee7770fae42c3c2687884b5","token":"uXOl0kQ8","meta":[],"__v":2,"domains":[{"_id":"5ec2536328ac771a0af4fd90","verified":true,"name":"fyndstore-dummy-test-mp0s.hostx1.de","is_primary":true,"is_default":true,"is_shortlink":true}],"internal":false,"redirections":[],"tokens":[{"token":"uXOl0kQ8","created_at":"2019-11-19T08:42:20.438Z"}],"created_at":"2019-11-19T08:42:20.438Z","modified_at":"2021-04-02T18:31:41.610Z","logo":{"secure_url":""},"mobile_logo":{"secure_url":""},"slug":"fyndstore-dummy-test-txh-37","mode":"live","status":"active","domain":{"_id":"5ec2536328ac771a0af4fd90","verified":true,"name":"fyndstore-dummy-test-mp0s.hostx1.de","is_primary":true,"is_default":true,"is_shortlink":true},"id":"5dd3aaeca6df502428f9341d"}],"success":true}}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"applicationId":[],"applicationToken":[]}]}},"/service/platform/finance/v1.0/company/{company_id}/download-credit-debit-note":{"post":{"tags":["Finance"],"summary":"downloadCreditDebitNote | Download credit debit note pdf.","description":"Download credit debit note pdf.","parameters":[{"in":"path","name":"company_id","description":"Company ID for which the data will be returned.Company_id is required.","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DownloadCreditDebitNoteRequest"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DownloadCreditDebitNoteResponse"},"example":{"success":true,"data":[{"id":"2b9c0729-3fa0-4565-8fcb-e822c87a95f9","pdf_s3_url":"https://fynd-staging-assets-private.s3-accelerate.amazonaws.com/addsale/documents/daytrader/PDFs/123/07-2023/FS/FS-C27-A00003-24_123_07-2023.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAJUADR2WMPQT6ZJ2Q%2F20230726%2Fap-south-1%2Fs3%2Faws4_request&X-Amz-Date=20230726T153559Z&X-Amz-Expires=604800&X-Amz-Signature=f7793b1afb0983ea4b51d8ae2e5792df3319141422d13f81b0de5ce644ffd139&X-Amz-SignedHeaders=host"}]}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"applicationId":[],"applicationToken":[]}]}},"/service/platform/finance/v1.0/company/{company_id}/payment-process":{"post":{"tags":["Finance"],"summary":"paymentProcess | Payment Processing API.","description":"Payment Processing API.","parameters":[{"in":"path","name":"company_id","description":"Company ID for which the data will be returned.Company_id is required.","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentProcessRequest"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentProcessResponse"},"example":{"code":200,"message":"success","transaction_id":"64c2386821617314bf24c3d2","redirect_url":"https://platform.fyndx1.de/company/123/subscription/renew-plan?plan_id=64c0ffe4770e21b533114912&transaction_id=64c2386821617314bf24c3d2&renew=true&callback_url=http://localdev.fyndx1.de:8087/company/123/billing/bills?activeTab=invoices&meta={\"remarks\":\"Invoice Payment\",\"seller_id\":\"123\",\"callback_url\":\"http://localdev.fyndx1.de:8087/company/123/billing/bills?activeTab=invoices\",\"invoice_number\":\"UN-I-A00355-FY24\",\"mode_of_payment\":\"online\",\"paid_amount_key\":\"total_payable\",\"isInvoicePayment\":true,\"source_reference\":\"invoice\"}","meta":{"callback_url":"http://localdev.fyndx1.de:8087/company/123/billing/bills?activeTab=invoices","remarks":"Invoice Payment","isInvoicePayment":true,"paid_amount_key":"total_payable","seller_id":"123","invoice_number":"UN-I-A00355-FY24","source_reference":"invoice","mode_of_payment":"online","source":"website"}}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"applicationId":[],"applicationToken":[]}]}},"/service/platform/finance/v1.0/company/{company_id}/credit-line-data":{"post":{"tags":["Finance"],"summary":"creditlineDataplatform | Used to fetch creditline data.","description":"Used to fetch creditline data.","parameters":[{"in":"path","name":"company_id","description":"Company_id is required.","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreditlineDataPlatformRequest"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreditlineDataPlatformResponse"},"example":{"headers":["Date","Purpose","Transaction Type","Amount","Credit Balance","MR Balance"],"items":[{"table_data":[{"date":"2023-07-14","purpose":"Monthly Credit Limit Reset","transaction_type":"Debit","amount":"₹1295.25","credit_balance":"₹0.00","mr_balance":"₹0.00"},{"date":"2023-07-27","purpose":"Advance Reciept Offline","transaction_type":"Credit","amount":"₹120.50","credit_balance":"₹1295.25","mr_balance":"₹0.00"},{"date":"2023-07-25","purpose":"Commission Deduction","transaction_type":"Debit","amount":"₹1825.25","credit_balance":"₹1174.75","mr_balance":"₹0.00"},{"date":"2023-07-26","purpose":"Credits Added","transaction_type":"Credit","amount":"₹2000.00","credit_balance":"₹2000.00","mr_balance":"₹1000.00"},{"date":"2023-07-26","purpose":"Minimum Retainership","transaction_type":"Credit","amount":"₹1000.00","credit_balance":"₹0.00","mr_balance":"₹1000.00"}],"creditline":{"total_amount":2000,"used_amount":2000,"balance":0},"minimum_retainership":{"total_amount":1000,"used_amount":1000,"balance":0},"show_mr":true}],"item_count":5,"page":{"type":"number","size":10,"current":1,"has_next":false,"item_count":5}}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"applicationId":[],"applicationToken":[]}]}},"/service/platform/finance/v1.0/company/{company_id}/creditline-opted":{"post":{"tags":["Finance"],"summary":"isCreditlinePlatform | Checks if seller has opted for creditline or not.","description":"Checks if seller has opted for creditline or not.","parameters":[{"in":"path","name":"company_id","description":"Company_id is required.","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IsCreditlinePlatformRequest"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IsCreditlinePlatformResponse"},"example":{"code":200,"is_creditline_opted":true}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"applicationId":[],"applicationToken":[]}]}},"/service/platform/finance/v1.0/company/{company_id}/invoice-type":{"post":{"tags":["Finance"],"summary":"invoiceType | Gives list of active invoice type.","description":"Gives list of active invoice type.","parameters":[{"in":"path","name":"company_id","description":"Company ID for which the data will be returned.Company_id is required.","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceTypeRequest"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceTypeResponse"},"example":{"success":true,"invoice_type_list":[{"text":"Creditline Minimum Gaurantee","value":"0ebf0c84-2577-4374-a48c-bcbec5afbbd3"},{"text":"Platform Subscription","value":"fc912415-0e32-4de9-9c46-7b21543747c3"},{"text":"Seller Invoice Fynd","value":"1ec78cf4-2d25-4bba-9d42-6515dfaf1751"},{"text":"Seller Invoice Fynd Store","value":"e6d8a752-1691-4b2d-9327-a0a4ea2f7dfd"},{"text":"Seller Invoice OpenAPI Ecom","value":"5ef45de7-388a-460a-a5ba-ab2de8fcc632"},{"text":"Seller Invoice Uniket","value":"8d85b574-17b7-4ddd-8d0a-e3a79cbd0659"}],"payment_status_list":[{"text":"In Process","value":"in_process"},{"text":"Paid","value":"paid"},{"text":"Unpaid","value":"unpaid"}]}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"example":{"summary":"Example Error Response","value":{"success":false,"reason":"Exception"}}}}}},"security":[{"applicationId":[],"applicationToken":[]}]}},"/service/platform/finance/v1.0/company/{company_id}/invoice/listing":{"post":{"tags":["Finance"],"summary":"invoiceListing | Gives list of invoices.","description":"Gives list of invoices.","parameters":[{"in":"path","name":"company_id","description":"Company ID for which the data will be returned.Company_id is required.","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceListingRequest"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceListingResponse"},"example":{"success":true,"items":[{"company":"(61) sumeetest","invoice_number":"FY-I-A23004-FY24","invoice_type":"Seller Invoice Fynd","invoice_date":"20-07-23","period":"01-05-23 - 31-05-23","amount":"₹247.8","due_date":"22-07-23","status":"UNPAID","is_downloadable":true,"invoice_id":"622c45ae-70e1-4222-9f4f-69dde51ad870","source_id":""},{"company":"(61) sumeetest","invoice_number":"FY-I-A23003-FY24","invoice_type":"Seller Invoice Fynd","invoice_date":"20-07-23","period":"01-05-23 - 31-05-23","amount":"₹247.8","due_date":"22-07-23","status":"UNPAID","is_downloadable":true,"invoice_id":"18d6bf81-21f8-4dd7-9c37-72751173a24a","source_id":"","currency":{"code":"INR","symbol":"r","name":"Indian Rupee"}}],"unpaid_invoice_data":{"total_unpaid_amount":495.6,"total_unpaid_invoice_count":2,"currency":"INR"},"headers":["Company","Invoice No","Type","Date","Period","Amount","Due Date","Status"],"item_count":26,"page":{"type":"number","size":10,"current":1,"has_next":true,"item_count":2}}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"example":{"summary":"Example Error Response","value":{"success":false,"reason":"Exception"}}}}}},"security":[{"applicationId":[],"applicationToken":[]}]}},"/service/platform/finance/v1.0/company/{company_id}/invoice/pdf-view":{"post":{"tags":["Finance"],"summary":"invoicePDF | Gives pdf view of invoice.","description":"Gives pdf view of invoice.","parameters":[{"in":"path","name":"company_id","description":"Company ID for which the data will be returned.Company_id is required.","schema":{"type":"string"},"required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoicePdfRequest"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoicePdfResponse"},"example":{"success":true,"data":["https://fynd-staging-assets-private.s3-accelerate.amazonaws.com/addsale/documents/daytrader/PDFs/61/07-2023/FY/FY-I-A23004-FY24_61_07-2023.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAJUADR2WMPQT6ZJ2Q%2F20230727%2Fap-south-1%2Fs3%2Faws4_request&X-Amz-Date=20230727T190229Z&X-Amz-Expires=604800&X-Amz-Signature=b8642e8764ea320332b5ccb825fe7427872d8fe31b4a3cafafb6c89dd854d9c3&X-Amz-SignedHeaders=host"],"error":[]}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"example":{"summary":"Example Error Response","value":{"success":false,"reason":"Exception"}}}}}},"security":[{"applicationId":[],"applicationToken":[]}]}},"/service/platform/finance/v1.0/company/{company_id}/cn-as-refund-method":{"post":{"tags":["Finance"],"summary":"isCnRefundMethod | Checks if seller has obtained cn as refund method or not.","description":"Checks if seller has obtained cn as refund method or not.","parameters":[{"in":"path","name":"company_id","description":"Company ID for which the data will be returned.Company_id is required.","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IsCnRefundMethodRequest"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IsCnRefundMethodResponse"},"example":{"success":true,"data":{"is_first_time_user":false}}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"applicationId":[],"applicationToken":[]}]}},"/service/platform/finance/v1.0/company/{company_id}/create-update-credit-note-config":{"post":{"tags":["Finance"],"summary":"createSellerCreditNoteConfig | Creates credit note config.","description":"Creates credit note config.","parameters":[{"in":"path","name":"company_id","description":"Company ID for which the data will be returned.Company_id is required.","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSellerCreditNoteConfigRequest"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSellerCreditNoteConfigResponse"},"example":{"success":true,"message":"Credit Note Config created."}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"applicationId":[],"applicationToken":[]}]}},"/service/platform/finance/v1.0/company/{company_id}/delete-seller-config":{"post":{"tags":["Finance"],"summary":"deleteConfig | Deletes credit note config.","description":"Deletes credit note config.","parameters":[{"in":"path","name":"company_id","description":"Company ID for which the data will be returned.Company_id is required.","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteConfigRequest"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteConfigResponse"},"example":{"success":true,"message":"Seller configuration deleted successfully."}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"applicationId":[],"applicationToken":[]}]}},"/service/platform/finance/v1.0/company/{company_id}/channel-display-names":{"get":{"tags":["Finance"],"summary":"channelDisplayName | Provide channel display name dict.","description":"Provide channel display name dict.","parameters":[{"in":"path","name":"company_id","description":"Company ID for which the data will be returned.Company_id is required.","schema":{"type":"string"},"required":true},{"in":"query","name":"filter_key","description":"gives display name for channel.","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelDisplayNameResponse"},"example":{"success":true,"data":{"platform-pos":"POS"}}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"applicationId":[],"applicationToken":[]}]}},"/service/platform/finance/v1.0/company/{company_id}/get-cn-pdf-link":{"post":{"tags":["Finance"],"summary":"getPdfUrlView | Gives cn pdf url.","description":"Gives cn pdf url.","parameters":[{"in":"path","name":"company_id","description":"Company ID for which the data will be returned.Company_id is required.","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetPdfUrlViewRequest"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetPdfUrlViewResponse"},"example":{"success":true,"data":{"cn_reference_number":"6078OMR000006-23","s3_pdf_link":"https://fynd-staging-assets-private.s3-accelerate.amazonaws.com/addsale/documents/invoice_a4/PDFs/16814985547851457553_invoice_a4.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAJUADR2WMPQT6ZJ2Q%2F20230427%2Fap-south-1%2Fs3%2Faws4_request&X-Amz-Date=20230427T044807Z&X-Amz-Expires=604800&X-Amz-Signature=970ffe76016175a309d8042cbdbd0eaab623cf4c3b6ac968604fe710df855504&X-Amz-SignedHeaders=host"}}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"applicationId":[],"applicationToken":[]}]}},"/service/platform/finance/v1.0/company/{company_id}/credit-note-details":{"post":{"tags":["Finance"],"summary":"creditNoteDetails | Gives credit note details.","description":"Gives credit note details.","parameters":[{"in":"path","name":"company_id","description":"Company ID for which the data will be returned.Company_id is required.","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreditNoteDetailsRequest"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreditNoteDetailsResponse"},"example":{"success":true,"data":{"cn_reference_number":"test_cn_1","customer_mobile_number":"1234567890","cn_amount":200,"remaining_cn_amount":200,"cn_status":"unutilised","cn_details":{"ordering_channel":"POS","channel_of_issuance":"POS","order_id":"11111","shipment_id":"11111","invoice_number":"invoice_1","date_issued":"2023-03-08 17:47:20","expiry_date":"2023-03-08 17:47:20","staff_id":"staff_1","store_id":"111"},"available_cn_balance":500,"redemption_details":[{"order_id":"111","shipment_id":"111","invoice_number":"invoice_1","store_id":"11","staff_id":"staff_1","ordering_channel":"POS","created_at":"2023-03-08 17:47:20","amount_debited":100},{"order_id":"111","shipment_id":"111","invoice_number":"invoice_1","store_id":"11","staff_id":"staff_1","ordering_channel":"POS","created_at":"2023-03-08 17:47:20","amount_debited":100}]}}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"applicationId":[],"applicationToken":[]}]}},"/service/platform/finance/v1.0/company/{company_id}/customer-credit-balance":{"post":{"tags":["Finance"],"summary":"getCustomerCreditBalance | Gives customer credit balance.","description":"Gives customer credit balance.","parameters":[{"in":"path","name":"company_id","description":"Company ID for which the data will be returned.Company_id is required.","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCustomerCreditBalanceRequest"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCustomerCreditBalanceResponse"},"example":{"success":true,"data":{"customer_mobile_number":"1234567890","total_credited_balance":500}}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"applicationId":[],"applicationToken":[]}]}},"/service/platform/finance/v1.0/company/{company_id}/get-seller-cn-config":{"post":{"tags":["Finance"],"summary":"getCnConfig | Gives credit note config.","description":"Gives credit note config.","parameters":[{"in":"path","name":"company_id","description":"Company ID for which the data will be returned.Company_id is required.","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCnConfigRequest"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCnConfigResponse"},"example":{"success":true,"data":{"is_cn_as_refund_method":true,"validity":365,"currency_type":"Indian Rupees","seller_id":25,"affiliate_id":"5ea82cc2b496555b51caafa3","notification_events":{"repeat":"once per day","expiration_reminder_to_customer":5},"meta":{"reason":"","source_channel":["POS","ECOMM"]},"redemption_ordering_channel":["ECOMM","POS"]}}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"applicationId":[],"applicationToken":[]}]}},"/service/platform/finance/v1.0/company/{company_id}/generate-report-customer-cn":{"post":{"tags":["Finance"],"summary":"generateReportCustomerCn | Generate Credit Note report and gives Note details.","description":"Generate Credit Note report and gives Note details.","parameters":[{"in":"path","name":"company_id","description":"Company ID for which the data will be returned.Company_id is required.","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateReportCustomerCnRequest"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateReportCustomerCnResponse"},"example":{"data":{"start_date":"2023-04-26","end_date":"2023-07-31","headers":["Credit Reference Number","Amount","Order ID","Shipment ID","Invoice No","Date and Time of Issuance","Date and Time of Expiry","Status"],"items":[],"primary_headers":["Credit Reference Number","Amount","Order ID","Shipment ID","Invoice No","Date and Time of Issuance","Date and Time of Expiry"],"allowed_filters":["company","staff_id","store_id","utilisation","affiliate_id","issuance_channel","ordering_channel","type_of_transaction"],"row_header_display_order":{},"item_count":0,"page":{"type":"number","size":10,"current":1,"has_next":true,"item_count":0}}}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"applicationId":[],"applicationToken":[]}]}},"/service/platform/finance/v1.0/company/{company_id}/download-report-customer-cn":{"post":{"tags":["Finance"],"summary":"downloadReportCustomerCn | Gives list of downloaded reports.","description":"Gives list of downloaded reports.","parameters":[{"in":"path","name":"company_id","description":"Company ID for which the data will be returned.Company_id is required.","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DownloadReportCustomerCnRequest"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DownloadReportCustomerCnResponse"},"example":{"data":[{"request_dict":{},"report_config_id":"0c09c7e7-0839-43c1-a2bf-76e08478fa99","report_name":"credit note report","requested_by":"app","full_name":"app","display_name":"Credit Note Report","created_at":"2023-04-18 06:29:11","filters":{},"meta":{},"status":"Completed","start_date":"2023-04-21","end_date":"2023-04-22","msg":"","download_link":"https://opex-test-bucket.s3.amazonaws.com/csv/credit%20note%20report_2023-04-21_2023-04-22_1681799353.csv.gz?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAJUADR2WMPQT6ZJ2Q%2F20230418%2Fap-south-1%2Fs3%2Faws4_request&X-Amz-Date=20230418T062915Z&X-Amz-Expires=86400&X-Amz-SignedHeaders=host&X-Amz-Signature=a92612927b39a630e894e9179b531d2af3954223a6dc16788275a52675c8a7bf"},{"request_dict":{},"report_config_id":"0c09c7e7-0839-43c1-a2bf-76e08478fa99","report_name":"credit note report","requested_by":"app","full_name":"app","display_name":"Credit Note Report","created_at":"2023-04-18 06:15:39","filters":{},"meta":{},"status":"In Process","start_date":"2023-04-21","end_date":"2023-04-22","msg":"","download_link":"https://opex-test-bucket.s3.amazonaws.com/csv/credit%20note%20report_2023-04-21_2023-04-22_1681799353.csv.gz?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAJUADR2WMPQT6ZJ2Q%2F20230418%2Fap-south-1%2Fs3%2Faws4_request&X-Amz-Date=20230418T062915Z&X-Amz-Expires=86400&X-Amz-SignedHeaders=host&X-Amz-Signature=a92612927b39a630e894e9179b531d2af3954223a6dc16788275a52675c8a7bf"}],"item_count":1,"page":{"type":"number","size":10,"current":1,"has_next":true,"item_count":2}}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"applicationId":[],"applicationToken":[]}]}},"/service/platform/finance/v1.0/company/{company_id}/reporting-filters":{"get":{"tags":["Finance"],"summary":"getReportingFilters | Gets all customer Cn filters and search.","description":"Gets all customer Cn filters and search.","parameters":[{"in":"path","name":"company_id","description":"Company ID for which the data will be returned.Company_id is required.","schema":{"type":"string"},"required":true},{"in":"query","name":"filter_key","description":"filter type.","schema":{"type":"string"},"required":true},{"in":"query","name":"affiliate_id","description":"affiliate id.","schema":{"type":"string"},"required":false}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetReportingFiltersResponse"},"example":{"search":{"text":"Search Types","type":"single_select","value":"search_type","options":[{"text":"Order ID","value":"order_id","placeholder_text":"Search by Order ID"},{"text":"Invoice No.","value":"invoice_number","placeholder_text":"Search by Invoice Number"},{"text":"CN Reference No.","value":"credit_note_number","placeholder_text":"Search by CN Reference Number"},{"text":"Customer Mobile No.","value":"customer_mobile_number","placeholder_text":"Search by Customer Mobile Number"}]},"status":{"text":"Status","type":"multi_select","value":"status","options":[{"text":"Success","value":"Success"},{"text":"Inprogress","value":"In Process"},{"text":"Failed","value":"Failed"},{"text":"Pending","value":"Pending"}]},"filters":[{"text":"Store ID","type":"multi_select","value":"store_id","options":[],"placeholder_text":"Select Store ID"},{"text":"Ordering Channel","type":"multi_select","value":"ordering_channel","options":[{"text":"POS","value":"platform-pos"}],"required":false,"placeholder_text":"Select Ordering Channel"},{"text":"Issuance Channel","type":"multi_select","value":"issuance_channel","options":[{"text":"POS","value":"platform-pos"}],"required":false,"placeholder_text":"Select Issuance Channel"}]}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"applicationId":[],"applicationToken":[]}]}},"/service/platform/finance/v1.0/company/{company_id}/invoice/{invoice_number}/payment":{"get":{"tags":["Finance"],"x-accessScopes":["company/finance/read"],"summary":"invoicePaymentDetails | Display payment details of an invoice.","description":"Display payment details of invoice.","parameters":[{"in":"path","name":"company_id","description":"Company ID for which the data will be returned.Company_id is required.","schema":{"type":"string"},"required":true},{"in":"path","name":"invoice_number","description":"Invoice Number for which the data will be returned.Invoice_Number is required.","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoicePaymentDetailsResponse"},"example":{"payment_details_visible":true,"paid_invoice_payment_details":[{"payment_details":[{"display_name":"Type of Payment","value":"Online"},{"display_name":"Mode of Payment","value":"Upi"},{"display_name":"UPI ID","value":"8787987654@ybl"},{"display_name":"Reference Number","value":"882648404204"}],"date_of_payment":"2023-07-19 13:12:15.901928","amount":8000}],"failed_attempts_details":[]}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"applicationId":[],"applicationToken":[]}]}},"/service/platform/finance/v1.0/company/{company_id}/invoice/{invoice_number}/activity":{"get":{"tags":["Finance"],"x-accessScopes":["company/finance/read"],"summary":"invoiceActivityLogs | Display activity log details of an invoice.","description":"Display activity log details of invoice.","parameters":[{"in":"path","name":"company_id","description":"Company ID for which the data will be returned. Company_id is required.","schema":{"type":"string"},"required":true},{"in":"path","name":"invoice_number","description":"Invoice Number for which the data will be returned. Invoice_number is required.","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceActivityLogsResponse"},"example":{"data":[{"performed_by":"system","status":"processed","reason":"","is_resolved":true,"retry_attempts":0,"max_retry_attempts":3}]}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceActivityLogError"}}}}},"security":[{"applicationId":[],"applicationToken":[]}]}},"/service/platform/finance/v1.0/company/{company_id}/credit-notes/unlock":{"post":{"tags":["Finance"],"summary":"unlockCreditNote | Unlocks credit notes.","description":"Used to unlock all request credit notes.","parameters":[{"in":"path","name":"company_id","description":"Company ID for which the data will be returned.Company_id is required.","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnlockCreditNoteRequest"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnlockCreditNoteResponse"},"example":{"success":true,"data":{"is_cn_unlocked":true,"status":"completed"}}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"applicationId":[],"applicationToken":[]}]}},"/service/platform/inventory/v1.0/company/{company_id}/jobs":{"get":{"tags":["Inventory"],"summary":"getJobsByCompany | Get Job Configs For A Company","description":"REST Endpoint that returns all job configs for a company","parameters":[{"name":"company_id","in":"path","description":"Company Id","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"page_no","in":"query","description":"Page Number","required":false,"schema":{"type":"integer","format":"int32","default":1}},{"name":"page_size","in":"query","description":"Page Size","required":false,"schema":{"type":"integer","format":"int32","default":10}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEnvelopeListJobConfigRawDTO"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEnvelopeListJobConfigRawDTO"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEnvelopeListJobConfigRawDTO"}}}}}},"put":{"tags":["Inventory"],"summary":"updateJob | Updates An Existing Job Config","description":"REST Endpoint that updates a job config","parameters":[{"name":"company_id","in":"path","description":"Company Id","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobConfigDTO"}}},"required":true},"responses":{"201":{"description":"Job Config Updated Successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEnvelopeString"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEnvelopeString"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEnvelopeString"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEnvelopeString"}}}}}},"post":{"tags":["Inventory"],"summary":"createJob | Creates A New Job Config","description":"REST Endpoint that creates a new job config","parameters":[{"name":"company_id","in":"path","description":"Company Id","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobConfigDTO"}}},"required":true},"responses":{"200":{"description":"Job Config Created Successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEnvelopeString"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEnvelopeString"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEnvelopeString"}}}},"409":{"description":"Job Config Already Exists","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEnvelopeString"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEnvelopeString"}}}}}}},"/service/platform/inventory/v1.0/company/{company_id}/kafka/suppressStore":{"post":{"tags":["Inventory"],"summary":"suppressStores | Get Slingshot Configuration Of  A Company","description":"REST Endpoint that returns all configuration detail of a company","parameters":[{"name":"company_id","in":"path","description":"Company id","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuppressStorePayload"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEnvelopeKafkaResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEnvelopeKafkaResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEnvelopeKafkaResponse"}}}}}}},"/service/platform/inventory/v1.0/company/{company_id}/slingshot":{"get":{"tags":["Inventory"],"summary":"getConfigByCompany | Get Slingshot Configuration Of  A Company","description":"REST Endpoint that returns all configuration detail of a company","parameters":[{"name":"company_id","in":"path","description":"Company Id","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEnvelopeListSlingshotConfigurationDetail"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEnvelopeListSlingshotConfigurationDetail"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEnvelopeListSlingshotConfigurationDetail"}}}}}}},"/service/platform/inventory/v1.0/company/{company_id}/jobs/steps/{job_id}":{"get":{"tags":["Inventory"],"summary":"getJobSteps | Get Job Code Steps","description":"REST Endpoint that returns Inventory Job Steps","parameters":[{"name":"company_id","in":"path","description":"Company Id","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"job_id","in":"path","description":"Job Id","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEnvelopeListJobStepsDTO"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEnvelopeListJobStepsDTO"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEnvelopeListJobStepsDTO"}}}}}}},"/service/platform/inventory/v1.0/company/{company_id}/jobs/integration/{integration_id}":{"get":{"tags":["Inventory"],"summary":"getJobByCompanyAndIntegration | Get Job Configs By Company And Integration","description":"REST Endpoint that returns all job configs by company And integration","parameters":[{"name":"company_id","in":"path","description":"Company Id","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"integration_id","in":"path","description":"Integration Id","required":true,"schema":{"type":"string"}},{"name":"page_no","in":"query","description":"Page Number","required":false,"schema":{"type":"integer","format":"int32","default":1}},{"name":"page_size","in":"query","description":"Page Size","required":false,"schema":{"type":"integer","format":"int32","default":10}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEnvelopeListJobConfigDTO"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEnvelopeListJobConfigDTO"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEnvelopeListJobConfigDTO"}}}}}}},"/service/platform/inventory/v1.0/company/{company_id}/jobs/disable/integration/{integration_id}":{"get":{"tags":["Inventory"],"summary":"disable | Disable Job Config","description":"REST Endpoint that disables Inventory Job Config","parameters":[{"name":"company_id","in":"path","description":"Company Id","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"integration_id","in":"path","description":"IntegrationId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEnvelopeString"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEnvelopeString"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEnvelopeString"}}}}}}},"/service/platform/inventory/v1.0/company/{company_id}/jobs/defaults":{"get":{"tags":["Inventory"],"summary":"getJobConfigDefaults | Get Job Configs Defaults","description":"REST Endpoint that returns default fields job configs by company And integration","parameters":[{"name":"company_id","in":"path","description":"Company Id","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEnvelopeJobConfigDTO"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEnvelopeJobConfigDTO"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEnvelopeJobConfigDTO"}}}}}}},"/service/platform/inventory/v1.0/company/{company_id}/jobs/code/{code}":{"get":{"tags":["Inventory"],"summary":"getJobByCode | Get Job Config By Code","description":"REST Endpoint that returns job config by code","parameters":[{"name":"company_id","in":"path","description":"Company Id","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"code","in":"path","description":"Job Code","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEnvelopeJobConfigDTO"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEnvelopeJobConfigDTO"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEnvelopeJobConfigDTO"}}}}}}},"/service/platform/inventory/v1.0/company/{company_id}/jobs/code/{code}/metrics":{"get":{"tags":["Inventory"],"summary":"getJobCodeMetrics | Get Job Metrics","description":"REST Endpoint that returns Inventory Run History For A Job Code","parameters":[{"name":"company_id","in":"path","description":"Company Id","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"code","in":"path","description":"Code","required":true,"schema":{"type":"string"}},{"name":"page_no","in":"query","description":"Page Number","required":false,"schema":{"type":"integer","format":"int32","default":1}},{"name":"page_size","in":"query","description":"Page Size","required":false,"schema":{"type":"integer","format":"int32","default":10}},{"name":"status","in":"query","description":"Status","required":false,"schema":{"type":"string"}},{"name":"date","in":"query","description":"From Date","required":false,"schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEnvelopeJobMetricsDto"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEnvelopeJobMetricsDto"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEnvelopeJobMetricsDto"}}}}}}},"/service/platform/inventory/v1.0/company/{company_id}/jobs/code/integration/{integration_id}":{"get":{"tags":["Inventory"],"summary":"getJobCodesByCompanyAndIntegration | Get Job Codes By Company And Integration","description":"REST Endpoint that returns all job codes by company And integration","parameters":[{"name":"company_id","in":"path","description":"Company Id","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"integration_id","in":"path","description":"Integration Id","required":true,"schema":{"type":"string"}},{"name":"page_no","in":"query","description":"Page Number","required":false,"schema":{"type":"integer","format":"int32","default":1}},{"name":"page_size","in":"query","description":"Page Size","required":false,"schema":{"type":"integer","format":"int32","default":10}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEnvelopeListJobConfigListDTO"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEnvelopeListJobConfigListDTO"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEnvelopeListJobConfigListDTO"}}}}}}},"/service/platform/lead/v1.0/company/{company_id}/ticket":{"get":{"description":"Gets the list of company level tickets and/or ticket filters","summary":"getPlatformTickets | Gets the list of company level tickets and/or ticket filters depending on query params","tags":["Lead"],"parameters":[{"name":"company_id","in":"path","description":"Company ID for which the data will be returned","required":true,"schema":{"type":"string"}},{"name":"items","in":"query","description":"Decides that the reponse will contain the list of tickets","schema":{"type":"boolean"}},{"name":"filters","in":"query","description":"Decides that the reponse will contain the ticket filters","schema":{"type":"boolean"}},{"name":"q","in":"query","description":"Search through ticket titles and description","schema":{"type":"string"}},{"name":"status","in":"query","description":"Filter tickets on status","schema":{"type":"string"}},{"name":"priority","in":"query","description":"Filter tickets on priority","schema":{"$ref":"#/components/schemas/PriorityEnum"}},{"name":"category","in":"query","description":"Filter tickets on category","schema":{"type":"string"}},{"name":"page_no","in":"query","description":"The page number to navigate through the given set of results.","schema":{"type":"integer"},"required":false},{"name":"page_size","in":"query","description":"Number of items to retrieve in each page. Default is 12.","schema":{"type":"integer","default":12},"required":false}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TicketList"},"examples":{"Without items":{"value":{"filters":{"statuses":[{"display":"Pending","color":"#eae22b","key":"pending"},{"display":"In Progress","color":"#ffa951","key":"in_progress"},{"display":"Resolved","color":"#20c3a6","key":"resolved"},{"display":"Closed","color":"#41434c","key":"closed"}],"priorities":[{"display":"Low","color":"#fed766","key":"low"},{"display":"Medium","color":"#f37736","key":"medium"},{"display":"High","color":"#fe4a49","key":"high"}],"assignees":[],"categories":[{"form":{"login_required":false,"should_notify":false,"inputs":[{"type":"email","showRegexInput":false,"enum":[],"regex":"\\S+@\\S+\\.\\S+","display":"email","required":true,"key":"email"}],"available_assignees":[],"_id":"602e900a2042255c03cadaf0","title":"service-test-satyen","description":"testing form from service","slug":"service-test-satyen","header_image":"https://hdn-1.addsale.com/x0/support-ticket/files/free/original/KZL86aN5l-service-test-satyen.jpeg","application_id":"000000000000000000000001","created_on":{"user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 11_2_0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/88.0.4324.150 Safari/537.36","platform":"web","meta":{"browser":{"name":"Chrome","version":"88.0.4324.150"},"os":{"name":"macOS","version":"11.2.0"},"platform":{"type":"desktop","vendor":"Apple"},"engine":{"name":"Blink"}}},"created_by":"5f8147abbd1a0a870f61f1a6","createdAt":"2021-02-18T16:04:26.495Z","updatedAt":"2021-02-18T16:04:26.495Z","__v":0},"key":"service-test-satyen","display":"service-test-satyen"}]}}},"With items":{"value":{"docs":[{"_id":"602d2652ce284d0b008d5c97","status":{"display":"Pending","color":"#eae22b","key":"pending"},"priority":{"display":"Medium","color":"#f37736","key":"medium"},"assigned_to":{"agent_id":"5e79e721768c6bf54b783146","gender":"male","accountType":"user","active":true,"profilePicUrl":"https://d2co8r51m5ca2d.cloudfront.net/inapp_banners/default_profile_img.png","hasOldPasswordHash":false,"_id":"5e79e721768c6bf54b783146","emails":[{"active":true,"primary":true,"verified":true,"email":"niktest@xyz.com"},{"active":true,"primary":false,"verified":true,"email":"xyz@xyz.com"},{"active":true,"primary":false,"verified":true,"email":"xyz@xyz.com"},{"active":true,"primary":false,"verified":true,"email":"xyz@xyz.com"}],"phoneNumbers":[{"active":true,"primary":true,"verified":true,"countryCode":91,"phone":"9999999999"}],"firstName":"Nikhil","lastName":"Manapure","username":"xyz_xyz_com","createdAt":"2020-03-24T10:55:29.298Z","updatedAt":"2020-05-12T07:46:41.816Z","uid":"5567","__v":2},"tags":["asdf444"],"context":{"application_id":"000000000000000000000001","company_id":"1"},"created_on":{"user_agent":"Fynd Platform/0.0.1 (com.fynd.platform; build:3; iOS 14.2.0) Alamofire/5.0.2","platform":"web","meta":{"browser":{"name":"Fynd Platform","version":"0.0.1"}}},"source":"sales_channel","content":{"title":"asdf444 Response","description":"","attachments":[]},"response_id":"602d2652ce284dee3c8d5c96","category":{"form":{"login_required":false,"should_notify":true,"inputs":[{"type":"text","showRegexInput":false,"enum":[],"display":"asdf","key":"asdf"},{"type":"mobile","showRegexInput":false,"enum":[],"display":"mob num","regex":"[0-9]{10}$","key":"mob-num"}],"available_assignees":["5e79e721768c6bf54b783146"],"_id":"60124e4a4d2bc363625e1bf4","title":"asdf444","description":"adf","slug":"asdf444","application_id":"000000000000000000000001","created_on":{"user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/88.0.4324.96 Safari/537.36","platform":"web","meta":{"browser":{"name":"Chrome","version":"88.0.4324.96"},"os":{"name":"macOS","version":"10.15.7","versionName":"Catalina"},"platform":{"type":"desktop","vendor":"Apple"},"engine":{"name":"Blink"}}},"created_by":"5e79e721768c6bf54b783146","createdAt":"2021-01-28T05:40:26.271Z","updatedAt":"2021-02-18T16:02:32.086Z","__v":0,"poll_for_assignment":{"duration":20,"message":"We are looking for executive to connect you","success_message":"Executive found","failure_message":"All our executives are busy at the moment, We have accepted your request and someone will connect with you soon!"}},"key":"asdf444","display":"asdf444"},"ticket_id":"472","createdAt":"2021-02-17T14:21:06.774Z","updatedAt":"2021-02-17T14:21:06.774Z","__v":0,"id":"602d2652ce284d0b008d5c97"}],"total":472,"limit":10,"page":1,"pages":48,"filters":{"statuses":[{"display":"Pending","color":"#eae22b","key":"pending"},{"display":"In Progress","color":"#ffa951","key":"in_progress"},{"display":"Resolved","color":"#20c3a6","key":"resolved"},{"display":"Closed","color":"#41434c","key":"closed"}],"priorities":[{"display":"Low","color":"#fed766","key":"low"},{"display":"Medium","color":"#f37736","key":"medium"},{"display":"High","color":"#fe4a49","key":"high"}],"assignees":[],"categories":[{"form":{"login_required":false,"should_notify":false,"inputs":[{"type":"email","showRegexInput":false,"enum":[],"regex":"\\S+@\\S+\\.\\S+","display":"email","required":true,"key":"email"}],"available_assignees":[],"_id":"602e900a2042255c03cadaf0","title":"service-test-satyen","description":"testing form from service","slug":"service-test-satyen","header_image":"https://hdn-1.addsale.com/x0/support-ticket/files/free/original/KZL86aN5l-service-test-satyen.jpeg","application_id":"000000000000000000000001","created_on":{"user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 11_2_0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/88.0.4324.150 Safari/537.36","platform":"web","meta":{"browser":{"name":"Chrome","version":"88.0.4324.150"},"os":{"name":"macOS","version":"11.2.0"},"platform":{"type":"desktop","vendor":"Apple"},"engine":{"name":"Blink"}}},"created_by":"5f8147abbd1a0a870f61f1a6","createdAt":"2021-02-18T16:04:26.495Z","updatedAt":"2021-02-18T16:04:26.495Z","__v":0},"key":"service-test-satyen","display":"service-test-satyen"}]}}}}}}}}},"post":{"description":"Creates a company level ticket","summary":"createTicket | Creates a company level ticket","tags":["Lead"],"parameters":[{"name":"company_id","in":"path","description":"Company ID for which the data will be returned","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddTicketPayload"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ticket"},"examples":{"Default":{"value":{"context":{"company_id":"884"},"content":{"title":"SOme title Response","description":"Handles communication between Administrator","attachments":[]},"status":{"display":"In Progress","color":"#ffa951","key":"in_progress"},"priority":{"display":"Medium","color":"#f37736","key":"medium"},"assigned_to":{"agent_id":"5d1363adf599d850df93175e","gender":"male","accountType":"user","active":true,"profilePicUrl":"https://platform-lookaside.fbsbx.com/platform/profilepic/?asid=2136700473091190&height=400&width=400&ext=1554542761&hash=AeS6cuWIdjDdJJ-b","hasOldPasswordHash":false,"_id":"5d1363adf599d850df93175e","phoneNumbers":[{"active":true,"primary":true,"verified":true,"countryCode":91,"phone":"9999999999"}],"firstName":"Nikhil","lastName":"Manapure","emails":[{"active":true,"primary":true,"verified":true,"email":"niktest@xyz.com"}],"username":"niktest_xyz_com_38425_20500281","createdAt":"2019-01-01T17:22:38.528Z","updatedAt":"2021-01-22T10:02:42.258Z","uid":"20500281","__v":56},"tags":["some-title"],"_id":"6012f38557751ee8fc162cf7","created_on":{"user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/88.0.4324.96 Safari/537.36","platform":"web","meta":{"browser":{"name":"Chrome","version":"88.0.4324.96"},"os":{"name":"macOS","version":"10.15.7","versionName":"Catalina"},"platform":{"type":"desktop","vendor":"Apple"},"engine":{"name":"Blink"}}},"source":"sales_channel","created_by":{"id":"5d1363adf599d850df93175e","user":{"gender":"male","accountType":"user","active":true,"profilePicUrl":"https://platform-lookaside.fbsbx.com/platform/profilepic/?asid=2136700473091190&height=400&width=400&ext=1554542761&hash=AeS6cuWIdjDdJJ-b","hasOldPasswordHash":false,"_id":"5d1363adf599d850df93175e","phoneNumbers":[{"active":true,"primary":true,"verified":true,"countryCode":91,"phone":"9999999999"}],"firstName":"Nikhil","lastName":"Manapure","emails":[{"active":true,"primary":true,"verified":true,"email":"niktest@xyz.com"}],"username":"niktest_xyz_com_38425_20500281","createdAt":"2019-01-01T17:22:38.528Z","updatedAt":"2021-01-22T10:02:42.258Z","uid":"20500281","__v":56}},"response_id":"6012f38457751e0fb8162cf6","category":{"form":{"login_required":false,"should_notify":false,"inputs":[{"required":false,"type":"text","enum":[],"display":"Single lineeee","key":"single-lineeee","showRegexInput":false},{"required":false,"type":"email","enum":[],"display":"Email","regex":"\\S+@\\S+\\.\\S+","key":"email","showRegexInput":true},{"required":false,"type":"text","enum":[],"display":"dfsdf","key":"dfsdf","showRegexInput":false}],"available_assignees":["5b9b98150df588546aaea6d2","5c45d78395d7504f76c2cb37"],"_id":"5fd72db3dc250f8decfc61b2","title":"SOme title","description":"SOme big description","slug":"some-title","application_id":"000000000000000000000003","created_on":{"user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/87.0.4280.88 Safari/537.36","platform":"web","meta":{"browser":{"name":"Chrome","version":"87.0.4280.88"},"os":{"name":"macOS","version":"10.15.6","versionName":"Catalina"},"platform":{"type":"desktop","vendor":"Apple"},"engine":{"name":"Blink"}}},"created_by":"5d1363adf599d850df93175e","createdAt":"2020-12-14T09:17:39.953Z","updatedAt":"2021-01-28T18:48:07.717Z","__v":0},"key":"some-title","display":"SOme title"},"ticket_id":"43","createdAt":"2021-01-28T17:25:25.013Z","updatedAt":"2021-01-28T17:25:33.396Z","__v":0,"video_room_id":"6012f38557751ee8fc162cf7"}}}}}}}}},"/service/platform/lead/v1.0/company/{company_id}/application/{application_id}/ticket":{"get":{"description":"Gets the list of Application level Tickets and/or ticket filters","summary":"getNewTickets | Gets the list of Application level Tickets and/or ticket filters depending on query params","tags":["Lead"],"parameters":[{"name":"company_id","in":"path","description":"Company ID of the application","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Application ID for which the data will be returned","required":true,"schema":{"type":"string"}},{"name":"items","in":"query","description":"Decides that the reponse will contain the list of tickets","schema":{"type":"boolean"}},{"name":"filters","in":"query","description":"Decides that the reponse will contain the ticket filters","schema":{"type":"boolean"}},{"name":"q","in":"query","description":"Search through ticket titles and description","schema":{"type":"string"}},{"name":"status","in":"query","description":"Filter tickets on status","schema":{"type":"string"}},{"name":"priority","in":"query","description":"Filter tickets on priority","schema":{"$ref":"#/components/schemas/PriorityEnum"}},{"name":"category","in":"query","description":"Filter tickets on category","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TicketList"},"examples":{"Without items":{"value":{"filters":{"statuses":[{"display":"Pending","color":"#eae22b","key":"pending"},{"display":"In Progress","color":"#ffa951","key":"in_progress"},{"display":"Resolved","color":"#20c3a6","key":"resolved"},{"display":"Closed","color":"#41434c","key":"closed"}],"priorities":[{"display":"Low","color":"#fed766","key":"low"},{"display":"Medium","color":"#f37736","key":"medium"},{"display":"High","color":"#fe4a49","key":"high"}],"assignees":[],"categories":[{"form":{"login_required":false,"should_notify":false,"inputs":[{"type":"email","showRegexInput":false,"enum":[],"regex":"\\S+@\\S+\\.\\S+","display":"email","required":true,"key":"email"}],"available_assignees":[],"_id":"602e900a2042255c03cadaf0","title":"service-test-satyen","description":"testing form from service","slug":"service-test-satyen","header_image":"https://hdn-1.addsale.com/x0/support-ticket/files/free/original/KZL86aN5l-service-test-satyen.jpeg","application_id":"000000000000000000000001","created_on":{"user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 11_2_0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/88.0.4324.150 Safari/537.36","platform":"web","meta":{"browser":{"name":"Chrome","version":"88.0.4324.150"},"os":{"name":"macOS","version":"11.2.0"},"platform":{"type":"desktop","vendor":"Apple"},"engine":{"name":"Blink"}}},"created_by":"5f8147abbd1a0a870f61f1a6","createdAt":"2021-02-18T16:04:26.495Z","updatedAt":"2021-02-18T16:04:26.495Z","__v":0},"key":"service-test-satyen","display":"service-test-satyen"}]}}},"With items":{"value":{"docs":[{"_id":"602d2652ce284d0b008d5c97","status":{"display":"Pending","color":"#eae22b","key":"pending"},"priority":{"display":"Medium","color":"#f37736","key":"medium"},"assigned_to":{"agent_id":"5e79e721768c6bf54b783146","gender":"male","accountType":"user","active":true,"profilePicUrl":"https://d2co8r51m5ca2d.cloudfront.net/inapp_banners/default_profile_img.png","hasOldPasswordHash":false,"_id":"5e79e721768c6bf54b783146","emails":[{"active":true,"primary":true,"verified":true,"email":"niktest@xyz.com"},{"active":true,"primary":false,"verified":true,"email":"xyz@xyz.com"},{"active":true,"primary":false,"verified":true,"email":"xyz@xyz.com"},{"active":true,"primary":false,"verified":true,"email":"xyz@xyz.com"}],"phoneNumbers":[{"active":true,"primary":true,"verified":true,"countryCode":91,"phone":"9999999999"}],"firstName":"Nikhil","lastName":"Manapure","username":"xyz_xyz_com","createdAt":"2020-03-24T10:55:29.298Z","updatedAt":"2020-05-12T07:46:41.816Z","uid":"5567","__v":2},"tags":["asdf444"],"context":{"application_id":"000000000000000000000001","company_id":"1"},"created_on":{"user_agent":"Fynd Platform/0.0.1 (com.fynd.platform; build:3; iOS 14.2.0) Alamofire/5.0.2","platform":"web","meta":{"browser":{"name":"Fynd Platform","version":"0.0.1"}}},"source":"sales_channel","content":{"title":"asdf444 Response","description":"","attachments":[]},"response_id":"602d2652ce284dee3c8d5c96","category":{"form":{"login_required":false,"should_notify":true,"inputs":[{"type":"text","showRegexInput":false,"enum":[],"display":"asdf","key":"asdf"},{"type":"mobile","showRegexInput":false,"enum":[],"display":"mob num","regex":"[0-9]{10}$","key":"mob-num"}],"available_assignees":["5e79e721768c6bf54b783146"],"_id":"60124e4a4d2bc363625e1bf4","title":"asdf444","description":"adf","slug":"asdf444","application_id":"000000000000000000000001","created_on":{"user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/88.0.4324.96 Safari/537.36","platform":"web","meta":{"browser":{"name":"Chrome","version":"88.0.4324.96"},"os":{"name":"macOS","version":"10.15.7","versionName":"Catalina"},"platform":{"type":"desktop","vendor":"Apple"},"engine":{"name":"Blink"}}},"created_by":"5e79e721768c6bf54b783146","createdAt":"2021-01-28T05:40:26.271Z","updatedAt":"2021-02-18T16:02:32.086Z","__v":0,"poll_for_assignment":{"duration":20,"message":"We are looking for executive to connect you","success_message":"Executive found","failure_message":"All our executives are busy at the moment, We have accepted your request and someone will connect with you soon!"}},"key":"asdf444","display":"asdf444"},"ticket_id":"472","createdAt":"2021-02-17T14:21:06.774Z","updatedAt":"2021-02-17T14:21:06.774Z","__v":0,"id":"602d2652ce284d0b008d5c97"}],"total":472,"limit":10,"page":1,"pages":48,"filters":{"statuses":[{"display":"Pending","color":"#eae22b","key":"pending"},{"display":"In Progress","color":"#ffa951","key":"in_progress"},{"display":"Resolved","color":"#20c3a6","key":"resolved"},{"display":"Closed","color":"#41434c","key":"closed"}],"priorities":[{"display":"Low","color":"#fed766","key":"low"},{"display":"Medium","color":"#f37736","key":"medium"},{"display":"High","color":"#fe4a49","key":"high"}],"assignees":[],"categories":[{"form":{"login_required":false,"should_notify":false,"inputs":[{"type":"email","showRegexInput":false,"enum":[],"regex":"\\S+@\\S+\\.\\S+","display":"email","required":true,"key":"email"}],"available_assignees":[],"_id":"602e900a2042255c03cadaf0","title":"service-test-satyen","description":"testing form from service","slug":"service-test-satyen","header_image":"https://hdn-1.addsale.com/x0/support-ticket/files/free/original/KZL86aN5l-service-test-satyen.jpeg","application_id":"000000000000000000000001","created_on":{"user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 11_2_0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/88.0.4324.150 Safari/537.36","platform":"web","meta":{"browser":{"name":"Chrome","version":"88.0.4324.150"},"os":{"name":"macOS","version":"11.2.0"},"platform":{"type":"desktop","vendor":"Apple"},"engine":{"name":"Blink"}}},"created_by":"5f8147abbd1a0a870f61f1a6","createdAt":"2021-02-18T16:04:26.495Z","updatedAt":"2021-02-18T16:04:26.495Z","__v":0},"key":"service-test-satyen","display":"service-test-satyen"}]}}}}}}}}}},"/service/platform/lead/v1.0/company/{company_id}/ticket/{id}":{"get":{"description":"Retreives ticket details of a company level ticket","summary":"getPlatformTicket | Retreives ticket details of a company level ticket with ticket ID","tags":["Lead"],"parameters":[{"name":"company_id","in":"path","description":"Company ID for which the data will be returned","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Tiket ID of the ticket to be fetched","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ticket"},"examples":{"Default":{"value":{"context":{"company_id":"1"},"content":{"title":"SOme title Response","description":"Handles communication between Administrator","attachments":[]},"status":{"display":"In Progress","color":"#ffa951","key":"in_progress"},"priority":{"display":"Medium","color":"#f37736","key":"medium"},"assigned_to":{"agent_id":"5d1363adf599d850df93175e","gender":"male","accountType":"user","active":true,"profilePicUrl":"https://platform-lookaside.fbsbx.com/platform/profilepic/?asid=2136700473091190&height=400&width=400&ext=1554542761&hash=AeS6cuWIdjDdJJ-b","hasOldPasswordHash":false,"_id":"5d1363adf599d850df93175e","phoneNumbers":[{"active":true,"primary":true,"verified":true,"countryCode":91,"phone":"9999999999"}],"firstName":"Nikhil","lastName":"Manapure","emails":[{"active":true,"primary":true,"verified":true,"email":"niktest@xyz.com"}],"username":"niktest_xyz_com_38425_20500281","createdAt":"2019-01-01T17:22:38.528Z","updatedAt":"2021-01-22T10:02:42.258Z","uid":"20500281","__v":56},"tags":["some-title"],"_id":"6012f38557751ee8fc162cf7","created_on":{"user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/88.0.4324.96 Safari/537.36","platform":"web","meta":{"browser":{"name":"Chrome","version":"88.0.4324.96"},"os":{"name":"macOS","version":"10.15.7","versionName":"Catalina"},"platform":{"type":"desktop","vendor":"Apple"},"engine":{"name":"Blink"}}},"source":"sales_channel","created_by":{"id":"5d1363adf599d850df93175e","user":{"gender":"male","accountType":"user","active":true,"profilePicUrl":"https://platform-lookaside.fbsbx.com/platform/profilepic/?asid=2136700473091190&height=400&width=400&ext=1554542761&hash=AeS6cuWIdjDdJJ-b","hasOldPasswordHash":false,"_id":"5d1363adf599d850df93175e","phoneNumbers":[{"active":true,"primary":true,"verified":true,"countryCode":91,"phone":"9999999999"}],"firstName":"Nikhil","lastName":"Manapure","emails":[{"active":true,"primary":true,"verified":true,"email":"niktest@xyz.com"}],"username":"niktest_xyz_com_38425_20500281","createdAt":"2019-01-01T17:22:38.528Z","updatedAt":"2021-01-22T10:02:42.258Z","uid":"20500281","__v":56}},"response_id":"6012f38457751e0fb8162cf6","category":{"form":{"login_required":false,"should_notify":false,"inputs":[{"required":false,"type":"text","enum":[],"display":"Single lineeee","key":"single-lineeee","showRegexInput":false},{"required":false,"type":"email","enum":[],"display":"Email","regex":"\\S+@\\S+\\.\\S+","key":"email","showRegexInput":true},{"required":false,"type":"text","enum":[],"display":"dfsdf","key":"dfsdf","showRegexInput":false}],"available_assignees":["5b9b98150df588546aaea6d2","5c45d78395d7504f76c2cb37"],"_id":"5fd72db3dc250f8decfc61b2","title":"SOme title","description":"SOme big description","slug":"some-title","application_id":"000000000000000000000003","created_on":{"user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/87.0.4280.88 Safari/537.36","platform":"web","meta":{"browser":{"name":"Chrome","version":"87.0.4280.88"},"os":{"name":"macOS","version":"10.15.6","versionName":"Catalina"},"platform":{"type":"desktop","vendor":"Apple"},"engine":{"name":"Blink"}}},"created_by":"5d1363adf599d850df93175e","createdAt":"2020-12-14T09:17:39.953Z","updatedAt":"2021-01-28T18:48:07.717Z","__v":0},"key":"some-title","display":"SOme title"},"ticket_id":"43","createdAt":"2021-01-28T17:25:25.013Z","updatedAt":"2021-01-28T17:25:33.396Z","__v":0,"video_room_id":"6012f38557751ee8fc162cf7"}}}}}}}},"put":{"description":"Edits ticket details of a company level ticket such as status, priority, category, tags, attachments, assigne & ticket content changes","summary":"editPlatformTicket | Edits ticket details of a company level ticket","tags":["Lead"],"parameters":[{"name":"company_id","in":"path","description":"Company ID for ticket","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Ticket ID of ticket to be edited","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EditTicketPayload"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ticket"},"examples":{"Default":{"value":{"context":{"company_id":"1"},"content":{"title":"SOme title Response","description":"Handles communication between Administrator","attachments":[]},"status":{"display":"In Progress","color":"#ffa951","key":"in_progress"},"priority":{"display":"Medium","color":"#f37736","key":"medium"},"assigned_to":{"agent_id":"5d1363adf599d850df93175e","gender":"male","accountType":"user","active":true,"profilePicUrl":"https://platform-lookaside.fbsbx.com/platform/profilepic/?asid=2136700473091190&height=400&width=400&ext=1554542761&hash=AeS6cuWIdjDdJJ-b","hasOldPasswordHash":false,"_id":"5d1363adf599d850df93175e","phoneNumbers":[{"active":true,"primary":true,"verified":true,"countryCode":91,"phone":"9999999999"}],"firstName":"Nikhil","lastName":"Manapure","emails":[{"active":true,"primary":true,"verified":true,"email":"niktest@xyz.com"}],"username":"niktest_xyz_com_38425_20500281","createdAt":"2019-01-01T17:22:38.528Z","updatedAt":"2021-01-22T10:02:42.258Z","uid":"20500281","__v":56},"tags":["some-title"],"_id":"6012f38557751ee8fc162cf7","created_on":{"user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/88.0.4324.96 Safari/537.36","platform":"web","meta":{"browser":{"name":"Chrome","version":"88.0.4324.96"},"os":{"name":"macOS","version":"10.15.7","versionName":"Catalina"},"platform":{"type":"desktop","vendor":"Apple"},"engine":{"name":"Blink"}}},"source":"sales_channel","created_by":{"id":"5d1363adf599d850df93175e","user":{"gender":"male","accountType":"user","active":true,"profilePicUrl":"https://platform-lookaside.fbsbx.com/platform/profilepic/?asid=2136700473091190&height=400&width=400&ext=1554542761&hash=AeS6cuWIdjDdJJ-b","hasOldPasswordHash":false,"_id":"5d1363adf599d850df93175e","phoneNumbers":[{"active":true,"primary":true,"verified":true,"countryCode":91,"phone":"9999999999"}],"firstName":"Nikhil","lastName":"Manapure","emails":[{"active":true,"primary":true,"verified":true,"email":"niktest@xyz.com"}],"username":"niktest_xyz_com_38425_20500281","createdAt":"2019-01-01T17:22:38.528Z","updatedAt":"2021-01-22T10:02:42.258Z","uid":"20500281","__v":56}},"response_id":"6012f38457751e0fb8162cf6","category":{"form":{"login_required":false,"should_notify":false,"inputs":[{"required":false,"type":"text","enum":[],"display":"Single lineeee","key":"single-lineeee","showRegexInput":false},{"required":false,"type":"email","enum":[],"display":"Email","regex":"\\S+@\\S+\\.\\S+","key":"email","showRegexInput":true},{"required":false,"type":"text","enum":[],"display":"dfsdf","key":"dfsdf","showRegexInput":false}],"available_assignees":["5b9b98150df588546aaea6d2","5c45d78395d7504f76c2cb37"],"_id":"5fd72db3dc250f8decfc61b2","title":"SOme title","description":"SOme big description","slug":"some-title","application_id":"000000000000000000000003","created_on":{"user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/87.0.4280.88 Safari/537.36","platform":"web","meta":{"browser":{"name":"Chrome","version":"87.0.4280.88"},"os":{"name":"macOS","version":"10.15.6","versionName":"Catalina"},"platform":{"type":"desktop","vendor":"Apple"},"engine":{"name":"Blink"}}},"created_by":"5d1363adf599d850df93175e","createdAt":"2020-12-14T09:17:39.953Z","updatedAt":"2021-01-28T18:48:07.717Z","__v":0},"key":"some-title","display":"SOme title"},"ticket_id":"43","createdAt":"2021-01-28T17:25:25.013Z","updatedAt":"2021-01-28T17:25:33.396Z","__v":0,"video_room_id":"6012f38557751ee8fc162cf7"}}}}}}}}},"/service/platform/lead/v1.0/company/{company_id}/application/{application_id}/ticket/{id}":{"get":{"description":"Retreives ticket details of a application level ticket with ticket ID","summary":"getNewTicket | Retreives ticket details of a application level ticket","tags":["Lead"],"parameters":[{"name":"company_id","in":"path","description":"Company ID of the application","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Application ID for which the data will be returned","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Tiket ID of the ticket to be fetched","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ticket"},"examples":{"Default":{"value":{"context":{"application_id":"000000000000000000000003","company_id":"884"},"content":{"title":"SOme title Response","description":"Handles communication between Administrator","attachments":[]},"status":{"display":"In Progress","color":"#ffa951","key":"in_progress"},"priority":{"display":"Medium","color":"#f37736","key":"medium"},"assigned_to":{"agent_id":"5d1363adf599d850df93175e","gender":"male","accountType":"user","active":true,"profilePicUrl":"https://platform-lookaside.fbsbx.com/platform/profilepic/?asid=2136700473091190&height=400&width=400&ext=1554542761&hash=AeS6cuWIdjDdJJ-b","hasOldPasswordHash":false,"_id":"5d1363adf599d850df93175e","phoneNumbers":[{"active":true,"primary":true,"verified":true,"countryCode":91,"phone":"9999999999"}],"firstName":"Nikhil","lastName":"Manapure","emails":[{"active":true,"primary":true,"verified":true,"email":"niktest@xyz.com"}],"username":"niktest_xyz_com_38425_20500281","createdAt":"2019-01-01T17:22:38.528Z","updatedAt":"2021-01-22T10:02:42.258Z","uid":"20500281","__v":56},"tags":["some-title"],"_id":"6012f38557751ee8fc162cf7","created_on":{"user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/88.0.4324.96 Safari/537.36","platform":"web","meta":{"browser":{"name":"Chrome","version":"88.0.4324.96"},"os":{"name":"macOS","version":"10.15.7","versionName":"Catalina"},"platform":{"type":"desktop","vendor":"Apple"},"engine":{"name":"Blink"}}},"source":"sales_channel","created_by":{"id":"5d1363adf599d850df93175e","user":{"gender":"male","accountType":"user","active":true,"profilePicUrl":"https://platform-lookaside.fbsbx.com/platform/profilepic/?asid=2136700473091190&height=400&width=400&ext=1554542761&hash=AeS6cuWIdjDdJJ-b","hasOldPasswordHash":false,"_id":"5d1363adf599d850df93175e","phoneNumbers":[{"active":true,"primary":true,"verified":true,"countryCode":91,"phone":"9999999999"}],"firstName":"Nikhil","lastName":"Manapure","emails":[{"active":true,"primary":true,"verified":true,"email":"niktest@xyz.com"}],"username":"niktest_xyz_com_38425_20500281","createdAt":"2019-01-01T17:22:38.528Z","updatedAt":"2021-01-22T10:02:42.258Z","uid":"20500281","__v":56}},"response_id":"6012f38457751e0fb8162cf6","category":{"form":{"login_required":false,"should_notify":false,"inputs":[{"required":false,"type":"text","enum":[],"display":"Single lineeee","key":"single-lineeee","showRegexInput":false},{"required":false,"type":"email","enum":[],"display":"Email","regex":"\\S+@\\S+\\.\\S+","key":"email","showRegexInput":true},{"required":false,"type":"text","enum":[],"display":"dfsdf","key":"dfsdf","showRegexInput":false}],"available_assignees":["5b9b98150df588546aaea6d2","5c45d78395d7504f76c2cb37"],"_id":"5fd72db3dc250f8decfc61b2","title":"SOme title","description":"SOme big description","slug":"some-title","application_id":"000000000000000000000003","created_on":{"user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/87.0.4280.88 Safari/537.36","platform":"web","meta":{"browser":{"name":"Chrome","version":"87.0.4280.88"},"os":{"name":"macOS","version":"10.15.6","versionName":"Catalina"},"platform":{"type":"desktop","vendor":"Apple"},"engine":{"name":"Blink"}}},"created_by":"5d1363adf599d850df93175e","createdAt":"2020-12-14T09:17:39.953Z","updatedAt":"2021-01-28T18:48:07.717Z","__v":0},"key":"some-title","display":"SOme title"},"ticket_id":"43","createdAt":"2021-01-28T17:25:25.013Z","updatedAt":"2021-01-28T17:25:33.396Z","__v":0,"video_room_id":"6012f38557751ee8fc162cf7"}}}}}}}},"put":{"description":"Edits ticket details of a application level ticket such as status, priority, category, tags, attachments, assigne & ticket content changes","summary":"editNewTicket | Edits ticket details of a application level ticket","tags":["Lead"],"parameters":[{"name":"company_id","in":"path","description":"Company ID of the application","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Application ID for ticket","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Ticket ID of ticket to be edited","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EditTicketPayload"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ticket"},"examples":{"Default":{"value":{"context":{"application_id":"000000000000000000000003","company_id":"884"},"content":{"title":"SOme title Response","description":"Handles communication between Administrator","attachments":[]},"status":{"display":"In Progress","color":"#ffa951","key":"in_progress"},"priority":{"display":"Medium","color":"#f37736","key":"medium"},"assigned_to":{"agent_id":"5d1363adf599d850df93175e","gender":"male","accountType":"user","active":true,"profilePicUrl":"https://platform-lookaside.fbsbx.com/platform/profilepic/?asid=2136700473091190&height=400&width=400&ext=1554542761&hash=AeS6cuWIdjDdJJ-b","hasOldPasswordHash":false,"_id":"5d1363adf599d850df93175e","phoneNumbers":[{"active":true,"primary":true,"verified":true,"countryCode":91,"phone":"9999999999"}],"firstName":"Nikhil","lastName":"Manapure","emails":[{"active":true,"primary":true,"verified":true,"email":"niktest@xyz.com"}],"username":"niktest_xyz_com_38425_20500281","createdAt":"2019-01-01T17:22:38.528Z","updatedAt":"2021-01-22T10:02:42.258Z","uid":"20500281","__v":56},"tags":["some-title"],"_id":"6012f38557751ee8fc162cf7","created_on":{"user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/88.0.4324.96 Safari/537.36","platform":"web","meta":{"browser":{"name":"Chrome","version":"88.0.4324.96"},"os":{"name":"macOS","version":"10.15.7","versionName":"Catalina"},"platform":{"type":"desktop","vendor":"Apple"},"engine":{"name":"Blink"}}},"source":"sales_channel","created_by":{"id":"5d1363adf599d850df93175e","user":{"gender":"male","accountType":"user","active":true,"profilePicUrl":"https://platform-lookaside.fbsbx.com/platform/profilepic/?asid=2136700473091190&height=400&width=400&ext=1554542761&hash=AeS6cuWIdjDdJJ-b","hasOldPasswordHash":false,"_id":"5d1363adf599d850df93175e","phoneNumbers":[{"active":true,"primary":true,"verified":true,"countryCode":91,"phone":"9999999999"}],"firstName":"Nikhil","lastName":"Manapure","emails":[{"active":true,"primary":true,"verified":true,"email":"niktest@xyz.com"}],"username":"niktest_xyz_com_38425_20500281","createdAt":"2019-01-01T17:22:38.528Z","updatedAt":"2021-01-22T10:02:42.258Z","uid":"20500281","__v":56}},"response_id":"6012f38457751e0fb8162cf6","category":{"form":{"login_required":false,"should_notify":false,"inputs":[{"required":false,"type":"text","enum":[],"display":"Single lineeee","key":"single-lineeee","showRegexInput":false},{"required":false,"type":"email","enum":[],"display":"Email","regex":"\\S+@\\S+\\.\\S+","key":"email","showRegexInput":true},{"required":false,"type":"text","enum":[],"display":"dfsdf","key":"dfsdf","showRegexInput":false}],"available_assignees":["5b9b98150df588546aaea6d2","5c45d78395d7504f76c2cb37"],"_id":"5fd72db3dc250f8decfc61b2","title":"SOme title","description":"SOme big description","slug":"some-title","application_id":"000000000000000000000003","created_on":{"user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/87.0.4280.88 Safari/537.36","platform":"web","meta":{"browser":{"name":"Chrome","version":"87.0.4280.88"},"os":{"name":"macOS","version":"10.15.6","versionName":"Catalina"},"platform":{"type":"desktop","vendor":"Apple"},"engine":{"name":"Blink"}}},"created_by":"5d1363adf599d850df93175e","createdAt":"2020-12-14T09:17:39.953Z","updatedAt":"2021-01-28T18:48:07.717Z","__v":0},"key":"some-title","display":"SOme title"},"ticket_id":"43","createdAt":"2021-01-28T17:25:25.013Z","updatedAt":"2021-01-28T17:25:33.396Z","__v":0,"video_room_id":"6012f38557751ee8fc162cf7"}}}}}}}}},"/service/platform/lead/v1.0/company/{company_id}/ticket/{id}/history":{"post":{"description":"Create history for specific company level ticket, this history is seen on ticket detail page, this can be comment, log or rating.","summary":"createPlatformTicketHistory | Create history for specific company level ticket","tags":["Lead"],"parameters":[{"name":"company_id","in":"path","description":"Company ID for ticket","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Ticket ID for which history is created","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TicketHistoryPayload"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TicketHistory"},"examples":{"Default":{"value":{"_id":"601a9d52c26687d086c499ef","ticket_id":"43","type":"comment","value":{"text":"d","media":[]},"created_on":{"user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/88.0.4324.96 Safari/537.36","platform":"web","meta":{"browser":{"name":"Chrome","version":"88.0.4324.96"},"os":{"name":"macOS","version":"10.15.7","versionName":"Catalina"},"platform":{"type":"desktop","vendor":"Apple"},"engine":{"name":"Blink"}}},"created_by":{"5d1363adf599d850df93175e":null},"createdAt":"2021-02-03T12:55:46.808Z","updatedAt":"2021-02-03T12:55:46.808Z","__v":0}}}}}}}},"get":{"description":"Gets history list for specific company level ticket, this history is seen on ticket detail page, this can be comment, log or rating.","summary":"getPlatformTicketHistory | Gets history list for specific company level ticket","tags":["Lead"],"parameters":[{"name":"company_id","in":"path","description":"Company ID for ticket","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Ticket ID for which history is to be fetched","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TicketHistoryList"},"examples":{"Default":{"value":{"docs":[{"_id":"602e5384204225eed5cadae7","ticket_id":"41","type":"comment","value":{"text":"hello service","media":[]},"created_on":{"user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 11_2_0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/88.0.4324.150 Safari/537.36","platform":"web","meta":{"browser":{"name":"Chrome","version":"88.0.4324.150"},"os":{"name":"macOS","version":"11.2.0"},"platform":{"type":"desktop","vendor":"Apple"},"engine":{"name":"Blink"}}},"created_by":{"gender":"male","accountType":"user","active":true,"profilePicUrl":"https://hdn-1.fynd.com/company/884/applications/000000000000000000000001/theme/pictures/free/original/default-profile_nxhzui.png","hasOldPasswordHash":false,"_id":"5f8147abbd1a0a870f61f1a6","phoneNumbers":[{"active":true,"primary":true,"verified":true,"phone":"9999999999","countryCode":91}],"firstName":"Satyen","lastName":"Maurya","emails":[{"active":true,"primary":true,"verified":true,"email":"sattest@xyz.com"}],"username":"sat5_xyz_com_11118","createdAt":"2020-10-10T05:33:31.119Z","updatedAt":"2020-10-10T05:33:31.119Z","uid":"5678","__v":0},"createdAt":"2021-02-18T11:46:12.522Z","updatedAt":"2021-02-18T11:46:12.522Z","__v":0,"id":"602e5384204225eed5cadae7"},{"_id":"60372aa78a046d4d79c46e15","ticket_id":"41","type":"diff","value":{"status":["pending","in_progress"]},"created_by":{"gender":"male","accountType":"user","active":true,"profilePicUrl":"https://d2co8r51m5ca2d.cloudfront.net/inapp_banners/default_profile_img.png","hasOldPasswordHash":false,"_id":"5e79e721768c6bf54b783146","emails":[{"active":true,"primary":true,"verified":true,"email":"niktest@xyz.com"},{"active":true,"primary":false,"verified":true,"email":"xyz@xyz.com"},{"active":true,"primary":false,"verified":true,"email":"xyz@xyz.com"},{"active":true,"primary":false,"verified":true,"email":"xyz@xyz.com"}],"phoneNumbers":[{"active":true,"primary":true,"verified":true,"countryCode":91,"phone":"9999999999"}],"firstName":"Nikhil","lastName":"Manapure","username":"xyz_xyz_com","createdAt":"2020-03-24T10:55:29.298Z","updatedAt":"2020-05-12T07:46:41.816Z","uid":"5567","__v":2},"createdAt":"2021-02-25T04:42:15.225Z","updatedAt":"2021-02-25T04:42:15.225Z","__v":0,"id":"60372aa78a046d4d79c46e15"}],"total":2,"limit":100,"page":{"type":""},"pages":1}}}}}}}}},"/service/platform/lead/v1.0/company/{company_id}/ticket/{id}/feedback":{"get":{"description":"Gets a list of feedback submitted against that ticket","summary":"getFeedbacks | Gets a list of feedback submitted against that ticket","tags":["Lead"],"parameters":[{"name":"company_id","in":"path","description":"Company ID for ticket","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Ticket ID for which feedbacks are to be fetched","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TicketFeedbackList"},"examples":{"Default":{"value":{"items":[{"_id":"60c255bf00ecabfad19e9601","company_id":"1","ticket_id":"6095812876d2bf17143cb3b3","user":{"_id":"5f8147abbd1a0a870f61f1a6","authenticated":true,"user_id":"5f8147abbd1a0a870f61f1a6"},"category":"customers","response":[{"audio":2,"video":6,"display":"","key":"","value":""}],"createdAt":"2021-06-10T18:11:11.349Z","updatedAt":"2021-06-10T18:11:11.349Z","__v":0}]}}}}}}}},"post":{"description":"Submit a response for feeback form against that ticket","summary":"submitFeedback | Submit a response for feeback form against that ticket","tags":["Lead"],"parameters":[{"name":"company_id","in":"path","description":"Company ID for ticket","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Ticket ID for which feedback is to be submitted","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TicketFeedbackPayload"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TicketFeedback"},"examples":{"Default":{"value":{"_id":"60c255bf00ecabfad19e9601","company_id":"1","ticket_id":"6095812876d2bf17143cb3b3","user":{"_id":"5f8147abbd1a0a870f61f1a6","authenticated":true,"user_id":"5f8147abbd1a0a870f61f1a6"},"category":"customers","response":[{"audio":2,"video":6,"display":"","key":"","value":""}],"createdAt":"2021-06-10T18:11:11.349Z","updatedAt":"2021-06-10T18:11:11.349Z","__v":0}}}}}}}}},"/service/platform/lead/v1.0/company/{company_id}/application/{application_id}/ticket/{id}/history":{"post":{"description":"Create history for specific application level ticket, this history is seen on ticket detail page, this can be comment, log or rating.","summary":"createNewHistory | Create history for specific application level ticket","tags":["Lead"],"parameters":[{"name":"company_id","in":"path","description":"Company ID of the application","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Application ID for ticket","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Ticket ID for which history is created","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TicketHistoryPayload"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TicketHistory"},"examples":{"Default":{"value":{"_id":"601a9d52c26687d086c499ef","ticket_id":"41","type":"comment","value":{"text":"d","media":[]},"created_on":{"user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/88.0.4324.96 Safari/537.36","platform":"web","meta":{"browser":{"name":"Chrome","version":"88.0.4324.96"},"os":{"name":"macOS","version":"10.15.7","versionName":"Catalina"},"platform":{"type":"desktop","vendor":"Apple"},"engine":{"name":"Blink"}}},"created_by":{"5d1363adf599d850df93175e":null},"createdAt":"2021-02-03T12:55:46.808Z","updatedAt":"2021-02-03T12:55:46.808Z","__v":0}}}}}}}},"get":{"description":"Gets history list for specific application level ticket, this history is seen on ticket detail page, this can be comment, log or rating.","summary":"getNewTicketHistory | Gets history list for specific application level ticket","tags":["Lead"],"parameters":[{"name":"company_id","in":"path","description":"Company ID of application","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Application ID for ticket","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Ticket ID for which history is to be fetched","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TicketHistoryList"},"examples":{"Default":{"value":{"docs":[{"_id":"602e5384204225eed5cadae7","ticket_id":"41","type":"comment","value":{"text":"hello service","media":[]},"created_on":{"user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 11_2_0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/88.0.4324.150 Safari/537.36","platform":"web","meta":{"browser":{"name":"Chrome","version":"88.0.4324.150"},"os":{"name":"macOS","version":"11.2.0"},"platform":{"type":"desktop","vendor":"Apple"},"engine":{"name":"Blink"}}},"created_by":{"gender":"male","accountType":"user","active":true,"profilePicUrl":"https://hdn-1.fynd.com/company/884/applications/000000000000000000000001/theme/pictures/free/original/default-profile_nxhzui.png","hasOldPasswordHash":false,"_id":"5f8147abbd1a0a870f61f1a6","phoneNumbers":[{"active":true,"primary":true,"verified":true,"phone":"9999999999","countryCode":91}],"firstName":"Satyen","lastName":"Maurya","emails":[{"active":true,"primary":true,"verified":true,"email":"sattest@xyz.com"}],"username":"sat5_xyz_com_11118","createdAt":"2020-10-10T05:33:31.119Z","updatedAt":"2020-10-10T05:33:31.119Z","uid":"5678","__v":0},"createdAt":"2021-02-18T11:46:12.522Z","updatedAt":"2021-02-18T11:46:12.522Z","__v":0,"id":"602e5384204225eed5cadae7"},{"_id":"60372aa78a046d4d79c46e15","ticket_id":"41","type":"diff","value":{"status":["pending","in_progress"]},"created_by":{"gender":"male","accountType":"user","active":true,"profilePicUrl":"https://d2co8r51m5ca2d.cloudfront.net/inapp_banners/default_profile_img.png","hasOldPasswordHash":false,"_id":"5e79e721768c6bf54b783146","emails":[{"active":true,"primary":true,"verified":true,"email":"niktest@xyz.com"},{"active":true,"primary":false,"verified":true,"email":"xyz@xyz.com"},{"active":true,"primary":false,"verified":true,"email":"xyz@xyz.com"},{"active":true,"primary":false,"verified":true,"email":"xyz@xyz.com"}],"phoneNumbers":[{"active":true,"primary":true,"verified":true,"countryCode":91,"phone":"9999999999"}],"firstName":"Nikhil","lastName":"Manapure","username":"xyz_xyz_com","createdAt":"2020-03-24T10:55:29.298Z","updatedAt":"2020-05-12T07:46:41.816Z","uid":"5567","__v":2},"createdAt":"2021-02-25T04:42:15.225Z","updatedAt":"2021-02-25T04:42:15.225Z","__v":0,"id":"60372aa78a046d4d79c46e15"}],"total":2,"limit":100,"page":{"type":""},"pages":1}}}}}}}}},"/service/platform/lead/v1.0/company/{company_id}/application/{application_id}/form/{slug}":{"get":{"description":"Get specific custom form using it's slug, this is used to view the form.","summary":"getCustomForm | Get specific custom form using it's slug","tags":["Lead"],"parameters":[{"name":"company_id","in":"path","description":"Company ID of the application","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Application ID for the form","required":true,"schema":{"type":"string"}},{"name":"slug","in":"path","description":"Slug of form whose response is getting submitted","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomForm"},"examples":{"Default":{"value":[{"required":false,"login_required":false,"should_notify":false,"inputs":[{"required":false,"type":"text","display":"Name","placeholder":"Please enter your name","key":"name"}],"available_assignees":[],"_id":"5fd258a9088f957f34c288fc","title":"trail form","description":"Trail form description","slug":"trail-form","application_id":"000000000000000000000003","created_on":{"user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/87.0.4280.88 Safari/537.36","platform":"web","meta":{"browser":{"name":"Chrome","version":"87.0.4280.88"},"os":{"name":"macOS","version":"10.15.6","versionName":"Catalina"},"platform":{"type":"desktop","vendor":"Apple"},"engine":{"name":"Blink"}}},"created_by":"5d1363adf599d850df93175e","createdAt":"2020-12-10T17:19:37.515Z","updatedAt":"2020-12-10T17:19:43.214Z","__v":0}]}}}}}}},"put":{"description":"Edit the given custom form field such as adding or deleting input, assignee, title, decription, notification and polling information.","summary":"editCustomForm | Edit the given custom form","tags":["Lead"],"parameters":[{"name":"company_id","in":"path","description":"Company ID of the application","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Application ID for the form","required":true,"schema":{"type":"string"}},{"name":"slug","in":"path","description":"Slug of form whose response is getting submitted","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EditCustomFormPayload"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomForm"},"examples":{"Default":{"value":[{"required":false,"login_required":false,"should_notify":false,"inputs":[{"type":"email","showRegexInput":true,"enum":[],"regex":"\\S+@\\S+\\.\\S+","display":"email","required":true,"key":"email"},{"type":"number","showRegexInput":false,"enum":[],"display":"Enter your fav number","placeholder":"123","key":"enter-your-fav-number"}],"available_assignees":[],"_id":"602e900a2042255c03cadaf0","title":"service-test-satyen","description":"testing form from service","slug":"service-test-satyen","header_image":"https://hdn-1.addsale.com/x0/support-ticket/files/free/original/KZL86aN5l-service-test-satyen.jpeg","application_id":"000000000000000000000001","created_on":{"user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 11_2_0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/88.0.4324.150 Safari/537.36","platform":"web","meta":{"browser":{"name":"Chrome","version":"88.0.4324.150"},"os":{"name":"macOS","version":"11.2.0"},"platform":{"type":"desktop","vendor":"Apple"},"engine":{"name":"Blink"}}},"created_by":"5f8147abbd1a0a870f61f1a6","createdAt":"2021-02-18T16:04:26.495Z","updatedAt":"2021-02-26T10:16:49.272Z","__v":0}]}}}}}}},"delete":{"description":"Delete a custom form using it's slug","summary":"deleteCustomForm | Delete a custom form","tags":["Lead"],"parameters":[{"name":"company_id","in":"path","description":"Company ID of the application","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Application ID for the form","required":true,"schema":{"type":"string"}},{"name":"slug","in":"path","description":"Slug of form whose response is getting submitted","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomForm"},"examples":{"Default":{"value":[{"required":false,"login_required":false,"should_notify":false,"inputs":[{"type":"email","showRegexInput":true,"enum":[],"regex":"\\S+@\\S+\\.\\S+","display":"email","required":true,"key":"email"},{"type":"number","showRegexInput":false,"enum":[],"display":"Enter your fav number","placeholder":"123","key":"enter-your-fav-number"}],"available_assignees":[],"_id":"602e900a2042255c03cadaf0","title":"service-test-satyen","description":"testing form from service","slug":"service-test-satyen","header_image":"https://hdn-1.addsale.com/x0/support-ticket/files/free/original/KZL86aN5l-service-test-satyen.jpeg","application_id":"000000000000000000000001","created_on":{"user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 11_2_0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/88.0.4324.150 Safari/537.36","platform":"web","meta":{"browser":{"name":"Chrome","version":"88.0.4324.150"},"os":{"name":"macOS","version":"11.2.0"},"platform":{"type":"desktop","vendor":"Apple"},"engine":{"name":"Blink"}}},"created_by":"5f8147abbd1a0a870f61f1a6","createdAt":"2021-02-18T16:04:26.495Z","updatedAt":"2021-02-26T10:16:49.272Z","__v":0}]}}}}},"404":{"description":"Failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/service/platform/lead/v1.0/company/{company_id}/application/{application_id}/form":{"get":{"description":"Get list of custom form for given application","summary":"getCustomForms | Get list of custom form","tags":["Lead"],"parameters":[{"name":"company_id","in":"path","description":"Company ID of the application","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Application ID for the form","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFormList"},"examples":{"Default":{"value":{"docs":[{"_id":"602e900a2042255c03cadaf0","login_required":false,"should_notify":false,"inputs":[{"type":"email","showRegexInput":true,"enum":[],"regex":"\\S+@\\S+\\.\\S+","display":"email","required":true,"key":"email"},{"type":"number","showRegexInput":false,"enum":[],"display":"Enter your fav number","placeholder":"123","key":"enter-your-fav-number"},{"type":"textarea","showRegexInput":false,"enum":[],"display":"kjhgjhvjb","required":true,"key":"kjhgjhvjb"}],"available_assignees":[],"title":"service-test-satyen","description":"testing form from service","slug":"service-test-satyen","header_image":"https://hdn-1.addsale.com/x0/support-ticket/files/free/original/KZL86aN5l-service-test-satyen.jpeg","application_id":"000000000000000000000001","created_on":{"user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 11_2_0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/88.0.4324.150 Safari/537.36","platform":"web","meta":{"browser":{"name":"Chrome","version":"88.0.4324.150"},"os":{"name":"macOS","version":"11.2.0"},"platform":{"type":"desktop","vendor":"Apple"},"engine":{"name":"Blink"}}},"created_by":"5f8147abbd1a0a870f61f1a6","createdAt":"2021-02-18T16:04:26.495Z","updatedAt":"2021-02-24T15:49:56.256Z","__v":0,"id":"602e900a2042255c03cadaf0"},{"_id":"60124e4a4d2bc363625e1bf4","login_required":false,"should_notify":true,"inputs":[{"type":"text","showRegexInput":false,"enum":[],"display":"asdf","key":"asdf"},{"type":"mobile","showRegexInput":false,"enum":[],"display":"mob num","regex":"[0-9]{10}$","key":"mob-num"}],"available_assignees":["5e79e721768c6bf54b783146"],"title":"asdf444","description":"adf","slug":"asdf444","application_id":"000000000000000000000001","created_on":{"user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/88.0.4324.96 Safari/537.36","platform":"web","meta":{"browser":{"name":"Chrome","version":"88.0.4324.96"},"os":{"name":"macOS","version":"10.15.7","versionName":"Catalina"},"platform":{"type":"desktop","vendor":"Apple"},"engine":{"name":"Blink"}}},"created_by":"5e79e721768c6bf54b783146","createdAt":"2021-01-28T05:40:26.271Z","updatedAt":"2021-02-18T16:02:32.086Z","__v":0,"poll_for_assignment":{"duration":20,"message":"We are looking for executive to connect you","success_message":"Executive found","failure_message":"All our executives are busy at the moment, We have accepted your request and someone will connect with you soon!"},"id":"60124e4a4d2bc363625e1bf4"}],"total":2,"limit":10,"page":{"type":""},"pages":1}}}}}}}},"post":{"description":"Creates a new custom form for given application","summary":"createCustomForm | Creates a new custom form","tags":["Lead"],"parameters":[{"name":"company_id","in":"path","description":"Company ID of the application","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Application ID for the form","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCustomFormPayload"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomForm"},"examples":{"Default":{"value":[{"required":false,"login_required":false,"should_notify":false,"inputs":[{"type":"email","showRegexInput":true,"enum":[],"regex":"\\S+@\\S+\\.\\S+","display":"email","required":true,"key":"email"},{"type":"number","showRegexInput":false,"enum":[],"display":"Enter your fav number","placeholder":"123","key":"enter-your-fav-number"}],"available_assignees":[],"_id":"602e900a2042255c03cadaf0","title":"service-test-satyen","description":"testing form from service","slug":"service-test-satyen","header_image":"https://hdn-1.addsale.com/x0/support-ticket/files/free/original/KZL86aN5l-service-test-satyen.jpeg","application_id":"000000000000000000000001","created_on":{"user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 11_2_0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/88.0.4324.150 Safari/537.36","platform":"web","meta":{"browser":{"name":"Chrome","version":"88.0.4324.150"},"os":{"name":"macOS","version":"11.2.0"},"platform":{"type":"desktop","vendor":"Apple"},"engine":{"name":"Blink"}}},"created_by":"5f8147abbd1a0a870f61f1a6","createdAt":"2021-02-18T16:04:26.495Z","updatedAt":"2021-02-26T10:16:49.272Z","__v":0}]}}}}}}}},"/service/platform/lead/v1.0/company/{company_id}/video/room/{unique_name}/token":{"get":{"description":"Get Token to join a specific Video Room using it's unqiue name, this Token is your ticket to Room and also creates your identity there.","summary":"getTokenForPlatformVideoRoom | Get Token to join a specific Video Room using it's unqiue name","tags":["Lead"],"parameters":[{"name":"company_id","in":"path","description":"Company Id for video room","required":true,"schema":{"type":"string"}},{"name":"unique_name","in":"path","description":"Unique name of video room","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetTokenForVideoRoomResponse"},"examples":{"Default":{"value":{"access_token":"your_token_to_the_room"}}}}}}}}},"/service/platform/lead/v1.0/company/{company_id}/application/{application_id}/video/room/{unique_name}/token":{"get":{"description":"Get Token to join a specific Video Room using it's unqiue name, this Token is your ticket to Room and also creates your identity there.","summary":"getNewTokenForVideoRoom | Get Token to join a specific Video Room using it's unqiue name","tags":["Lead"],"parameters":[{"name":"company_id","in":"path","description":"Company ID of the application","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Application ID for video room","required":true,"schema":{"type":"string"}},{"name":"unique_name","in":"path","description":"Unique name of video room","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetTokenForVideoRoomResponse"},"examples":{"Default":{"value":{"access_token":"your_token_to_the_room"}}}}}}}}},"/service/platform/lead/v1.0/company/{company_id}/video/room/{unique_name}/participants":{"get":{"description":"Get participants of a specific Video Room using it's unique name, this can be used to check if people are already there in the room and also to show their names.","summary":"getPlatformVideoParticipants | Get participants of a specific Video Room using it's unique name","tags":["Lead"],"parameters":[{"name":"company_id","in":"path","description":"Company Id for video room","required":true,"schema":{"type":"string"}},{"name":"unique_name","in":"path","description":"Unique name of Video Room","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetParticipantsInsideVideoRoomResponse"},"examples":{"Default":{"value":{"participants":[]}}}}}}}}},"/service/platform/lead/v1.0/company/{company_id}/application/{application_id}/video/room/{unique_name}/participants":{"get":{"description":"Get participants of a specific Video Room using it's unique name, this can be used to check if people are already there in the room and also to show their names.","summary":"getNewVideoParticipants | Get participants of a specific Video Room using it's unique name","tags":["Lead"],"parameters":[{"name":"company_id","in":"path","description":"Company ID of the application","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Application ID for video room","required":true,"schema":{"type":"string"}},{"name":"unique_name","in":"path","description":"Unique name of Video Room","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetParticipantsInsideVideoRoomResponse"},"examples":{"Default":{"value":{"participants":[]}}}}}}}}},"/service/platform/lead/v1.0/company/{company_id}/application/{application_id}/video/room":{"post":{"description":"Open a video room.","summary":"openVideoRoom | Open a video room.","tags":["Lead"],"parameters":[{"name":"company_id","in":"path","description":"Company ID of the application","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Application ID for video room","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateVideoRoomPayload"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateVideoRoomResponse"},"examples":{"Default":{"value":{"unique_name":"alphanumeric123"}}}}}}}}},"/service/platform/lead/v1.0/company/{company_id}/application/{application_id}/video/room/{unique_name}":{"delete":{"description":"Close the video room and force all participants to leave.","summary":"closeVideoRoom | Close the video room and force all participants to leave.","tags":["Lead"],"parameters":[{"name":"company_id","in":"path","description":"Company ID of the application","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Application ID for video room","required":true,"schema":{"type":"string"}},{"name":"unique_name","in":"path","description":"Unique name of Video Room","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloseVideoRoomResponse"},"examples":{"Default":{"value":{"success":true}}}}}}}}},"/service/platform/lead/v1.0/company/{company_id}/general-config":{"get":{"description":"Get general support configuration.","summary":"getGeneralConfig | Get general support configuration.","tags":["Lead"],"parameters":[{"name":"company_id","in":"path","description":"Company ID of the application","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloseVideoRoomResponse"},"examples":{"Default":{"value":{"success":true}}}}}}}}},"/service/platform/logistics/v2.0/company/{company_id}/zones":{"get":{"summary":"getZones | Shows zones defined at the company level","description":"Return the list of zones that are defined at the company level.","tags":["Serviceability"],"parameters":[{"in":"path","name":"company_id","description":"A `company_id` is a unique identifier for a particular sale channel.","schema":{"type":"integer"},"required":true,"examples":{"Test Company":{"value":1}}},{"in":"query","name":"page_no","description":"index of the item to start returning with","schema":{"type":"integer","default":1,"minimum":1}},{"in":"query","name":"page_size","description":"determines the items to be displayed in a page","schema":{"type":"integer","default":10,"minimum":1}},{"in":"query","name":"is_active","description":"Status of Zone (either active or inactive)","schema":{"type":"boolean"},"examples":{"Active Zones":{"value":true}}},{"in":"query","name":"channel_id","description":"Zones filtered by an application","schema":{"type":"string"},"examples":{"Single application filter":{"value":"64fee4b354c2c22a822de54f"},"Multiple application filters":{"value":"64fee4b354c2c22a822de54f,6502e3b460c34d2d0fb705c8"}}},{"in":"query","name":"q","description":"search with name as a free text","schema":{"type":"string"},"examples":{"Sample query":{"value":"zone"}}},{"in":"query","name":"country","description":"ISO2 code of the country","schema":{"type":"string"},"examples":{"India":{"value":"India"}}},{"in":"query","name":"state","description":"State name","schema":{"type":"string"},"examples":{"Indian State":{"value":"Maharashtra"}}},{"in":"query","name":"city","description":"City name","schema":{"type":"string"},"examples":{"Indian City":{"value":"Mumbai"}}},{"in":"query","name":"pincode","description":"Pincode value to search zones","schema":{"type":"string"},"examples":{"Pincode":{"value":"400603"}}},{"in":"query","name":"sector","description":"Sector value to search zones","schema":{"type":"string"},"examples":{"Sector":{"value":"Abu Dhabi"}}}],"responses":{"200":{"description":"Zone List of application in descending order of their last modified date.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListViewResponse"},"examples":{"Zone Listing with q=zone":{"$ref":"#/components/examples/ZoneSearchQueryIsActiveExample"}}}}},"400":{"description":"Bad request. See the error object in the response body for specific reason","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceabilityErrorResponse"}}}}}},"post":{"summary":"createZone | Creates a new Zone","description":"Creates a new zone with the specified mapping. A zone enables serviceability based on given regions. By creating a zone and including specific regions, you can ensure that the stores associated with the zone are serviceable for those added regions. This functionality is particularly useful when you need to ensure serviceability for multiple regions by grouping them into a single zone.","tags":["Serviceability"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateZoneData"},"examples":{"New Maharashtra Pincode Zone":{"$ref":"#/components/examples/MaharashtraPincodeZone"}}}}},"parameters":[{"in":"path","name":"company_id","description":"A `company_id` is a unique identifier for a particular sale channel.","schema":{"type":"integer"},"required":true}],"responses":{"200":{"description":"Response status_code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ZoneResponse"},"example":{"success":true,"status_code":200,"zone_id":"64809f27f2b8f575d5cb9c56"}}}},"400":{"description":"Bad request. See the error object in the response body for specific reason","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceabilityErrorResponse"},"examples":{"Zone Already Exists with Given Slug":{"$ref":"#/components/examples/ZoneAlreadyExistsError"},"Two same overlapping regions":{"$ref":"#/components/examples/ZoneRegionConflictError"},"Overlapping regions with another sales chnanel":{"$ref":"#/components/examples/ZoneOverlappingRegionError"}}}}}}}},"/service/platform/logistics/v2.0/company/{company_id}/zones/{zone_id}":{"put":{"summary":"updateZoneById | Update details of a Zone","description":"Updates the region, application, store mapping and other details in the Zone.","tags":["Serviceability"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateZoneData"},"examples":{"Gujarat and Haryana Zone":{"$ref":"#/components/examples/UpdateZoneByIdGujaratHaryanaExample"}}}}},"parameters":[{"in":"path","name":"company_id","description":"A `company_id` is a unique identifier for a particular sale channel.","schema":{"type":"integer"},"required":true,"examples":{"Test Company":{"value":"1"}}},{"in":"path","name":"zone_id","description":"A `zone_id` is a unique identifier for a particular zone.","schema":{"type":"string"},"examples":{"Test Zone":{"value":"64d22858f8aafe61d79f07ea"}},"required":true}],"responses":{"200":{"description":"Response status_code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ZoneSuccessResponse"}}}},"400":{"description":"Bad request. See the error object in the response body for specific reason","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceabilityErrorResponse"}}}}}},"get":{"summary":"getZoneById | Get details of the Zone","description":"Returns the region, application, store mapping and other details in the Zone.","tags":["Serviceability"],"parameters":[{"in":"path","name":"company_id","description":"A `company_id` is a unique identifier for a particular sale channel.","schema":{"type":"integer"},"required":true,"examples":{"Test Company":{"value":"1"}}},{"in":"path","name":"zone_id","description":"A `zone_id` is a unique identifier for a particular zone.","schema":{"type":"string"},"examples":{"Test Zone":{"value":"64d22858f8aafe61d79f07ea"}},"required":true}],"responses":{"200":{"description":"Get details of the Zone","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetZoneByIdSchema"},"examples":{"Gujarat Zone":{"$ref":"#/components/examples/GetZoneByIdValidZoneResponse"}}}}},"400":{"description":"Bad request. See the error object in the response body for specific reason","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceabilityErrorResponse"}}}}}}},"/service/platform/logistics/v1.0/company/{company_id}/logistics/stores":{"get":{"summary":"getAllStores | GET stores data","description":"This API returns stores data.","tags":["Serviceability"],"deprecated":true,"parameters":[{"in":"path","name":"company_id","description":"A `company_id` is a unique identifier for a particular sale channel.","schema":{"type":"integer"},"required":true}],"responses":{"200":{"description":"Response status_code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetStoresViewResponse"}}}}}}},"/service/platform/logistics/v1.0/company/{company_id}/reassign":{"post":{"summary":"getOptimalLocations | Get serviceable store of the item","description":"This API returns serviceable store of the item.","tags":["Serviceability"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReAssignStoreRequest"}}}},"parameters":[{"in":"path","name":"company_id","description":"A `company_id` is a unique identifier for a particular sale channel.","schema":{"type":"integer"},"required":true}],"responses":{"200":{"description":"Response status_code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReAssignStoreResponse"}}}}}}},"/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/pincode-mop-update":{"post":{"summary":"updatePincodeMopView | PincodeView update of MOP.","description":"This API updates Pincode method of payment.","tags":["Serviceability"],"parameters":[{"in":"path","name":"company_id","description":"A `company_id` is a unique identifier for a particular seller account.","schema":{"type":"integer"},"required":true},{"in":"path","name":"application_id","description":"A `application_id` is a unique identifier for a particular sale channel.","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PincodeMopData"}}}},"responses":{"200":{"description":"Response Data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PincodeMOPresponse"}}}},"400":{"description":"Response status_code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonError"}}}}}}},"/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/pincode-mop-bulk-update":{"post":{"summary":"updatePincodeBulkView | Bulk Update of pincode in the application.","description":"This API constructs bulk write operations to update the MOP data for each pincode in the payload.","tags":["Serviceability"],"parameters":[{"in":"path","name":"company_id","description":"A `company_id` is a unique identifier for a particular seller account.","schema":{"type":"string"},"required":true},{"in":"path","name":"application_id","description":"A `application_id` is a unique identifier for a particular sale channel.","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PincodeMopBulkData"}}}},"responses":{"200":{"description":"Response Data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PincodeBulkViewResponse"},"example":{"batch_id":"string","s3_url":"string"}}}},"400":{"description":"Response status_code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonError"}}}}}}},"/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/pincode-mop-data":{"post":{"summary":"updatePincodeCoDListing | Pincode count view of application.","description":"This API returns count of active pincode.","tags":["Serviceability"],"parameters":[{"in":"path","name":"company_id","description":"A `company_id` is a unique identifier for a particular seller account.","schema":{"type":"string"},"required":true},{"in":"path","name":"application_id","description":"A `application_id` is a unique identifier for a particular sale channel.","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PincodeCodStatusListingRequest"}}}},"responses":{"200":{"description":"Response Data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PincodeCodStatusListingResponse"}}}},"400":{"description":"Response status_code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonError"}}}}}}},"/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/history":{"post":{"summary":"updatePincodeAuditHistory | Auditlog configuration of application.","description":"This API returns Audit logs of Pincode.","tags":["Serviceability"],"parameters":[{"in":"path","name":"company_id","description":"A `company_id` is a unique identifier for a particular seller account.","schema":{"type":"string"},"required":true},{"in":"path","name":"application_id","description":"A `application_id` is a unique identifier for a particular sale channel.","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PincodeMopUpdateAuditHistoryRequest"}}}},"responses":{"200":{"description":"Response Data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PincodeMopUpdateAuditHistoryResponseData"}}}},"400":{"description":"Response status_code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonError"}}}}}}},"/service/platform/logistics/v1.0/company/{company_id}/courier-partner/account":{"post":{"summary":"createCourierPartnerAccount | Creation of Courier Account","description":"This API Creates a new Courier Account","tags":["Serviceability"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CourierAccount"}}}},"parameters":[{"in":"path","name":"company_id","description":"A `company_id` is a unique identifier for a particular sale channel.","schema":{"type":"integer"},"required":true}],"responses":{"200":{"description":"Response status_code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CourierAccount"}}}},"400":{"description":"Bad request. See the error object in the response body for specific reason","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CourierPartnerAccountFailureResponse"}}}}}},"get":{"summary":"getCourierPartnerAccounts | Getting Courier Account list of a company.","description":"This API returns Courier Account of a company.","tags":["Serviceability"],"parameters":[{"in":"path","name":"company_id","description":"A `company_id` is a unique identifier for a particular sale channel.","schema":{"type":"integer"},"required":true},{"in":"query","name":"page_no","description":"index of the item to start returning with","schema":{"type":"integer","default":1,"minimum":1}},{"in":"query","name":"page_size","description":"determines the items to be displayed in a page","schema":{"type":"integer","default":10,"minimum":1}},{"in":"query","name":"stage","description":"stage of the account. enabled/disabled","schema":{"type":"string"}},{"in":"query","name":"payment_mode","description":"Filters dp accounts based on payment mode","schema":{"type":"string"}},{"in":"query","name":"transport_type","description":"Filters dp accounts based on transport_type","schema":{"type":"string"}}],"responses":{"200":{"description":"Response status_code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyCourierPartnerAccountListResponse"}}}},"400":{"description":"Bad request. See the error object in the response body for specific reason","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CourierPartnerAccountFailureResponse"}}}}}}},"/service/platform/logistics/v1.0/company/{company_id}/courier-partner/account/{account_id}":{"put":{"summary":"updateCourierPartnerAccount | Update Courier Account in database.","description":"Updates Courier Account","tags":["Serviceability"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CourierAccount"}}}},"parameters":[{"in":"path","name":"company_id","description":"A `company_id` is a unique identifier for a particular sale channel.","schema":{"type":"integer"},"required":true},{"in":"path","name":"account_id","description":"Unique ID of courier account","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Response status_code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CourierAccountResponse"}}}},"400":{"description":"Bad request. See the error object in the response body for specific reason","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CourierPartnerAccountFailureResponse"}}}}}},"get":{"summary":"getCourierPartnerAccount | Getting Courier Account of a company from database.","description":"This API returns response DpAccount of a company from mongo database.","tags":["Serviceability"],"parameters":[{"in":"path","name":"company_id","description":"A `company_id` is a unique identifier for a particular sale channel.","schema":{"type":"integer"},"required":true},{"in":"path","name":"account_id","description":"Unique ID of courier account","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Response status_code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CourierAccountResponse"}}}},"400":{"description":"Bad request. See the error object in the response body for specific reason","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CourierPartnerAccountFailureResponse"}}}}}}},"/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/courier-partner/rules/{rule_id}":{"put":{"summary":"updateCourierRule | Updating of Courier Rule.","description":"This API updates and returns Courier Rule.","tags":["Serviceability"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CourierPartnerRule"}}}},"parameters":[{"in":"path","name":"company_id","description":"A `company_id` is a unique identifier for a particular sale channel.","schema":{"type":"integer"},"required":true},{"in":"path","name":"application_id","description":"Unique Identifier of sales channel","schema":{"type":"string"},"required":true},{"in":"path","name":"rule_id","description":"A `rule_id` is a unique identifier for a particular Dp.","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Response status_code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CourierPartnerRule"}}}},"400":{"description":"Bad request. See the error object in the response body for specific reason","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FailureResponse"}}}}}},"get":{"summary":"getCourierPartnerRule | Fetch of Courier Rule.","description":"This API returns Courier Rule.","tags":["Serviceability"],"parameters":[{"in":"path","name":"company_id","description":"A `company_id` is a unique identifier for a particular sale channel.","schema":{"type":"integer"},"required":true},{"in":"path","name":"application_id","description":"Unique Identifier of sales channel","schema":{"type":"string"},"required":true},{"in":"path","name":"rule_id","description":"A `rule_id` is a unique identifier for a rule.","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Response status_code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CourierPartnerRule"}}}},"400":{"description":"Bad request. See the error object in the response body for specific reason","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FailureResponse"}}}}}}},"/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/courier-partner/rules":{"post":{"summary":"createCourierPartnerRule | Create Courier Rules.","description":"Creates Courier Rules with rule configuration and dp priority","tags":["Serviceability"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CourierPartnerRule"}}}},"parameters":[{"in":"path","name":"company_id","description":"A `company_id` is a unique identifier for a particular sale channel.","schema":{"type":"integer"},"required":true},{"in":"path","name":"application_id","description":"Unique Identifier of sales channel","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Response status_code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CourierPartnerRule"}}}},"400":{"description":"Bad request. See the error object in the response body for specific reason","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FailureResponse"}}}}}},"get":{"summary":"getCourierPartnerRules | Fetch Courier Rules List","description":"This API returns Courier Rules List","tags":["Serviceability"],"parameters":[{"in":"path","name":"company_id","description":"A `company_id` is a unique identifier for a particular sale channel.","schema":{"type":"integer"},"required":true},{"in":"path","name":"application_id","description":"Unique Identifier of sales channel","schema":{"type":"string"},"required":true},{"in":"query","name":"page_no","description":"index of the item to start returning with","schema":{"type":"integer","default":1,"minimum":1}},{"in":"query","name":"page_size","description":"determines the items to be displayed in a page","schema":{"type":"integer","default":10,"minimum":1}},{"in":"query","name":"status","description":"Filter rules based on rule status","schema":{"type":"string","enum":[true,false]}}],"responses":{"200":{"description":"Response status_code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CourierPartnerRulesListResponse"}}}},"400":{"description":"Bad request. See the error object in the response body for specific reason","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FailureResponse"}}}}}}},"/service/platform/logistics/v1.0/company/{company_id}/configuration":{"put":{"summary":"updateCompanyConfiguration | Apply Courier Rule to company.","description":"Apply Courier Rule to company with rules priority","tags":["Serviceability"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyConfig"}}}},"parameters":[{"in":"path","name":"company_id","description":"A `company_id` is a unique identifier for a particular sale channel.","schema":{"type":"integer"},"required":true}],"responses":{"200":{"description":"Response status_code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyConfig"}}}},"400":{"description":"Bad request. See the error object in the response body for specific reason","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FailureResponse"}}}}}},"get":{"summary":"getCompanyConfiguration | Get All Courier Rules applied to company.","description":"This API returns all Courier Rules applied for company.","tags":["Serviceability"],"parameters":[{"in":"path","name":"company_id","description":"A `company_id` is a unique identifier for a particular sale channel.","schema":{"type":"integer"},"required":true}],"responses":{"200":{"description":"Response status_code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyConfig"}}}},"400":{"description":"Bad request. See the error object in the response body for specific reason","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FailureResponse"}}}}}}},"/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/configuration":{"put":{"summary":"updateApplicationConfiguration | Apply configuration to an application","description":"Apply configuration to application to set DP rules and Zone configuration","tags":["Serviceability"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationConfig"},"examples":{"Enable zone-based serviceability":{"value":{"zones":{"serviceability_type":"zone-based"}}}}}}},"parameters":[{"in":"path","name":"company_id","description":"A `company_id` is a unique identifier of company.","schema":{"type":"integer"},"required":true},{"in":"path","name":"application_id","description":"A `application_id` is a unique identifier of sales channel.","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Response status_code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationConfig"}}}},"400":{"description":"Bad request. See the error object in the response body for specific reason","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FailureResponse"}}}}}},"get":{"summary":"getApplicationConfiguration | Get All Courier Rules applied to application","description":"This API returns all the Courier Rules applied to an application","tags":["Serviceability"],"parameters":[{"in":"path","name":"company_id","description":"A `company_id` is a unique identifier of company.","schema":{"type":"integer"},"required":true},{"in":"path","name":"application_id","description":"A `application_id` is a unique identifier of a sales channel.","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Response status_code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationConfig"}}}},"400":{"description":"Bad request. See the error object in the response body for specific reason","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FailureResponse"}}}}}}},"/service/platform/logistics/v1.0/company/{company_id}/courier-partner/{extension_id}/scheme/{scheme_id}/tat":{"post":{"summary":"bulkTat | Region TAT Import or Export","description":"Region TAT Import or Export","tags":["Serviceability"],"parameters":[{"in":"path","name":"company_id","description":"A `company_id` is a unique identifier for a particular sale channel.","schema":{"type":"integer"},"required":true},{"in":"path","name":"extension_id","description":"Unique Identifier of CP Extension","schema":{"type":"string"},"required":true},{"in":"path","name":"scheme_id","description":"Unique identifier of a scheme","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkRegionJobSerializer"}}}},"responses":{"200":{"description":"Response status_code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkRegionResponseItemData"}}}}}},"get":{"summary":"getBulkTat | Get region tat bulk history","description":"Get region tat bulk history","tags":["Serviceability"],"parameters":[{"in":"path","name":"company_id","description":"A `company_id` is a unique identifier for a particular sale channel.","schema":{"type":"integer"},"required":true},{"in":"path","name":"extension_id","description":"Unique Identifier of CP Extension","schema":{"type":"string"},"required":true},{"in":"path","name":"scheme_id","description":"Unique identifier of a scheme","schema":{"type":"string"},"required":true},{"in":"query","name":"page_no","description":"index of the item to start returning with","schema":{"type":"integer","default":1,"minimum":1}},{"in":"query","name":"page_size","description":"determines the items to be displayed in a page","schema":{"type":"integer","default":12,"minimum":1}},{"in":"query","name":"batch_id","description":"Unique identifier of bulk job","schema":{"type":"string"}},{"in":"query","name":"action","description":"import or export bulk type","schema":{"type":"string"}},{"in":"query","name":"status","description":"Status of the bulk actions","schema":{"type":"string"}},{"in":"query","name":"country","description":"Country for which bulk job is initiated","schema":{"type":"string"}},{"in":"query","name":"region","description":"Region for which bulk job is initiated","schema":{"type":"string"}},{"in":"query","name":"start_date","description":"Fetch job history after a particule date","example":"2023-08-03","schema":{"type":"string"}},{"in":"query","name":"end_date","description":"Fetch job history before a particule date","example":"2023-08-03","schema":{"type":"string"}}],"responses":{"200":{"description":"Response status_code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkRegionResponse"}}}}}}},"/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/selfship":{"patch":{"summary":"patchApplicationServiceabilitySelfShipment | Self-ship configuration of application.","description":"This API updates Self-ship configuration of the application.","tags":["Serviceability"],"parameters":[{"name":"company_id","in":"path","description":"A `company_id` is a unique identifier for a particular seller account.","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"A `application_id` is a unique identifier for a particular sale channel.","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SelfShipResponse"},"example":{"is_active":true,"tat":172800}}}},"responses":{"200":{"description":"Response Data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationSelfShipConfigResponse"},"example":{"data":{"is_active":true,"tat":3},"success":true,"error":{"type":"","value":"","message":""}}}}},"400":{"description":"Bad request. See the error object in the response body for specific reason","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationSelfShipConfigResponse"},"example":{"data":{"is_active":true,"tat":-1},"success":false,"error":{"type":"ValidationError","value":"1","message":"Invalid value!"}}}}}}},"get":{"summary":"getApplicationServiceabilitySelfShipment | Self-ship configuration of application.","description":"This API returns Self-ship configuration of the application.","tags":["Serviceability"],"parameters":[{"name":"company_id","in":"path","description":"A `company_id` is a unique identifier for a particular seller account.","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"A `application_id` is a unique identifier for a particular sale channel.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Response Data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationSelfShipConfigResponse"},"example":{"data":{"is_active":true,"tat":3},"success":true,"error":{"type":"","value":"","message":""}}}}},"400":{"description":"Bad request. See the error object in the response body for specific reason","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationSelfShipConfigResponse"},"example":{"data":{"is_active":false,"tat":null},"success":false,"error":{"type":"NotFound","value":"1","message":"Application 000000001 does not exists!"}}}}}}}},"/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/store/configuration":{"get":{"summary":"getApplicationConfig | Get Application Configuration","description":"Get Application Configuration","tags":["Serviceability"],"parameters":[{"in":"path","name":"company_id","description":"A `company_id` is a unique identifier for a particular sale channel.","schema":{"type":"integer"},"required":true},{"in":"path","name":"application_id","description":"A `application_id` is a unique identifier for a particular application channel.","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreRuleConfigData"}}}},"400":{"description":"Error Response","content":{"application/json":{"schema":{"properties":{"success":{"type":"boolean"},"error":{"items":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}},"post":{"summary":"insertApplicationConfig | Insert Application Configuration","description":"Insert Application Configuration","tags":["Serviceability"],"parameters":[{"in":"path","name":"company_id","description":"A `company_id` is a unique identifier for a particular sale channel.","schema":{"type":"integer"},"required":true},{"in":"path","name":"application_id","description":"A `application_id` is a unique identifier for a particular application channel.","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreRuleConfigData"}}}},"responses":{"200":{"description":"Response status_code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreRuleConfigData"}}}},"400":{"description":"Error Response","content":{"application/json":{"schema":{"properties":{"success":{"type":"boolean"},"error":{"items":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}},"put":{"summary":"updateStoreRulesConfig | Update Store Rule Configuration","description":"Update Store Rule Configuration","tags":["Serviceability"],"parameters":[{"in":"path","name":"company_id","description":"A `company_id` is a unique identifier for a particular sale channel.","schema":{"type":"integer"},"required":true},{"in":"path","name":"application_id","description":"A `application_id` is a unique identifier for a particular application channel.","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreRuleConfigData"}}}},"responses":{"200":{"description":"Response status_code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreRuleConfigData"}}}},"400":{"description":"Error Response","content":{"application/json":{"schema":{"properties":{"success":{"type":"boolean"},"error":{"items":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}},"/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/store/rules":{"get":{"summary":"getStoreRules | Get Multiple Store Rules","description":"Get Multiple Store Rules","tags":["Serviceability"],"parameters":[{"in":"path","name":"company_id","description":"A `company_id` is a unique identifier for a particular sale channel.","schema":{"type":"integer"},"required":true},{"in":"path","name":"application_id","description":"A `application_id` is a unique identifier for a particular application channel.","schema":{"type":"string"},"required":true},{"in":"query","name":"page_no","required":false,"schema":{"type":"integer"}},{"in":"query","name":"page_size","required":false,"schema":{"type":"integer"}},{"in":"query","name":"status","required":false,"schema":{"type":"string","enum":["true","false","all"]}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetStoreRulesApiResponse"}}}},"400":{"description":"Error Response","content":{"application/json":{"schema":{"properties":{"success":{"type":"boolean"},"error":{"items":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}},"post":{"summary":"createStoreRules | Create Store Rule","description":"Create Store Rule","tags":["Serviceability"],"parameters":[{"in":"path","name":"company_id","description":"A `company_id` is a unique identifier for a particular sale channel.","schema":{"type":"integer"},"required":true},{"in":"path","name":"application_id","description":"A `application_id` is a unique identifier for a particular application channel.","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateStoreRuleRequestSchema"}}}},"responses":{"200":{"description":"Response status_code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreRuleResponseSchema"}}}},"400":{"description":"Error Response","content":{"application/json":{"schema":{"properties":{"success":{"type":"boolean"},"error":{"items":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}},"/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/store/rules/{rule_uid}":{"get":{"summary":"getStoreRule | Get Single Store Rule","description":"Get Single Store Rule","tags":["Serviceability"],"parameters":[{"in":"path","name":"company_id","description":"A `company_id` is a unique identifier for a particular sale channel.","schema":{"type":"integer"},"required":true},{"in":"path","name":"application_id","description":"A `application_id` is a unique identifier for a particular application channel.","schema":{"type":"string"},"required":true},{"in":"path","name":"rule_uid","description":"A `rule_uid` is a unique identifier for a particular rule object.","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreRuleDataSchema"}}}},"400":{"description":"Error Response","content":{"application/json":{"schema":{"properties":{"success":{"type":"boolean"},"error":{"items":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}},"put":{"summary":"updateStoreRules | Update Store Rule","description":"Update Store Rule","tags":["Serviceability"],"parameters":[{"in":"path","name":"company_id","description":"A `company_id` is a unique identifier for a particular sale channel.","schema":{"type":"integer"},"required":true},{"in":"path","name":"application_id","description":"A `application_id` is a unique identifier for a particular application channel.","schema":{"type":"string"},"required":true},{"in":"path","name":"rule_uid","description":"A `rule_uid` is a unique identifier for a particular rule object.","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateStoreRuleRequestSchema"}}}},"responses":{"200":{"description":"Response status_code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreRuleUpdateResponseSchema"}}}},"400":{"description":"Error Response","content":{"application/json":{"schema":{"properties":{"success":{"type":"boolean"},"error":{"items":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}},"/service/platform/logistics/v1.0/company/{company_id}/courier-partner/{extension_id}/scheme/{scheme_id}/serviceability/bulk":{"post":{"summary":"bulkServiceability | Serviceability Import or Export","description":"Serviceability Import or Export","tags":["Serviceability"],"parameters":[{"in":"path","name":"company_id","description":"A `company_id` is a unique identifier for a particular sale channel.","schema":{"type":"integer"},"required":true},{"in":"path","name":"extension_id","description":"Unique Identifier of CP Extension","schema":{"type":"string"},"required":true},{"in":"path","name":"scheme_id","description":"Unique identifier of a scheme","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkRegionJobSerializer"}}}},"responses":{"200":{"description":"Response status_code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkRegionResponseItemData"}}}},"400":{"description":"Failure Response Status","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FailureResponse"}}}}}},"get":{"summary":"getBulkServiceability | Get Region Serviceability Bulk History","description":"Get Region Serviceability Bulk History","tags":["Serviceability"],"parameters":[{"in":"path","name":"company_id","description":"A `company_id` is a unique identifier for a particular sale channel.","schema":{"type":"integer"},"required":true},{"in":"path","name":"extension_id","description":"Unique Identifier of CP Extension","schema":{"type":"string"},"required":true},{"in":"path","name":"scheme_id","description":"Unique identifier of a scheme","schema":{"type":"string"},"required":true},{"in":"query","name":"page_no","description":"index of the item to start returning with","schema":{"type":"integer","default":1,"minimum":1}},{"in":"query","name":"page_size","description":"determines the items to be displayed in a page","schema":{"type":"integer","default":12,"minimum":1}},{"in":"query","name":"batch_id","description":"Unique identifier of bulk job","schema":{"type":"string"}},{"in":"query","name":"action","description":"import or export bulk type","schema":{"type":"string"}},{"in":"query","name":"status","description":"Status of the bulk actions","schema":{"type":"string"}},{"in":"query","name":"country","description":"Country for which bulk job is initiated","schema":{"type":"string"}},{"in":"query","name":"region","description":"Region for which bulk job is initiated","schema":{"type":"string"}},{"in":"query","name":"start_date","description":"Fetch job history after a particule date","example":"2023-08-03","schema":{"type":"string"}},{"in":"query","name":"end_date","description":"Fetch job history before a particule date","example":"2023-08-03","schema":{"type":"string"}}],"responses":{"200":{"description":"Response status_code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkRegionResponse"}}}}}}},"/service/platform/logistics/v1.0/company/{company_id}/courier-partner/{extension_id}/scheme/{scheme_id}/serviceability/region/{region_id}":{"get":{"summary":"getServiceability | Get Serviceability of a region","description":"Get Serviceability of a region","tags":["Serviceability"],"parameters":[{"in":"path","name":"company_id","description":"A `company_id` is a unique identifier for a particular sale channel.","schema":{"type":"integer"},"required":true},{"in":"path","name":"extension_id","description":"Unique Identifier of CP Extension","schema":{"type":"string"},"required":true},{"in":"path","name":"scheme_id","description":"Unique identifier of a scheme","schema":{"type":"string"},"required":true},{"in":"path","name":"region_id","description":"Unique identifier of a region","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Response status_code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceabilityModel"}}}},"400":{"description":"Response status_code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FailureResponse"}}}}}},"put":{"summary":"updateServiceability | Serviceability Update for a region","description":"Serviceability Update for a region","tags":["Serviceability"],"parameters":[{"in":"path","name":"company_id","description":"A `company_id` is a unique identifier for a particular sale channel.","schema":{"type":"integer"},"required":true},{"in":"path","name":"extension_id","description":"Unique Identifier of CP Extension","schema":{"type":"string"},"required":true},{"in":"path","name":"scheme_id","description":"Unique identifier of a scheme","schema":{"type":"string"},"required":true},{"in":"path","name":"region_id","description":"Unique identifier of a region","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceabilityModel"}}}},"responses":{"200":{"description":"Response status_code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceabilityModel"}}}},"400":{"description":"Failure Response Status","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FailureResponse"}}}}}}},"/service/platform/logistics/v1.0/company/{company_id}/packaging-materials":{"post":{"summary":"createPackageMaterial | Upsert of PackageMaterial in database.","description":"This API returns response of upsert of PackageMaterial in mongo database.","tags":["Serviceability"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PackageMaterial"}}}},"parameters":[{"in":"path","name":"company_id","description":"A `company_id` is a unique identifier for a particular seller.","schema":{"type":"integer"},"required":true}],"responses":{"201":{"description":"Response status_code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PackageMaterialResponse"},"examples":{"PackageMaterial":{"$ref":"#/components/examples/PackageMaterial"}}}}},"400":{"description":"Bad request. See the error object in the response body for specific reason","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceabilityErrorResponse"}}}}}},"get":{"summary":"getPackageMaterialList | Fetching of PackageMaterials from database.","description":"This API returns response of PackageMaterials from mongo database.","tags":["Serviceability"],"parameters":[{"in":"path","name":"company_id","description":"A `company_id` is a unique identifier for a particular sale channel.","schema":{"type":"integer"},"required":true},{"in":"query","name":"page_no","description":"index of the item to start returning with","schema":{"type":"integer","default":1,"minimum":1}},{"in":"query","name":"page_size","description":"determines the items to be displayed in a page","schema":{"type":"integer","default":10,"minimum":1}},{"in":"query","name":"q","description":"perform regex search on items matching name for given value","schema":{"type":"string"}},{"in":"query","name":"size","description":"filters items based on given size","schema":{"type":"string"}},{"in":"query","name":"package_type","description":"filters items based on given package_type","schema":{"type":"string"}}],"responses":{"200":{"description":"Response status_code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PackageMaterialList"},"examples":{"PackageMaterialList":{"$ref":"#/components/examples/PackageMaterialList"}}}}},"400":{"description":"Bad request. See the error object in the response body for specific reason","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceabilityErrorResponse"}}}}}}},"/service/platform/logistics/v1.0/company/{company_id}/packaging-material/rules":{"post":{"summary":"createPackageMaterialRule | Upsert of Package Material Rule in database.","description":"This API returns response of upsert of Package Material Rule in mongo database.","tags":["Serviceability"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PackageRule"}}}},"parameters":[{"in":"path","name":"company_id","description":"A `company_id` is a unique identifier for a particular seller.","schema":{"type":"integer"},"required":true}],"responses":{"201":{"description":"Response status_code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PackageRuleResponse"},"examples":{"PackageRule":{"$ref":"#/components/examples/PackageRule"}}}}},"400":{"description":"Bad request. See the error object in the response body for specific reason","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceabilityErrorResponse"}}}}}},"get":{"summary":"getPackageMaterialRules | Fetching of Package Material Rules from database.","description":"This API returns response of Package Materials Rules from mongo database.","tags":["Serviceability"],"parameters":[{"in":"path","name":"company_id","description":"A `company_id` is a unique identifier for a particular sale channel.","schema":{"type":"integer"},"required":true},{"in":"query","name":"page_no","description":"index of the item to start returning with","schema":{"type":"integer","default":1,"minimum":1}},{"in":"query","name":"page_size","description":"determines the items to be displayed in a page","schema":{"type":"integer","default":10,"minimum":1}},{"in":"query","name":"is_active","description":"filters items based on given is_active","schema":{"type":"string"}}],"responses":{"200":{"description":"Response status_code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PackageMaterialRuleList"},"examples":{"PackageMaterialRuleList":{"$ref":"#/components/examples/PackageMaterialRuleList"}}}}},"400":{"description":"Bad request. See the error object in the response body for specific reason","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceabilityErrorResponse"}}}}}}},"/service/platform/logistics/v1.0/company/{company_id}/packaging-material/rules/{rule_id}":{"patch":{"summary":"updatePackageMaterialRule | Fetching of Package Material Rules into database.","description":"This API updates Package Material Rules into mongo database.","tags":["Serviceability"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PackageRule"}}}},"parameters":[{"in":"path","name":"company_id","description":"A `company_id` is a unique identifier for a particular seller.","schema":{"type":"integer"},"required":true},{"in":"path","name":"rule_id","description":"A `package_material_rule_id` is a unique identifier for a Package Material Rule","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Response status_code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PackageRuleResponse"},"examples":{"PackageRule":{"$ref":"#/components/examples/PackageRule"}}}}},"400":{"description":"Bad request. See the error object in the response body for specific reason","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceabilityErrorResponse"}}}}}},"get":{"summary":"getPackageMaterialRule | Fetching of Package Material from database.","description":"This API returns response of Package Material from mongo database.","tags":["Serviceability"],"parameters":[{"in":"path","name":"company_id","description":"A `company_id` is a unique identifier for a particular sale channel.","schema":{"type":"integer"},"required":true},{"in":"path","name":"rule_id","description":"A `package_material_rule_id` is a unique identifier for a Package Material Rule","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Response status_code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PackageRuleResponse"},"examples":{"PackageRule":{"$ref":"#/components/examples/PackageRule"}}}}},"400":{"description":"Bad request. See the error object in the response body for specific reason","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceabilityErrorResponse"}}}}}}},"/service/platform/logistics/v1.0/company/{company_id}/packaging-material/{package_material_id}":{"patch":{"summary":"updatePackageMaterials | Update Package Material to database.","description":"This API updates Package Materials from into mongo database.","tags":["Serviceability"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PackageMaterial"}}}},"parameters":[{"in":"path","name":"company_id","description":"A `company_id` is a unique identifier for a particular seller.","schema":{"type":"integer"},"required":true},{"in":"path","name":"package_material_id","description":"A `package_material_id` is a unique identifier for a Package Material","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Response status_code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PackageMaterialResponse"},"examples":{"PackageMaterial":{"$ref":"#/components/examples/PackageMaterial"}}}}},"400":{"description":"Bad request. See the error object in the response body for specific reason","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceabilityErrorResponse"}}}}}},"get":{"summary":"getPackageMaterials | Fetching of Package Material from database.","description":"This API returns response of Package Material from mongo database.","tags":["Serviceability"],"parameters":[{"in":"path","name":"company_id","description":"A `company_id` is a unique identifier for a particular sale channel.","schema":{"type":"integer"},"required":true},{"in":"path","name":"package_material_id","description":"A `package_material_id` is a unique identifier for a Package Material","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Response status_code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PackageMaterialResponse"}}}},"400":{"description":"Bad request. See the error object in the response body for specific reason","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceabilityErrorResponse"}}}}}}},"/service/platform/logistics/v1.0/company/{company_id}/application/{application_id}/courier-partner/rules/priority":{"put":{"summary":"updateCourierPartnerRulePriority | Updates Courier Partner Rules Priority for a sales channel","description":"Updates Courier Partner Rules Priority for a sales channel","tags":["Serviceability"],"parameters":[{"in":"path","name":"company_id","description":"A `company_id` is a unique identifier for a particular sale channel.","schema":{"type":"integer"},"required":true},{"in":"path","name":"application_id","description":"A `application_id` is a unique identifier for a particular application channel.","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RulePriorityRequest"}}}},"responses":{"200":{"description":"Response status_code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RulePriorityResponse"}}}},"400":{"description":"Error Response","content":{"application/json":{"schema":{"properties":{"success":{"type":"boolean"},"error":{"items":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}},"/service/platform/order-manage/v1.0/company/{company_id}/update-cache":{"put":{"tags":["Order"],"description":"Invalidate shipment Cache","parameters":[{"in":"path","name":"company_id","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"Shipment Ids to clear cache!. NOTE Must pass one of the three Field, which then clear the shipment cached data. This api will use only one of the fields passed even if you pass all. Priority Order (shipment_ids > affiliate_bag_ids > bag_ids)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidateShipmentCachePayload"},"example":{"shipment_ids":["16838049724111283577","16836368409661507353","16830062656481252150"],"affiliate_bag_ids":["88408518506","721862"],"bag_ids":["724966","721862"]}}}},"responses":{"200":{"description":"Successfully updated shipment cache!","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidateShipmentCacheResponse"},"example":{"response":[{"message":"Shipment sync initiated","status":200,"shipment_id":"16838049724111283577","error":""},{"message":"Cannot update cache if shipment in pending, payment_failed or awaiting_payment_confirmation","status":400,"shipment_id":"16836368409661507353","error":""},{"message":"Problem while deleting the cache","status":500,"shipment_id":"16838049724111283577","error":"Internal Exception"}]}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"message":"shipment_ids or affiliate_bag_ids or bag_ids in post params is mandatory","success":false,"status":400}}}},"5XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error_trace":"Exception Trace","message":"Exception","success":false,"status":500}}}}},"security":[{"applicationId":[],"applicationToken":[]}],"summary":"invalidateShipmentCache | undefined"}},"/service/platform/order-manage/v1.0/company/{company_id}/store/reassign-internal":{"post":{"tags":["Order"],"description":"Reassign Location","parameters":[{"in":"path","name":"company_id","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreReassign"}}}},"responses":{"200":{"description":"Successfully reassigned location!","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreReassignResponse"}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"applicationId":[],"applicationToken":[]}],"summary":"reassignLocation | undefined"}},"/service/platform/order-manage/v1.0/company/{company_id}/entity/lock-manager":{"post":{"tags":["Order"],"description":"update shipment/bag lock and check status","parameters":[{"in":"path","name":"company_id","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateShipmentLockPayload"},"example":{"action_type":"operational","action":"check","resume_tasks_after_unlock":true,"entity_type":"shipments","user_id":"5f23c85bf4439a812561443a","entities":[{"id":"16189206454951802898","reason_text":"received reply from ajio"}]}}}},"responses":{"200":{"description":"Successfully update the Lock and get check status of the shipment/Bag","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateShipmentLockResponse"},"example":{"success":true,"message":"shipments checked successfully","check_response":[{"bags":[{"bag_id":175644,"is_locked":false,"affiliate_bag_id":"def134","affiliate_order_id":"def134"}],"lock_status":"complete","is_bag_locked":false,"is_shipment_locked":true,"shipment_id":"16189206454951802898","affiliate_id":"5c764a6534add21972ef7b08","affiliate_shipment_id":"def134","original_filter":{"shipment_id":"16189206454951802898"},"status":"dp_assigned"}]}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"success":false,"message":"Please provide action as either lock, unlock or check","error":"BAD_REQUEST"}}}}},"security":[{"applicationId":[],"applicationToken":[]}],"summary":"updateShipmentLock | undefined"}},"/service/platform/order-manage/v1.0/company/{company_id}/announcements":{"get":{"tags":["Order"],"description":"Get Announcements","parameters":[{"in":"path","name":"company_id","required":true,"schema":{"type":"integer"}},{"in":"query","name":"date","required":false,"description":"Date On which the announcement is Active (Date should in ISO Datetime format IST Time)","schema":{"type":"string"}}],"responses":{"200":{"description":"Announcements retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnnouncementsResponse"}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"applicationId":[],"applicationToken":[]}],"summary":"getAnnouncements | undefined"}},"/service/platform/order-manage/v1.0/company/{company_id}/delight/update-address":{"post":{"tags":["Order"],"description":"Update Address for the order","parameters":[{"in":"query","name":"shipment_id","required":true,"schema":{"type":"string"}},{"in":"query","name":"name","required":false,"schema":{"type":"string"}},{"in":"query","name":"address","required":false,"schema":{"type":"string"}},{"in":"query","name":"address_type","required":false,"schema":{"type":"string"}},{"in":"query","name":"pincode","required":false,"schema":{"type":"string"}},{"in":"query","name":"phone","required":false,"schema":{"type":"string"}},{"in":"query","name":"email","required":false,"schema":{"type":"string"}},{"in":"query","name":"landmark","required":false,"schema":{"type":"string"}},{"in":"query","name":"address_category","required":true,"schema":{"type":"string"}},{"in":"query","name":"city","required":false,"schema":{"type":"string"}},{"in":"query","name":"state","required":false,"schema":{"type":"string"}},{"in":"query","name":"country","required":false,"schema":{"type":"string"}},{"in":"path","name":"company_id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Update Address will be processed!","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResponse"}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"applicationId":[],"applicationToken":[]}],"summary":"updateAddress | undefined"}},"/service/platform/order-manage/v1.0/company/{company_id}/ninja/click2call":{"get":{"tags":["Order"],"description":"Click to Call","parameters":[{"in":"query","name":"caller","required":true,"description":"Call Number","schema":{"type":"string"}},{"in":"query","name":"receiver","required":true,"description":"Receiver Number","schema":{"type":"string"}},{"in":"query","name":"bag_id","required":true,"description":"Bag Id for the query","schema":{"type":"string"}},{"in":"query","name":"caller_id","required":false,"description":"Caller Id","schema":{"type":"string"}},{"in":"query","name":"method","required":false,"description":"Provider Method to Call","schema":{"type":"string","example":"dial.click2call"}},{"in":"path","name":"company_id","required":true,"description":"Company Id","schema":{"type":"integer"}}],"responses":{"200":{"description":"Process call on request!","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Click2CallResponse"},"example":{"success":true,"call_id":"c2c_646b00bc-984c-4c10-bb8d-0e850a1e0022"}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorDetail"},"example":{"success":false,"message":"Both `caller` and `receiver` are required"}}}},"5XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorDetail"},"example":{"success":false,"message":"Internal Server Error"}}}}},"security":[{"applicationId":[],"applicationToken":[]}],"summary":"click2Call | undefined"}},"/service/platform/order-manage/v1.0/company/{company_id}/shipment/status-internal":{"put":{"tags":["Order"],"description":"This API is for Shipment State transition or Shipment data update or both below example is for partial state transition with data update","parameters":[{"in":"path","name":"company_id","description":"company id from where are transitioning the shipment state or data","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateShipmentStatusRequest"},"example":{"statuses":[{"shipments":[{"identifier":"16563383008471878029","products":[{"line_number":1,"identifier":"490935564","quantity":20},{"line_number":2,"identifier":"490329852","quantity":20}],"reasons":{"products":[{"filters":[{"identifier":"1adsa2","line_number":1,"quantity":2},{"identifier":"1adsa2","line_number":2,"quantity":2}],"data":{"reason_id":1,"reason_text":""}},{"filters":[{"identifier":"1adsa2","line_number":1,"quantity":10}],"data":{"reason_id":2,"reason_text":""}}],"entities":[{"filters":[{}],"data":{"reason_id":1,"reason_text":""}}]},"data_updates":{"products":[{"filters":[{"identifier":"1234"},{"line_number":12}],"data":{"meta":{"pdf_link":"https://example.com/pdf"}}},{"filters":[{"identifier":"134","line_number":1}],"data":{"meta":{"pdf_link":"https://example.com/pdf"}}}],"entities":[{"filters":[],"data":{"affiliate_shipment_id":"1232323j","meta":{"affiliate_shipment_id":"1232323j"}}}]}}],"status":"bag_confirmed","exclude_bags_next_state":"","split_shipment":false}],"task":true,"force_transition":true,"lock_after_transition":false,"unlock_before_transition":true}}}},"responses":{"200":{"description":"NOTE success response can contains success and failed result as well","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateShipmentStatusResponseBody"},"example":{"statuses":[{"shipments":[{"status":200,"final_state":{"bag_confirmed":"bag_confirmed","shipment_id":"16836279770211860494"},"identifier":"16836279770211860494"}]},{"shipments":[{"status":400,"message":"Invalid State Transition bag_confirmed detected for given entity","code":"","exception":"ValidationError","stack_trace":"","meta":{},"identifier":"16836279770211860494"}]}]}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"status":200,"message":"Internal Server Error","error_trace":"Internal Server Error"}}}}},"security":[{"applicationId":[],"applicationToken":[]}],"summary":"updateShipmentStatus | undefined"}},"/service/platform/order-manage/v1.0/company/{company_id}/roles":{"get":{"tags":["Order"],"description":"Get Role Based Actions","parameters":[{"in":"path","name":"company_id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"You will get an array of actions allowed for that particular user based on their role","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetActionsResponse"},"example":{"permissions":[{"slug":"create_invoice_s3","display_text":"Create Invoice (s3)","id":2,"description":"Create Invoice (s3)"},{"slug":"call","display_text":"Call","id":3,"description":"Call"}]}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"message":"No actions associated with this role.","status":400}}}},"5XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error_trace":"Internal Server Error","message":"Error while Processing the Request: Exception","status":500}}}}},"security":[{"applicationId":[],"applicationToken":[]}],"summary":"getRoleBasedActions | undefined"}},"/service/platform/order-manage/v1.0/company/{company_id}/shipment/history":{"get":{"tags":["Order"],"description":"Get Shipment History","parameters":[{"in":"path","name":"company_id","required":true,"description":"Company Id","schema":{"type":"integer"}},{"in":"query","name":"shipment_id","description":"Shipment Id","required":false,"schema":{"type":"string"}},{"in":"query","name":"bag_id","description":"Bag/Product Id","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"It shows the journey of the shipment!","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShipmentHistoryResponse"},"example":{"activity_history":[{"message":"Bag status changed to pending","store_id":10,"store_code":"SF94","store_name":"shub","reason":{},"createdat":"01 Apr 2022, 17:57:PM","user":"system","type":"activity_status","l1_detail":"","l2_detail":"","l3_detail":"","ticket_id":"","ticket_url":""},{"message":"Bag status changed to placed","store_id":10,"store_code":"SF94","store_name":"shub","reason":{},"createdat":"01 Apr 2022, 17:57:PM","user":"system","type":"activity_status","l1_detail":"","l2_detail":"","l3_detail":"","ticket_id":"","ticket_url":""}]}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"success":false,"message":"Error while getting the shipment history, Error: Internal Server Error","status":400}}}},"5XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"success":false,"message":"Error while getting the shipment history, Error: Internal Server Error","status":500}}}}},"security":[{"applicationId":[],"applicationToken":[]}],"summary":"getShipmentHistory | undefined"},"post":{"tags":["Order"],"description":"Post shipment history","parameters":[{"in":"path","name":"company_id","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostShipmentHistory"},"example":{"activity_history":[{"activity_history":{"data":{"message":"New Message","user_name":"test"},"filters":[{"shipment_id":"123232","line_number":"123232","identifier":"1233232"},{"shipment_id":"123232","line_number":"123232","identifier":"1233232"}]}}]}}}},"responses":{"200":{"description":"It shows the journey of the shipment!","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShipmentHistoryResponse"},"example":{"activity_history":[{"message":"Bag status changed to pending","store_id":10,"store_code":"SF94","store_name":"shub","reason":{},"createdat":"01 Apr 2022, 17:57:PM","user":"system","type":"activity_status","l1_detail":"","l2_detail":"","l3_detail":"","ticket_id":"","ticket_url":""},{"message":"Bag status changed to placed","store_id":10,"store_code":"SF94","store_name":"shub","reason":{},"type":"activity_status","createdat":"01 Apr 2022, 17:57:PM","user":"system","l1_detail":"","l2_detail":"","l3_detail":"","ticket_id":"","ticket_url":""}],"success":true}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorDetail"},"example":{"success":false,"message":"activity_history can't be empty or None","status":400}}}},"5XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorDetail"},"example":{"success":false,"message":"Internal Server Error","status":500}}}}},"summary":"postShipmentHistory | undefined"}},"/service/platform/order-manage/v1.0/company/{company_id}/ninja/send-sms":{"post":{"tags":["Order"],"description":"Send SMS Ninja Panel","parameters":[{"in":"path","name":"company_id","required":true,"description":"Company Id","schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendSmsPayload"},"example":{"bag_id":707952,"slug":"aldaviz-delayed-shipment-event","data":{"country_code":"+91","reason":"","days":1,"phone_number":999999,"message":"Dear  , your order for GLOBUS - FY643952180E5ACCBC8E has been delayed. We are doing our best to get it delivered as soon as possible. You can track your shipment 16814781686521508943 on track.fynd.com. For any queries, please reach out to us on care@fynd.com.","customerName":" ","brandName":"GLOBUS","order_dd":"FY643952180E5ACCBC8E","shipment_id":168147816,"order_id":"16814781686521508943","amount_paid":1100,"payment_mode":"PREPAID"}}}}},"responses":{"200":{"description":"Sms Sent successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderStatusResult"},"example":{"success":"true","message":"Successfully emitted aldaviz-delayed-shipment-event"}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorDetail"},"example":{"success":false,"message":"`slug` and `data` are both required"}}}},"5XX":{"description":"Internal Server Error !!","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorDetail"},"example":{"success":false,"message":"Exception"}}}}},"security":[{"applicationId":[],"applicationToken":[]}],"summary":"sendSmsNinja | undefined"}},"/service/platform/order-manage/v1.0/company/{company_id}/update-packaging-dimension":{"post":{"tags":["Order"],"description":"Update Packaging Dimensions","parameters":[{"in":"path","name":"company_id","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePackagingDimensionsPayload"}}}},"responses":{"200":{"description":"Manifest will be processed!","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePackagingDimensionsResponse"}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"applicationId":[],"applicationToken":[]}],"summary":"updatePackagingDimensions | undefined"}},"/service/platform/order-manage/v1.0/company/{company_id}/create-order":{"post":{"tags":["Order"],"description":"Create Order","parameters":[{"in":"path","name":"company_id","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOrderAPI"}}}},"responses":{"200":{"description":"Successfully created an order!","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOrderResponse"}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOrderErrorReponse"}}}},"5XX":{"description":"Server error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOrderErrorReponse"}}}}},"summary":"createOrder | undefined"}},"/service/platform/order-manage/v1.0/company/{company_id}/order-config":{"get":{"tags":["Order"],"description":"getChannelConfig","parameters":[{"in":"path","name":"company_id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successfully created the config data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateChannelConfigData"},"example":{"config_data":{"payment_info":{"payment_methods":[{"mode":"COD","collect_by":"gringotts","refund_by":"gringotts"}],"source":"fynd","mode_of_payment":"COD"},"dp_configuration":{"shipping_by":"fynd"},"logo_url":{},"location_reassignment":false,"lock_states":["bag_packed"],"shipment_assignment":"16703096324891701814"}}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateChannelConifgErrorResponse"},"example":{"error":"Exception"}}}},"5XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateChannelConifgErrorResponse"},"example":{"error":"Exception"}}}}},"security":[{"applicationId":[],"applicationToken":[]}],"summary":"getChannelConfig | undefined"},"post":{"tags":["Order"],"description":"createChannelConfig","parameters":[{"in":"path","name":"company_id","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateChannelConfigData"},"example":{"config_data":{"payment_info":{"payment_methods":[{"mode":"COD","collect_by":"gringotts","refund_by":"gringotts"}],"source":"fynd","mode_of_payment":"COD"},"dp_configuration":{"shipping_by":"fynd"},"location_reassignment":false,"lock_states":["bag_packed"],"shipment_assignment":"16703096324891701814"}}}}},"responses":{"200":{"description":"Successfully updateShipmentStatus!","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateChannelConfigResponse"},"example":{"data":{"acknowledged":true,"is_upserted":false,"is_inserted":false}}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateChannelConifgErrorResponse"},"example":{"error":"Exception"}}}},"5XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateChannelConifgErrorResponse"},"example":{"error":"Exception"}}}}},"security":[{"applicationId":[],"applicationToken":[]}],"summary":"createChannelConfig | undefined"}},"/service/platform/order-manage/v1.0/company/{company_id}/order/validation":{"put":{"tags":["Order"],"description":"Update Order","parameters":[{"in":"path","name":"company_id","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformOrderUpdate"},"example":{"order_id":"FY6307092F0154033A0K"}}}},"responses":{"200":{"description":"We are processing the order!","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseDetail"}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorDetail"}}}},"5XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorDetail"}}}}},"security":[{"applicationId":[],"applicationToken":[]}],"summary":"orderUpdate | undefined"}},"/service/platform/order-manage/v1.0/company/{company_id}/debug/order_status":{"post":{"tags":["Order"],"description":"Check order status","parameters":[{"in":"path","name":"company_id","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderStatus"}}}},"responses":{"200":{"description":"Order Status retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderStatusResult"}}}}},"security":[{"applicationId":[],"applicationToken":[]}],"summary":"checkOrderStatus | undefined"}},"/service/platform/order-manage/v1.0/company/{company_id}/bag/state/transition":{"get":{"tags":["Order"],"description":"Get State Transition Map","parameters":[{"in":"path","name":"company_id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"State Transition Mapping, for next possible state","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BagStateTransitionMap"},"example":{"fynd":{"placed":["bag_not_confirmed","cancelled_customer","cancelled_fynd","bag_confirmed","store_reassigned"],"bag_confirmed":["handed_over_to_customer","bag_invoiced"],"dp_assigned":["handed_over_to_customer","bag_packed"],"bag_packed":["bag_not_picked","cancelled_customer"],"handed_over_to_dg":["cancelled_at_dp","credit_note_generated"],"out_for_delivery":["delivery_done"],"delivery_done":["bag_lost","return_initiated"],"return_initiated":["return_accepted"],"bag_picked":["refund_completed","out_for_delivery","delivery_done"],"pending":["pending","placed","payment_failed","manual_refund"],"payment_failed":["awaiting_payment_confirmation","placed","manual_refund"],"return_pre_qc":["return_initiated","return_request_cancelled","manual_refund"],"bag_not_packed":["manual_refund"],"bag_rescheduled":["manual_refund"],"fluid_state":["manual_refund"],"handed_over_to_customer":["manual_refund","return_initiated"],"hold":["manual_refund"],"product_not_available":["manual_refund"],"qc_fail":["manual_refund"],"qc_pass":["manual_refund"],"refund_done":["manual_refund"],"refund_processing":["manual_refund"],"return_assigning_dp":["manual_refund"],"return_bag_packed":["manual_refund"],"return_dp_cancelled":["manual_refund"],"unhold":["manual_refund"],"web_store_rescheduled":["manual_refund"],"credit_note_cancelled":["refund_initiated"]},"affiliate":{"placed":["bag_not_confirmed","store_reassigned","product_not_available"],"store_reassigned":["bag_not_confirmed"],"bag_confirmed":["bag_invoiced","cancelled_fynd"],"dp_assigned":["bag_packed"],"pending":["payment_failed","placed","manual_refund"],"ready_for_dp_assignment":["dp_assigned"],"credit_note_generated":["refund_pending","refund_initiated"],"assigning_return_dp":["manual_refund"],"bag_not_packed":["manual_refund"],"bag_rescheduled":["manual_refund"],"fluid_state":["manual_refund"],"handed_over_to_customer":["manual_refund","return_initiated"],"hold":["manual_refund"],"product_not_available":["manual_refund"],"qc_fail":["manual_refund"],"qc_pass":["manual_refund"],"refund_done":["manual_refund"],"refund_processing":["manual_refund"],"return_assigning_dp":["manual_refund"],"return_bag_packed":["manual_refund"],"return_dp_cancelled":["manual_refund"],"unhold":["manual_refund"],"web_store_rescheduled":["manual_refund"],"credit_note_cancelled":["refund_initiated"]}}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorDetail"},"example":{"success":false,"message":"`slug` and `data` are both required"}}}}},"security":[{"applicationId":[],"applicationToken":[]}],"summary":"getStateTransitionMap | undefined"}},"/service/platform/order-manage/v1.0/company/{company_id}/allowed/state/transition":{"get":{"summary":"getAllowedStateTransition | To fetch next state transitions.","description":"This endpoint will fetch next possible states based on logged in user\n","tags":["Order"],"parameters":[{"in":"path","name":"company_id","description":"Company ID","required":true,"schema":{"type":"integer"}},{"in":"query","name":"ordering_channel","description":"Ordering channel","required":true,"schema":{"type":"string"}},{"in":"query","name":"status","description":"current status of a shipment","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Role wise state transition mapping, for next possible state","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoleBaseStateTransitionMapping"},"examples":{"send state transition success":{"value":{"success":true,"next_statuses":["bag_picked","delivery_done","rto_bag_delivered","rto_in_transit"]}}}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorDetail"},"examples":{"send state transition failure":{"value":{"success":false,"message":"`ordering_channel` and `current_status` are both required"}}}}}}},"security":[{"applicationId":[],"applicationToken":[]}]}},"/service/platform/order-manage/v1.0/company/{company_id}/customer-credit-balance":{"post":{"tags":["Order"],"description":"Fetch Credit Balance Detail","parameters":[{"in":"path","name":"company_id","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FetchCreditBalanceRequestPayload"}}}},"responses":{"200":{"description":"Credit Balance will be fetched","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FetchCreditBalanceResponsePayload"}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"applicationId":[],"applicationToken":[]}],"summary":"fetchCreditBalanceDetail | undefined"}},"/service/platform/order-manage/v1.0/company/{company_id}/refund-mode-config":{"post":{"tags":["Order"],"description":"Fetch Refund Mode Config","parameters":[{"in":"path","name":"company_id","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefundModeConfigRequestPayload"}}}},"responses":{"200":{"description":"Refund mode config is returned based on input parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefundModeConfigResponsePayload"}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"applicationId":[],"applicationToken":[]}],"summary":"fetchRefundModeConfig | undefined"}},"/service/platform/order-manage/v1.0/company/{company_id}/user/attach":{"post":{"tags":["Order"],"description":"Attach Order User","parameters":[{"in":"path","name":"company_id","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttachOrderUser"}}}},"responses":{"200":{"description":"Attach user to order","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttachOrderUserResponse"}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"applicationId":[],"applicationToken":[]}],"summary":"attachOrderUser | undefined"}},"/service/platform/order-manage/v1.0/company/{company_id}/user/send/otp/mobile":{"post":{"tags":["Order"],"description":"Send User Mobile OTP","parameters":[{"in":"path","name":"company_id","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendUserMobileOTP"}}}},"responses":{"200":{"description":"Send OTP to user mobile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendUserMobileOtpResponse"},"example":{"success":true,"data":{"request_id":"112312312","message":"Text","resend_timer":600,"mobile":99990000},"message":"Text"}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"applicationId":[],"applicationToken":[]}],"summary":"sendUserMobileOTP | undefined"}},"/service/platform/order-manage/v1.0/company/{company_id}/user/verify/otp":{"post":{"tags":["Order"],"description":"Verify Mobile OTP","parameters":[{"in":"path","name":"company_id","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerifyMobileOTP"}}}},"responses":{"200":{"description":"Verify OTP","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerifyOtpResponse"}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"applicationId":[],"applicationToken":[]}],"summary":"verifyMobileOTP | undefined"}},"/service/platform/order-manage/v1.0/company/{company_id}/reports/lanes/download":{"post":{"tags":["Order"],"description":"downloads lanes shipment/orders.","parameters":[{"in":"path","name":"company_id","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkReportsDownloadRequest"}}}},"responses":{"200":{"description":"Bulk Report creation initiated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkReportsDownloadResponse"},"examples":{"BulkReportsSucessfulEventSample":{"value":{"success":true,"batch_id":"0000-1111-2222-3333"}}}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkFailedResponse"},"examples":{"BulkReportsFailedEventSample":{"value":{"status":false,"error":"Failed to generate the report."}}}}}}},"security":[{"applicationId":[],"applicationToken":[]}],"summary":"downloadLanesReport | undefined"}},"/service/platform/order-manage/v1.0/company/{company_id}/jobs/state-transition":{"post":{"tags":["Order"],"description":"Performs State Transisiton in Bulk for the given shipments in the excel/csv file url.","parameters":[{"in":"path","name":"company_id","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkStateTransistionRequest"}}}},"responses":{"200":{"description":"Bulk State Transistion Sucessfully Initiated Response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkStateTransistionResponse"},"examples":{"BulkReportsSucessfulEventSample":{"value":{"status":true,"message":"Successfully started processing with batch_id: 0000-1111-2222-3333","batch_id":"0000-1111-2222-3333"}}}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkFailedResponse"},"examples":{"BulkReportsFailedEventSample":{"value":{"status":false,"error":"Failed to perform bulk operation."}}}}}}},"security":[{"applicationId":[],"applicationToken":[]}],"summary":"bulkStateTransistion | undefined"}},"/service/platform/order-manage/v1.0/company/{company_id}/jobs":{"get":{"tags":["Order"],"description":"Fetches of previous or running  bulk jobs.\n","parameters":[{"in":"path","name":"company_id","description":"Company ID","required":true,"schema":{"type":"integer"}},{"in":"query","name":"page_size","description":"page size","required":true,"schema":{"type":"integer"}},{"in":"query","name":"page_no","description":"page number","required":true,"schema":{"type":"integer"}},{"in":"query","name":"start_date","description":"UTC start date in ISO format","required":true,"schema":{"type":"string","format":"date-time"}},{"in":"query","name":"end_date","description":"UTC end date in ISO format","required":true,"schema":{"type":"string","format":"date-time"}},{"in":"query","name":"status","description":"status for which to fetch the jobs.","required":false,"schema":{"type":"string"}},{"in":"query","name":"bulk_action_type","description":"job type.","required":false,"schema":{"type":"string"}},{"in":"query","name":"search_key","description":"search_key.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Fetches Bulk Action Listing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkListingResponse"},"examples":{"BulkListingPartiallyCompletedEventSample":{"value":{"success":true,"page":[{"current":1,"has_previous":false,"has_next":false,"total":1,"item_total":1,"type":"number","size":10}],"total_count":1,"data":[{"store_id":1462,"uploaded_on":"2023-09-05T15:01:28+00:00","company_id":2,"shipments_action_info":{"label":[],"invoice":[],"failed_shipments":[{"16938979620571207303":"got error for tag_loops: Field cannot be empty."}],"processing_shipments":[],"successful_shipments":["16939056920921266090","16939056919331910027"],"invoiceable_shipments":[],"failed_invoiced_shipments":{},"processing_invoice_shipments":[],"successful_invoiced_shipments":[]},"is_invoiceable":false,"user_name":"sonalnalawade_gofynd_com_18670","file_url":"https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/misc/general/free/original/fTPuVwPj2-store_reassigned_and_placed_and__1462_1693905700.6916761.xlsx","meta":null,"invoice_document_type":"","file_name":"store_reassigned_and_placed_and__1462_1693905700.6916761.xlsx","store_name":"DK Store","label_document_type":"","updated_ts":1693906287,"status":"PARTIALLY COMPLETED","store_code":"28","bulk_action_type":"order_processing","created_ts":"2023-09-12T06:05:53.395Z","invoice_status":"yet_to_initiate","do_invoice_label_generated":false,"id":340,"user_id":"eaad334a6fc2a3f6fd004e88","last_selected_invoice_label_type":"a4","batch_id":"d2cd3858-a4f2-4faa-bb86-f7dbc228d277","uploaded_by":null,"failed_sh_count":1,"successful_sh_count":2,"total_count":3,"failed_shipments":[{"16938979620571207303":"got error for tag_loops: Field cannot be empty."}],"successful_invoiced_count":0,"failed_invoiced_count":0,"total_invoiced_count":0}]}},"BulkListingCompletedEventSample":{"value":{"success":true,"page":{"current":1,"has_previous":false,"has_next":false,"total":1,"item_total":1,"type":"number","size":10},"total_count":1,"data":[{"store_id":2,"uploaded_on":"2023-09-07T13:10:14+00:00","company_id":2,"shipments_action_info":{"label":[],"invoice":[],"failed_shipments":[],"processing_shipments":[],"successful_shipments":["16940656109321358201","16940123806821572491"],"invoiceable_shipments":[],"failed_invoiced_shipments":{},"processing_invoice_shipments":[],"successful_invoiced_shipments":[]},"is_invoiceable":false,"user_name":"hansrajdeghun_gofynd_com_07968","file_url":"https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/misc/general/free/original/50sqxcYl3-gM0qwREGq-store_reassigned_and_placed_and__2_1694072387.2223.csv","meta":null,"invoice_document_type":"","file_name":"gM0qwREGq-store_reassigned_and_placed_and__2_1694072387.2223.csv","store_name":"Maryam2948442024720231628917","label_document_type":"","updated_ts":1694072414,"status":"COMPLETED","store_code":"Maryam2948442024720231628917","bulk_action_type":"order_processing","created_ts":"2023-09-12T06:05:53.395Z","invoice_status":"yet_to_initiate","do_invoice_label_generated":false,"id":385,"user_id":"a735b8f3fe2200e3de562c63","last_selected_invoice_label_type":"a4","batch_id":"4552cc62-688d-45f3-a5e4-dd5c9367daf0","uploaded_by":null,"failed_sh_count":0,"successful_sh_count":2,"total_count":2,"failed_shipments":[],"successful_invoiced_count":0,"failed_invoiced_count":0,"total_invoiced_count":0}]}},"BulkListingFailedEventSample":{"value":{"success":true,"data":[{"store_id":1,"uploaded_on":"2023-09-07T13:07:13+00:00","company_id":2,"shipments_action_info":{"label":[],"invoice":[],"failed_shipments":[{"all":"due to no of rows being less than 2 or greater than 5000"}],"processing_shipments":[],"successful_shipments":[],"invoiceable_shipments":[],"failed_invoiced_shipments":{},"processing_invoice_shipments":[],"successful_invoiced_shipments":[]},"is_invoiceable":false,"user_name":"hansrajdeghun_gofynd_com_07968","file_url":"https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/misc/general/free/original/1IWqTaL6e-rZjSQ5aR0-store_reassigned_and_placed_and__3935_1694072101.4739661.csv","meta":null,"invoice_document_type":"","file_name":"rZjSQ5aR0-store_reassigned_and_placed_and__3935_1694072101.4739661.csv","store_name":null,"label_document_type":"","updated_ts":1694072233,"status":"FAILED","store_code":null,"bulk_action_type":"order_processing","created_ts":"2023-09-12T06:05:53.395Z","invoice_status":"yet_to_initiate","do_invoice_label_generated":false,"id":384,"user_id":"a735b8f3fe2200e3de562c63","last_selected_invoice_label_type":"a4","batch_id":"219bfed9-6347-4b7f-96cf-9b7f528c57a1","uploaded_by":null,"failed_sh_count":1,"successful_sh_count":0,"total_count":1,"failed_shipments":[{"all":"due to no of rows being less than 2 or greater than 5000"}],"successful_invoiced_count":0,"failed_invoiced_count":0,"total_invoiced_count":0}],"page":{"current":1,"has_previous":false,"has_next":false,"total":1,"item_total":1,"type":"number","size":10},"total_count":1}}}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorDetail"},"examples":{"send state transition failure":{"value":{"success":false,"message":"Invalid request"}}}}}}},"security":[{"applicationId":[],"applicationToken":[]}],"summary":"bulkListing | undefined"}},"/service/platform/order-manage/v1.0/company/{company_id}/jobs/{batch_id}":{"get":{"tags":["Order"],"description":"Fetches details for the job of the provided batch_id","parameters":[{"in":"path","name":"company_id","required":true,"schema":{"type":"integer"}},{"in":"path","name":"batch_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Job details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobDetailsResponse"},"examples":{"JobDetailsSucessfulEventSample":{"value":{"success":true,"data":[{"batch_id":"1dc51db3-89fc-4985-9237-d96efb9060ae","total_shipments_count":1,"successful_shipment_ids":[],"successful_shipments_count":0,"failed_shipments_count":1,"processing_shipments_count":0,"company_id":"2"}],"file_url":"https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/misc/general/free/original/kctNhcXxX-UV71fzH2U-store_reassigned_and_placed_and__3809_1694082156.8009899.csv","failed_records":[{"all":"due to no of rows being less than 2 or greater than 5000"}],"uploaded_by":"mohitmahatme_gofynd_com_31814","user_id":"d7595ec4e390849545a68c92","uploaded_on":"2023-09-07T15:55:24+00:00","status":"FAILED"}}}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkFailedResponse"},"examples":{"BulkFailedResponse":{"value":{"status":false,"error":"no job found against this provided Batch Id."}}}}}}},"security":[{"applicationId":[],"applicationToken":[]}],"summary":"jobDetails | undefined"}},"/service/platform/order-manage/v1.0/company/{company_id}/jobs/{batch_id}/file":{"get":{"tags":["Order"],"description":"Get the file URL consisting Records of the provided status.","parameters":[{"in":"path","name":"company_id","required":true,"schema":{"type":"integer"}},{"in":"path","name":"batch_id","required":true,"schema":{"type":"string"}},{"in":"query","name":"status","required":true,"schema":{"type":"string"}},{"in":"query","name":"file_type","required":true,"schema":{"type":"string","default":"xlsx","enum":["xlsx","csv"]}},{"in":"query","name":"report_type","schema":{"type":"string","default":"generation_report","enum":["generation_report","invoice_report"]}}],"responses":{"200":{"description":"Job details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobFailedResponse"},"examples":{"DetailsForFailedJobResponse":{"value":{"file_name":"failed_reason.csv","url":"www.fynd.com/excelfile.csv"}}}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkFailedResponse"},"examples":{"BulkFailedResponse":{"value":{"status":false,"error":"no job found against this provided Batch Id."}}}}}}},"security":[{"applicationId":[],"applicationToken":[]}],"summary":"getFileByStatus | undefined"}},"/service/platform/order-manage/v1.0/company/{company_id}/manifests/shipments":{"get":{"tags":["Order"],"description":"get Manifest Shipments.","parameters":[{"in":"path","name":"company_id","required":true,"schema":{"type":"integer"}},{"in":"query","name":"dp_ids","required":true,"schema":{"type":"integer"}},{"in":"query","name":"stores","required":true,"schema":{"type":"string"}},{"in":"query","name":"to_date","required":true,"schema":{"type":"string"}},{"in":"query","name":"from_date","required":true,"schema":{"type":"string"}},{"in":"query","name":"dp_name","required":false,"schema":{"type":"string"}},{"in":"query","name":"sales_channels","required":false,"schema":{"type":"string"}},{"in":"query","name":"search_type","required":false,"schema":{"type":"string"}},{"in":"query","name":"search_value","required":false,"schema":{"type":"string"}},{"in":"query","name":"page_no","required":false,"schema":{"type":"string"}},{"in":"query","name":"page_size","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Manifest upload!","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManifestShipmentListing"}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"applicationId":[],"applicationToken":[]}],"summary":"getManifestShipments | undefined"}},"/service/platform/order-manage/v1.0/company/{company_id}/manifests":{"get":{"tags":["Order"],"description":"Fetch Manifests","parameters":[{"in":"path","name":"company_id","required":true,"schema":{"type":"integer"}},{"in":"query","name":"status","required":false,"description":"Possible Status [ active, closed ]","schema":{"type":"string","enum":["active","closed"],"default":"active"}},{"in":"query","name":"start_date","description":"UTC Start Date in ISO format","required":false,"schema":{"type":"string"}},{"in":"query","name":"end_date","description":"UTC End Date in ISO format","required":false,"schema":{"type":"string"}},{"in":"query","name":"search_type","required":false,"description":"Search type options [ fynd_order_id, shipment_id, manifest_id, dp_name, awb_no ]","schema":{"type":"string","enum":["fynd_order_id","shipment_id","manifest_id","dp_name","awb_no"]}},{"in":"query","name":"store_id","required":false,"description":"Fetch manifests for a Store.","schema":{"type":"integer"}},{"in":"query","name":"search_value","required":false,"description":"Search value for selected search type","schema":{"type":"string"}},{"in":"query","name":"dp_ids","required":false,"description":"DP Ids separated by ',' (comma)","schema":{"type":"string"}},{"in":"query","name":"page_no","required":false,"schema":{"type":"integer"}},{"in":"query","name":"page_size","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful Manifest upload!","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManifestList"}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"applicationId":[],"applicationToken":[]}],"summary":"getManifests | undefined"},"post":{"tags":["Order"],"description":"Process Manifest.","parameters":[{"in":"path","name":"company_id","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessManifest"}}}},"responses":{"200":{"description":"Manifest will be processed!","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessManifestItemResponse"}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"applicationId":[],"applicationToken":[]}],"summary":"processManifests | undefined"}},"/service/platform/order-manage/v1.0/company/{company_id}/manifests/{manifest_id}":{"get":{"tags":["Order"],"description":"get Manifest Details.","parameters":[{"in":"path","name":"company_id","required":true,"schema":{"type":"integer"}},{"in":"path","name":"manifest_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Manifest upload!","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManifestDetails"}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"applicationId":[],"applicationToken":[]}],"summary":"getManifestDetails | undefined"}},"/service/platform/order-manage/v1.0/company/{company_id}/manifest/{manifest_id}/dispatch":{"post":{"tags":["Order"],"description":"Dispatch Manifest","parameters":[{"in":"path","name":"company_id","required":true,"schema":{"type":"integer"}},{"in":"path","name":"manifest_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DispatchManifest"}}}},"responses":{"200":{"description":"Shipment Dispatched mapped with manifest!","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"applicationId":[],"applicationToken":[]}],"summary":"dispatchManifests | undefined"}},"/service/platform/order-manage/v1.0/company/{company_id}/manifest/{manifest_id}/upload-consent":{"post":{"tags":["Order"],"description":"Upload Consent","parameters":[{"in":"path","name":"company_id","required":true,"schema":{"type":"integer"}},{"in":"path","name":"manifest_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadConsent"}}}},"responses":{"200":{"description":"Successful Manifest upload!","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"applicationId":[],"applicationToken":[]}],"summary":"uploadConsents | undefined"}},"/service/platform/order-manage/v1.0/company/{company_id}/filter/listing":{"get":{"tags":["Order"],"description":"get Manifest Filters.","parameters":[{"in":"path","name":"company_id","description":"Id of company","required":true,"schema":{"type":"integer"}},{"in":"query","name":"view","description":"Name of View","required":true,"schema":{"type":"string","default":"manifest","enum":["my_orders","bulk_action","manifest","bulk_invoice"]}}],"responses":{"200":{"description":"List of filters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManifestFiltersResponse"},"example":{}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"applicationId":[],"applicationToken":[]}],"summary":"getManifestfilters | undefined"}},"/service/platform/order-manage/v1.0/company/{company_id}/einvoice/retry/irn":{"post":{"description":"Retry e-invoice after failure","parameters":[{"in":"path","name":"company_id","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"examples":{"sample1":{"value":{"shipments_data":[{"shipment_id":"16342342342343423","einvoice_type":"invoice"},{"shipment_id":"16342342342343423","einvoice_type":"credit_note"}]}}},"schema":{"$ref":"#/components/schemas/EInvoiceRetry"}}}},"responses":{"200":{"content":{"application/json":{"examples":{"sample1":{"value":{"response_data":[{"shipment_id":"16342342342343423","einvoice_type":"invoice","status":200,"message":"E-invoice generated for given shipment","einvoice_info":{"irn_details":{"ack_no":"172313559180590","ack_dt":"2023-10-01 12:09:00","irn":"5ac2752f161c356d6957d5e7e52759343acfa516638b92718a1309dc25ee0015","signed_invoice":"d6GXwwhz86_aRlXmueRHboFRB8UhnWGU3CREZKesJkYz42e2HduZ5_d29zoh7yhIiIDC5TLueWHIMHE0UJ5C1z5i0QQSdjMrqBcamu7rpS6wOVIEt6RMs2CZulKt","signed_qr_code":"d6GXwwhz86_aRlXmueRHboFRB8UhnWGU3CREZKesJkYz42e2HduZ5_d29zoh7yhIiIDC5TLueWHIMHE0UJ5C1z5i0QQSdjMrqBcamu7rpS6wOVIEt6RMs2CZulKt"}}},{"shipment_id":"16342342342343424","einvoice_type":"invoice","status":200,"message":"E-invoice generated for given shipment","einvoice_info":{"irn_details":{"ack_no":"172313559180590","ack_dt":"2023-10-01 12:09:00","irn":"5ac2752f161c356d6957d5e7e52759343acfa516638b92718a1309dc25ee0015","signed_invoice":"d6GXwwhz86_aRlXmueRHboFRB8UhnWGU3CREZKesJkYz42e2HduZ5_d29zoh7yhIiIDC5TLueWHIMHE0UJ5C1z5i0QQSdjMrqBcamu7rpS6wOVIEt6RMs2CZulKt","signed_qr_code":"d6GXwwhz86_aRlXmueRHboFRB8UhnWGU3CREZKesJkYz42e2HduZ5_d29zoh7yhIiIDC5TLueWHIMHE0UJ5C1z5i0QQSdjMrqBcamu7rpS6wOVIEt6RMs2CZulKt"}}}]}},"sample2":{"value":{"response_data":[{"shipment_id":"16342342342343423","einvoice_type":"invoice","status":200,"message":"E-invoice generated for given shipment","einvoice_info":{"irn_details":null,"ack_no":"172313559180590","ack_dt":"2023-10-01 12:09:00","irn":"5ac2752f161c356d6957d5e7e52759343acfa516638b92718a1309dc25ee0015","signed_invoice":"d6GXwwhz86_aRlXmueRHboFRB8UhnWGU3CREZKesJkYz42e2HduZ5_d29zoh7yhIiIDC5TLueWHIMHE0UJ5C1z5i0QQSdjMrqBcamu7rpS6wOVIEt6RMs2CZulKt","signed_qr_code":"d6GXwwhz86_aRlXmueRHboFRB8UhnWGU3CREZKesJkYz42e2HduZ5_d29zoh7yhIiIDC5TLueWHIMHE0UJ5C1z5i0QQSdjMrqBcamu7rpS6wOVIEt6RMs2CZulKt"}},{"shipment_id":"16342342342343424","einvoice_type":"invoice","status":400,"message":"E-invoice generation failed for shipment","einvoice_info":{"error_details":[{"error_code":"3028","error_message":"GSTIN -22AQDPK3837A1Z5 is invalid."},{"error_code":"2265","error_message":"Recipient GSTIN state code does not match with the state code passed in recipient details"}]}}]}},"sample3":{"value":{"response_data":[{"shipment_id":"16342342342343423","einvoice_type":"invoice","status":200,"message":"E-invoice generated for given shipment","einvoice_info":{"irn_details":null,"ack_no":"172313559180590","ack_dt":"2023-10-01 12:09:00","irn":"5ac2752f161c356d6957d5e7e52759343acfa516638b92718a1309dc25ee0015","signed_invoice":"d6GXwwhz86_aRlXmueRHboFRB8UhnWGU3CREZKesJkYz42e2HduZ5_d29zoh7yhIiIDC5TLueWHIMHE0UJ5C1z5i0QQSdjMrqBcamu7rpS6wOVIEt6RMs2CZulKt","signed_qr_code":"d6GXwwhz86_aRlXmueRHboFRB8UhnWGU3CREZKesJkYz42e2HduZ5_d29zoh7yhIiIDC5TLueWHIMHE0UJ5C1z5i0QQSdjMrqBcamu7rpS6wOVIEt6RMs2CZulKt"}},{"shipment_id":"16342342342343424","einvoice_type":"invoice","status":400,"message":"E-invoice generation cannot processed because invoice id is not present in shipment","einvoice_info":{}},{"shipment_id":"16342342342343425","einvoice_type":"invoice","status":500,"message":"Error while generatin E-invoice for shipment, please contact platform support team for assistance","einvoice_info":{}}]}}},"schema":{"$ref":"#/components/schemas/EInvoiceRetryResponse"}}},"description":"E-invoice generated successfully for all/few shipments from given list of shipments."},"400":{"content":{"application/json":{"examples":{"sample1":{"value":{"response_data":[{"shipment_id":"16342342342343424","einvoice_type":"invoice","status":400,"message":"E-invoice generation failed for shipment","einvoice_info":{"error_details":[{"error_code":"3028","error_message":"GSTIN -22AQDPK3837A1Z5 is invalid."},{"error_code":"2265","error_message":"Recipient GSTIN state code does not match with the state code passed in recipient details"}]}}]}},"sample2":{"value":{"response_data":[{"shipment_id":"16342342342343424","einvoice_type":"invoice","status":400,"message":"E-invoice generation cannot processed because invoice id is not present in shipment","einvoice_info":{}},{"shipment_id":"16342342342343425","einvoice_type":"invoice","status":500,"message":"Error while generatin E-invoice for shipment, please contact platform support team for assistance","einvoice_info":{}}]}},"sample3":{"value":{"response_data":[],"message":"shipment_data can not be blank and the data type of it should be array of objects"}}},"schema":{"$ref":"#/components/schemas/EInvoiceErrorResponse"}}},"description":"Bad request. See the message or einvoice_info.error_details object in the response body to know the exact reason."},"500":{"content":{"application/json":{"examples":{"sample1":{"value":{"response_data":[{"shipment_id":"16342342342343424","einvoice_type":"invoice","status":500,"message":"E-invoice generation failed for shipment","einvoice_info":{"error_details":[{"error_code":"","error_message":"Error while generating E-invoice, please contact platform support team"}]}}]}},"sample2":{"value":{"response_data":[{"shipment_id":"16342342342343424","einvoice_type":"invoice","status":500,"message":"Error while generating E-invoice for shipment, please contact platform support team","einvoice_info":{}}]}}},"schema":{"$ref":"#/components/schemas/EInvoiceErrorResponseDetails"}}},"description":"Internal server error. Error while trying to generate e-invoice. Kindly contact platform support team for this type of issue."}},"security":[{"applicationId":[],"applicationToken":[]}],"tags":["Order"],"summary":"eInvoiceRetry | undefined"}},"/service/platform/order-manage/v1.0/company/{company_id}/tracking":{"get":{"description":"This endpoint allows users to get courier partner tracking details for a given shipment id or awb no. The service will fetch courier partner statuses that are pushed to oms.","parameters":[{"description":"Company ID","example":"1","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"Shipment ID","example":"16908065964581066182","in":"query","name":"shipment_id","required":false,"schema":{"type":"string"}},{"description":"AWB number","example":"581066182","in":"query","name":"awb","required":false,"schema":{"type":"string"}},{"description":"Page number","example":1,"in":"query","name":"page_no","required":false,"schema":{"type":"integer"}},{"description":"Page size","example":10,"in":"query","name":"page_size","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"examples":{"success":{"value":{"items":[{"awb":"713191641","dp_location":"Mumbai","dp_name":"Ecom b2b","dp_status":"dp_assigned","dp_status_updated_at":"2023-07-12T20:17:46.384Z","estimated_delivery_date":"2023-07-12T20:17:46.384Z","id":370,"journey":"forward","operational_status":"dp_assigned","promised_delivery_date":"2023-07-12T20:17:46.384Z","remark":"UD -Manifested","shipment_id":"16908065964581066182"}],"page":{"current":1,"has_next":true,"item_total":3,"size":200,"type":"number"}}}},"schema":{"$ref":"#/components/schemas/CourierPartnerTrackingResponse"}}},"description":"Shipment Tracking fetched successfully"},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error_trace":"Exception Trace","message":"Exception","success":false,"status":500}}}}},"tags":["Order"],"summary":"trackShipment | undefined"},"post":{"summary":"updateShipmentTracking | Post courier partner tracking details","description":"This endpoint allows users to post courier partner tracking details for a given shipment id or awb no. The service will add entry for courier partner statuses and will be saved to oms.","tags":["Order"],"parameters":[{"in":"path","description":"Company ID","name":"company_id","required":true,"schema":{"type":"integer"},"example":1}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CourierPartnerTrackingDetails"},"examples":{"success":{"value":{"awb":"713191641","dp_location":"Mumbai","dp_name":"Ecom b2b","dp_status":"dp_assigned","dp_status_updated_at":"2023-07-12T20:17:46.384Z","estimated_delivery_date":"2023-07-12T20:17:46.384Z","journey":"forward","operational_status":"dp_assigned","promised_delivery_date":"2023-07-12T20:17:46.384Z","remark":"UD -Manifested","shipment_id":"16908065964581066182"}}}}}},"responses":{"200":{"description":"Shipment Tracking updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CourierPartnerTrackingDetails"},"examples":{"success":{"value":{"awb":"713191641","dp_location":"Mumbai","dp_name":"Ecom b2b","dp_status":"dp_assigned","dp_status_updated_at":"2023-07-12T20:17:46.384Z","estimated_delivery_date":"2023-07-12T20:17:46.384Z","id":370,"journey":"forward","operational_status":"dp_assigned","promised_delivery_date":"2023-07-12T20:17:46.384Z","remark":"UD -Manifested","shipment_id":"16908065964581066182"}}}}}},"4XX":{"content":{"application/json":{"example":{"error_trace":"Exception Trace","message":"Exception","status":500,"success":false},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request. See the error object in the response body to know the exact reason."}}}},"/service/platform/order-manage/v1.0/company/{company_id}/orders/failed":{"get":{"tags":["Order"],"summary":"failedOrderLogs | Get failed order logs according to the filter provided","description":"This endpoint allows users to get failed order logs listing for filters based on order id, user contact number, user email id and sales channel id.","parameters":[{"in":"path","name":"company_id","description":"Company ID","required":true,"schema":{"type":"integer","example":2}},{"in":"query","name":"application_id","description":"Application ID","required":false,"schema":{"type":"string","example":"64aed475db2cfb5b8a9f623d"}},{"in":"query","name":"page_no","required":false,"description":"Page Number","schema":{"type":"integer","example":1}},{"in":"query","name":"page_size","required":false,"description":"Page Size","schema":{"type":"integer","example":10}},{"in":"query","name":"search_type","required":false,"description":"Search type for filter","schema":{"type":"string","example":"email_id"}},{"in":"query","name":"search_value","required":false,"description":"Search value for filter","schema":{"type":"string","example":"employee@gofynd.com"}}],"responses":{"200":{"description":"Order Logs listing fetched successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FailedOrderLogs"}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error_trace":"Exception Trace","message":"Exception","success":false,"status":400}}}},"5XX":{"description":"Internal Server error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorDetail"},"example":{"message":"Exception","success":false}}}}}}},"/service/platform/order-manage/v1.0/company/{company_id}/{invoice_type}/id/generate":{"post":{"tags":["Order"],"description":"This API is used to manually generate Invoice ID against shipments.","parameters":[{"in":"path","name":"company_id","description":"company id from where are transitioning the shipment state or data","required":true,"schema":{"type":"integer"}},{"in":"path","name":"invoice_type","description":"mention the type of invoice id to generate","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateInvoiceIDRequest"},"example":{"shipment_ids":["16838049724111283577","16836368409661507353","16830062656481252150"]}}}},"responses":{"200":{"description":"NOTE success response can contains success and failed result as well","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateInvoiceIDResponse"},"example":{"items":[{"shipment_id":"16838049724111283577","success":true,"invoice_id":"A0B1C2D3","error_message":null}]}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateInvoiceIDErrorResponse"},"example":{"items":[{"shipment_id":"16838049724111283577","success":false,"invoice_id":null,"error_message":"No bags present for shipment_id: 16838049724111283577"}]}}}}},"security":[{"applicationId":[],"applicationToken":[]}],"summary":"generateInvoiceID | undefined"}},"/service/platform/order-manage/v1.0/company/{company_id}/orders/failed/logs/{log_id}":{"get":{"tags":["Order"],"summary":"failedOrderLogDetails | Get failed order logs according to the filter provided","description":"This endpoint allows users to get the exact error trace from the log id provided","parameters":[{"in":"path","name":"company_id","description":"Company ID","required":true,"schema":{"type":"integer","example":2}},{"in":"path","name":"log_id","description":"Log Error ID","required":true,"schema":{"type":"string","example":"a3b6b771-38e6-4014-9b05-b8e4df5a3a89"}}],"responses":{"200":{"description":"Order Logs listing fetched successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FailedOrderLogDetails"}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error_trace":"Exception Trace","message":"Exception","success":false,"status":400}}}},"5XX":{"description":"Internal Server error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorDetail"},"example":{"message":"Exception","success":false}}}}}}},"/service/platform/order/v1.0/company/{company_id}/application/{application_id}/orders/shipments/{shipment_id}/line_number/{line_number}/reasons":{"get":{"summary":"getShipmentBagReasons | Get reasons behind full or partial cancellation of a shipment","description":"Use this API to retrieve the issues that led to the cancellation of bags within a shipment.","tags":["Order"],"parameters":[{"in":"path","name":"company_id","description":"Id of company","required":true,"schema":{"type":"integer","example":37}},{"in":"path","name":"application_id","description":"Application ID of company","required":true,"schema":{"type":"string","example":"5d63686df2a4f7806b76bb32"}},{"in":"path","description":"ID of the bag. An order may contain multiple items and may get divided into one or more shipment, each having its own ID.","name":"shipment_id","required":true,"schema":{"type":"string"}},{"in":"path","description":"line number of bag.","name":"line_number","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success. Check the example shown below or refer `ShipmentBagReasons` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShipmentBagReasons"},"example":{"success":true,"reasons":[{"id":1,"display_name":"Not available","qc_type":[],"question_set":[]},{"reasons":[{"id":2,"display_name":"Processing other orders","qc_type":[],"question_set":[]},{"id":3,"display_name":"Printer not working","qc_type":[],"question_set":[]},{"reasons":[{"id":4,"display_name":"Card issues","qc_type":[],"question_set":[]}]}]},{"id":4,"display_name":"Card issues","qc_type":[],"question_set":[]}]}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"applicationId":[],"applicationToken":[]}]}},"/service/platform/order/v1.0/company/{company_id}/shipments-listing":{"get":{"tags":["Order"],"description":"Get Shipments Listing for the company id","parameters":[{"in":"path","name":"company_id","description":"Id of company","required":true,"schema":{"type":"integer","example":37}},{"in":"query","name":"lane","description":"Name of lane for which data is to be fetched","required":false,"schema":{"type":"string","enum":["new","confirmed","to_be_packed","ready_for_dispatch","in_transit","handed_over_to_customer","delivered","cancelled","return_initiated","return_in_transit","return_delivered","return_accepted"],"example":"new"}},{"in":"query","name":"bag_status","description":"Comma separated values of bag statuses","required":false,"schema":{"type":"string","example":"placed, bag_confirmed, bag_invoiced"}},{"in":"query","name":"status_override_lane","description":"Use this flag to fetch by bag_status and override lane","required":false,"schema":{"type":"boolean","default":false}},{"in":"query","name":"time_to_dispatch","required":false,"schema":{"type":"integer","example":1,"enum":[1,-1]}},{"in":"query","name":"search_type","description":"Search type key","required":false,"schema":{"type":"string","example":"shipment_id"}},{"in":"query","name":"search_value","description":"Search type value","required":false,"schema":{"type":"string","example":"16578901076461551493K"}},{"in":"query","name":"from_date","description":"Start Date in DD-MM-YYYY format","required":false,"schema":{"type":"string","format":"date","example":"2023-05-10"}},{"in":"query","name":"to_date","description":"End Date in DD-MM-YYYY format","required":false,"schema":{"type":"string","format":"date","example":"2023-05-13"}},{"in":"query","name":"start_date","description":"UTC Start Date in ISO format","required":false,"schema":{"type":"string","format":"date-time","example":"2023-08-21T09:48:40Z"}},{"in":"query","name":"end_date","description":"UTC End Date in ISO format","required":false,"schema":{"type":"string","format":"date-time","example":"2023-08-21T09:48:40Z"}},{"in":"query","name":"dp_ids","description":"Comma separated values of delivery partner ids","required":false,"schema":{"type":"string","example":"19,26"}},{"in":"query","name":"stores","description":"Comma separated values of store ids","required":false,"schema":{"type":"string","example":"12,34"}},{"in":"query","name":"sales_channels","description":"Comma separated values of sales channel ids","required":false,"schema":{"type":"string","example":"000000000000000000000001,614b42d1ea943427b5f46d1e"}},{"in":"query","name":"page_no","description":"Page number for paginated data","required":false,"schema":{"type":"integer","default":1}},{"in":"query","name":"page_size","description":"Page size of data received per page","required":false,"schema":{"type":"integer","default":10}},{"in":"query","name":"fetch_active_shipment","description":"flag to fetch active shipments","required":false,"schema":{"type":"boolean","default":true}},{"in":"query","name":"allow_inactive","description":"Flag to allow inactive shipments","required":false,"schema":{"type":"boolean","default":false}},{"in":"query","name":"exclude_locked_shipments","description":"flag to fetch locked shipments","required":false,"schema":{"type":"boolean","default":true}},{"in":"query","name":"payment_methods","description":"Comma separated values of payment methods","required":false,"schema":{"type":"string","example":"COD,PREPAID"}},{"in":"query","name":"channel_shipment_id","description":"App Shipment Id","required":false,"schema":{"type":"string","example":"16731535496121004000"}},{"in":"query","name":"channel_order_id","description":"App Order Id","required":false,"schema":{"type":"string","example":"FY63BA4C0D0125F8A075"}},{"in":"query","name":"custom_meta","required":false,"schema":{"type":"string"}},{"in":"query","name":"ordering_channel","required":false,"schema":{"type":"string"}},{"in":"query","name":"company_affiliate_tag","required":false,"schema":{"type":"string"}},{"in":"query","name":"my_orders","required":false,"schema":{"type":"boolean"}},{"in":"query","name":"platform_user_id","required":false,"schema":{"type":"string"}},{"in":"query","name":"sort_type","description":"Sort the result data on basis of input","required":false,"schema":{"type":"string","enum":["sla_asc","created_date_asc","created_date_desc"],"default":"sla_asc"}},{"in":"query","name":"show_cross_company_data","description":"Flag to view cross & non-cross company order","required":false,"schema":{"type":"boolean","default":false}},{"in":"query","name":"tags","description":"Comma separated values of tags","required":false,"schema":{"type":"string","example":"gifting,international"}},{"in":"query","name":"customer_id","required":false,"schema":{"type":"string","example":"63a2ce177e9f59d3166dd700"}},{"in":"query","name":"order_type","required":false,"schema":{"type":"string","example":"HomeDelivery"}}],"responses":{"200":{"description":"We are processing the report!","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShipmentInternalPlatformViewResponse"}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"applicationId":[],"applicationToken":[]}],"summary":"getShipments | undefined"}},"/service/platform/order/v1.0/company/{company_id}/shipment-details":{"get":{"tags":["Order"],"description":"Get shipment details for the given shipment.","parameters":[{"in":"path","name":"company_id","description":"Id of company","required":true,"schema":{"type":"integer","example":37}},{"in":"query","name":"channel_shipment_id","description":"App Shipment Id","required":false,"schema":{"type":"string","example":"16731535496121004000"}},{"in":"query","name":"shipment_id","description":"Shipment Id","required":false,"schema":{"type":"string","example":"16731535496121004000"}},{"in":"query","name":"fetch_active_shipment","description":"flag to fetch active or deactivated shipments","required":false,"schema":{"type":"boolean","example":false}}],"responses":{"200":{"description":"We are processing the report!","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShipmentInfoResponse"},"example":{"success":true,"order":{"fynd_order_id":"FY62B13E2101810C19E4","shipment_count":1,"order_date":"2022-06-21T09:12:26+00:00"},"shipments":[{"shipment_id":"16557829457641286433","payment_mode":"COD","fulfilling_store":{"meta":{},"id":1,"code":"HS-468a5","fulfillment_channel":"pulse","store_name":"Reliance Industries Ltd - Jio Market","contact_person":"","phone":"8268108880","address":"high_street WEWORK, VIJAY DIAMONDS, ANDHERI MUMBAI MAHARASHTRA 400093","city":"MUMBAI","state":"MAHARASHTRA","country":"INDIA","pincode":"400093","tags":["infibeam"]},"delivery_details":{"name":"Manish Prakash","email":"Manish.Prakash@ril.com","phone":"7787051611","address":"home 479 sector3 bokaro Bokaro Jharkhand 827003","city":"Bokaro","state":"Jharkhand","country":"India","pincode":"827003","state_code":0},"billing_details":{"name":"Manish Prakash","email":"Manish.Prakash@ril.com","phone":"7787051611","address":"home 479 sector3 bokaro Bokaro Jharkhand 827003","city":"Bokaro","state":"Jharkhand","country":"India","pincode":"827003","state_code":0},"dp_details":{"id":null,"name":null,"awb_no":null,"eway_bill_id":null,"track_url":null,"gst_tag":"sgst"},"journey_type":"forward","order":{"fynd_order_id":"FY62B13E2101810C19E4","affiliate_id":"000000000000000000000001","ordering_channel":"FYND","source":"null","tax_details":{"gstin":null},"order_date":"2022-06-21T09:12:26+00:00"},"gst_details":{"value_of_good":475.24,"gst_fee":23.76,"brand_calculated_amount":499,"tax_collected_at_source":0,"gstin_code":null},"shipment_quantity":1,"bag_status_history":[{"status":"pending","updated_at":"2022-06-21T09:12:26+00:00","state_type":"operational","app_display_name":"Pending","display_name":"Pending","forward":null},{"status":"placed","updated_at":"2022-06-21T09:12:32+00:00","state_type":"operational","app_display_name":"Ordered","display_name":"Placed","forward":null},{"status":"bag_confirmed","updated_at":"2022-06-21T09:39:13+00:00","state_type":"operational","app_display_name":"Ordered","display_name":"Bag Confirmed","forward":null},{"status":"dp_assigned","updated_at":"2022-06-21T09:40:04+00:00","state_type":"operational","app_display_name":"DP Assigned","display_name":"DP Assigned","forward":null},{"status":"bag_picked","updated_at":"2022-06-21T09:40:12+00:00","state_type":"operational","app_display_name":"Shipped","display_name":"In Transit","forward":null},{"status":"out_for_delivery","updated_at":"2022-06-21T09:40:29+00:00","state_type":"operational","app_display_name":"Out For Delivery","display_name":"Out For Delivery","forward":null},{"status":"delivery_done","updated_at":"2022-06-21T09:40:37+00:00","state_type":"operational","app_display_name":"Delivered","display_name":"Delivery Done","forward":null}],"bags":[{"bag_id":43880,"display_name":"Bag","entity_type":"bag","bag_configs":{"is_returnable":true,"can_be_cancelled":true,"enable_tracking":false,"is_customer_return_allowed":true,"allow_force_return":false,"is_active":false},"financial_breakup":{"price_effective":499,"discount":0,"amount_paid":549,"coupon_effective_discount":0,"delivery_charge":50,"fynd_credits":0,"cod_charges":0,"refund_credit":0,"cashback":0,"refund_amount":549,"added_to_fynd_cash":false,"cashback_applied":0,"gst_tax_percentage":5,"value_of_good":475.24,"price_marked":499,"transfer_price":0,"brand_calculated_amount":499,"promotion_effective_discount":0,"coupon_value":0,"pm_price_split":{"COD":549},"size":"5","total_units":1,"hsn_code":"62050000","identifiers":{"sku_code":"CL-001L-L-PRPL-PINK-5"},"item_name":"Purple Flip Flops","gst_fee":23.76,"gst_tag":"IGST"},"current_status":{"id":1},"item":{"name":"Purple Flip Flops","brand":"Nike","slug_key":"purple-flip-flops-ezmucvw4d3","images":["https://hdn-1.fynd.com/products/pictures/item/free/270x0/CL-001L-L-PRPL-PINK-6/Rvk5WbGg9Hx-1.jpg"],"size":"5","l1_category":[],"l3_category":27},"brand":{"modified_on":"1655707988","logo":"https://hdn-1.jiomarketx0.de/x0/brands/pictures/square-logo/original/DbhIvd_tB-Logo.jpeg","brand_name":"Nike","company":null,"created_on":"1647793418","id":4},"gst_details":{"gstin_code":"null","gst_tag":"IGST","hsn_code":"62050000","value_of_good":475.24,"gst_tax_percentage":5,"is_default_hsn_code":true,"brand_calculated_amount":499,"gst_fee":23.76,"tax_collected_at_source":0},"article":{"uid":"6237fdfec0903e7ae543c201","identifiers":{"sku_code":"CL-001L-L-PRPL-PINK-5"},"return_config":{"time":30,"unit":"days","returnable":true}},"quantity":1}],"delivery_slot":{"slot":"By 03:00 AM","upper_bound":"2022-06-21T03:42:23+00:00","lower_bound":"2022-06-21T03:42:23+00:00","date":"2022-06-21T03:42:23+00:00","type":"order_window"},"total_items":1,"payment_methods":{"slug":"COD","payment_id":"COD","payment_amt":549,"payment_cart":null,"payment_desc":"COD","bdcustomer_id":null,"order_inv_num":null,"mode_of_payment":"COD","payment_gateway_logo":null,"transaction_ref_number":""},"vertical":"GROCERIES","payments":{"mode":"COD","logo":"https://hdn-1.fynd.com/payment/Pos+Logo.png","source":"Jio Partner Pay"},"priority_text":null,"status":{"created_at":"1655804437","shipment_id":"16557829457641286433","status":"delivery_done","bag_list":["43880"],"id":19980},"prices":{"amount_paid":549,"refund_amount":549,"price_marked":499,"cod_charges":0,"discount":0,"cashback_applied":0,"delivery_charge":50,"fynd_credits":0,"cashback":0,"price_effective":499,"refund_credit":0,"value_of_good":475.24,"pm_price_split":500,"COD":549,"brand_calculated_amount":499,"coupon_effective_discount":0,"tax_collected_at_source":0,"promotion_effective_discount":0},"picked_date":"","tracking_list":[{"status":"Order Placed","time":"2022-06-21T09:12:32+00:00","is_passed":true,"is_current":false,"text":""},{"status":"Order Confirmed","time":"2022-06-21T09:39:13+00:00","is_passed":true,"is_current":false,"text":""},{"status":"Invoiced","time":"2022-06-21T09:40:12+00:00","is_passed":true,"is_current":false,"text":""},{"status":"Delivery Partner Assigned","time":"2022-06-21T09:40:12+00:00","is_passed":true,"is_current":false,"text":""},{"status":"Packed","time":"2022-06-21T09:40:12+00:00","is_passed":true,"is_current":false,"text":""},{"status":"In Transit","time":"2022-06-21T09:40:12+00:00","is_passed":true,"is_current":false,"text":""},{"status":"Out For Delivery","time":"2022-06-21T09:40:29+00:00","is_passed":true,"is_current":false,"text":""},{"status":"Delivered","time":"2022-06-21T09:40:37+00:00","is_passed":true,"is_current":true,"text":""}],"user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/102.0.0.0 Safari/537.36","platform_logo":"https://fynd-static.s3.amazonaws.com/mode_of_payment/fynd_logo.png","packaging_type":"POLYB_DFLT_L"}]}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"applicationId":[],"applicationToken":[]}],"summary":"getShipmentById | undefined"}},"/service/platform/order/v1.0/company/{company_id}/order-details":{"get":{"tags":["Order"],"description":"Get Order Details by ID","parameters":[{"in":"path","name":"company_id","description":"Id of company","required":true,"schema":{"type":"integer"}},{"in":"query","name":"order_id","required":true,"schema":{"type":"string","default":"FY6299E19701B4EAEFC2"}},{"in":"query","name":"my_orders","required":false,"schema":{"type":"boolean"}},{"in":"query","name":"allow_inactive","description":"Flag to allow inactive shipments","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"We are processing the report!","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderDetailsResponse"},"example":{"success":true,"order":{"fynd_order_id":"FY637CFCC00177713D47","meta":{"files":[],"staff":{},"cart_id":1835,"comment":"","extra_meta":{},"order_tags":null,"order_type":"HomeDelivery","employee_id":null,"payment_type":"self","mongo_cart_id":1835,"order_platform":"platform-site","ordering_store":1,"order_child_entities":["bag","shipment"]},"affiliate_id":"62f35968d101a6d38c886d85","ordering_channel":"Ecomm","source":"uniket-desktop","tax_details":{"gstin":null},"order_date":"2022-11-22T22:15:53+00:00","prices":{"amount_paid":948.5,"refund_amount":948.5,"price_marked":1398,"cod_charges":0,"discount":349.5,"cashback_applied":0,"delivery_charge":0,"fynd_credits":0,"cashback":0,"price_effective":1048.5,"refund_credit":0,"value_of_good":803.82,"coupon_value":0,"tax_collected_at_source":0,"promotion_effective_discount":100,"amount_paid_roundoff":948},"raw_user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/107.0.0.0 Safari/537.36","comment":""},"shipments":[{"shipment_id":"16691355532841431595","fulfilling_store":{"id":5,"code":"SF94","fulfillment_channel":"pulse","store_name":"RELIANCE RETAIL LTD - Beauty & Personal care","contact_person":"Anju Abraham","phone":"918898846722","address":"store 1ST FLOOR, WEWORK VIJAY DIAMOND, CROSS RD B, AJIT NAGAR, KONDIVITA, ANDHERI EAST, MUMBAI, MAHARASHTR Mumbai Maharashtra 400093","city":"Mumbai","state":"Maharashtra","country":"India","pincode":"400093","meta":{"stage":"verified","timing":[{"open":true,"closing":{"hour":22,"minute":0},"opening":{"hour":11,"minute":0},"weekday":"monday"},{"open":true,"closing":{"hour":22,"minute":0},"opening":{"hour":11,"minute":0},"weekday":"tuesday"},{"open":true,"closing":{"hour":22,"minute":0},"opening":{"hour":11,"minute":0},"weekday":"wednesday"},{"open":true,"closing":{"hour":22,"minute":0},"opening":{"hour":11,"minute":0},"weekday":"thursday"},{"open":true,"closing":{"hour":22,"minute":0},"opening":{"hour":11,"minute":0},"weekday":"friday"},{"open":true,"closing":{"hour":22,"minute":0},"opening":{"hour":11,"minute":0},"weekday":"saturday"},{"open":true,"closing":{"hour":22,"minute":0},"opening":{"hour":11,"minute":0},"weekday":"sunday"}],"documents":{},"gst_number":null,"display_name":"RELIANCE RETAIL LTD - Beauty & Personal care","gst_credentials":{"e_invoice":{"enabled":false},"e_waybill":{"enabled":false}},"notification_emails":["anjuabraham@gofynd.com"],"product_return_config":{"on_same_store":true},"additional_contact_details":{"number":["91 - 8898846722"]},"ewaybill_portal_details":null},"fulfilment_type":null},"delivery_details":{"name":"Vaishakh Shetty","email":"","phone":"9892133001","address":"home Asd,Mumbai,Maharashtra,Mumbai,Maharashtra,India Asd,Mumbai,Maharashtra,Mumbai,Maharashtra,India Mumbai,Maharashtra Mumbai Maharashtra 400083","city":"Mumbai","state":"Maharashtra","country":"India","pincode":"400083","state_code":"27"},"billing_details":{"name":"Vaishakh Shetty","email":"","phone":"9892133001","address":"home Asd,Mumbai,Maharashtra,Mumbai,Maharashtra,India Mumbai,Maharashtra Mumbai Maharashtra 400083","city":"Mumbai","state":"Maharashtra","country":"India","pincode":"400083","state_code":"27"},"dp_details":{"id":null,"name":null,"awb_no":null,"eway_bill_id":null,"track_url":null,"gst_tag":"sgst","dp_otp":""},"journey_type":"forward","order":{"fynd_order_id":"FY637CFCC00177713D47","meta":{"files":[],"staff":{},"cart_id":1835,"comment":"","extra_meta":{},"order_tags":null,"order_type":"HomeDelivery","employee_id":null,"payment_type":"self","mongo_cart_id":1835,"order_platform":"platform-site","ordering_store":1,"order_child_entities":["bag","shipment"]},"affiliate_id":"62f35968d101a6d38c886d85","ordering_channel":"Ecomm","source":"uniket-desktop","tax_details":{"gstin":null},"order_date":"2022-11-22T22:15:53+00:00","prices":{"amount_paid":948.5,"refund_amount":948.5,"price_marked":1398,"cod_charges":0,"discount":349.5,"cashback_applied":0,"delivery_charge":0,"fynd_credits":0,"cashback":0,"price_effective":1048.5,"refund_credit":0,"value_of_good":803.82,"coupon_value":0,"tax_collected_at_source":0,"promotion_effective_discount":100,"amount_paid_roundoff":948},"raw_user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/107.0.0.0 Safari/537.36","comment":""},"gst_details":{"value_of_good":401.91,"gst_fee":72.34,"brand_calculated_amount":474.25,"tax_collected_at_source":0,"gstin_code":"null"},"shipment_quantity":1,"bag_status_history":[{"status":"pending","updated_at":"2022-11-22T22:15:54+00:00","state_type":"operational","app_display_name":"Pending","display_name":"Pending","forward":null},{"status":"placed","updated_at":"2022-11-22T22:15:59+00:00","state_type":"operational","app_display_name":"Ordered","display_name":"Placed","forward":null},{"status":"bag_confirmed","updated_at":"2022-11-22T22:54:50+00:00","state_type":"operational","app_display_name":"Ordered","display_name":"Bag Confirmed","forward":null}],"bags":[{"bag_id":20472628,"display_name":"Bag","entity_type":"bag","meta":{"custom_message":"Please send the shipment as soon as possible."},"bag_configs":{"is_returnable":true,"can_be_cancelled":true,"enable_tracking":true,"is_customer_return_allowed":false,"is_active":true,"allow_force_return":true},"financial_breakup":{"price_effective":524,"discount":174,"amount_paid":474.25,"coupon_effective_discount":0,"delivery_charge":0,"fynd_credits":0,"cod_charges":0,"refund_credit":0,"cashback":0,"refund_amount":474.25,"added_to_fynd_cash":false,"cashback_applied":0,"gst_tax_percentage":18,"value_of_good":401.91,"price_marked":699,"transfer_price":0,"brand_calculated_amount":474.25,"tax_collected_at_source":0,"tcs_percentage":0,"promotion_effective_discount":50,"coupon_value":0,"amount_paid_roundoff":474,"size":"OS","total_units":1,"hsn_code":"20472574","identifiers":{"ean":"6902395784364","sku_code":"1020820"},"item_name":"L'Oreal Paris Rouge Signature Matte Liquid Lipstick, 146 I Enlight","gst_fee":72.34,"gst_tag":"SGST"},"current_status":{"id":1},"item":{"name":"L'Oreal Paris Rouge Signature Matte Liquid Lipstick, 146 I Enlight","brand":"L'Oreal Paris","slug_key":"loreal-paris-rouge-signature-matte-liquid-lipstick-146-i-enlight-96a1wferol05","images":["https://cdn.pixelbin.io/v2/super-fire-62c344/tirabz/wrkr/tiraz0/products/pictures/item/free/270x0/1020820/shj00c0H4T-1020820_1.jpg","https://cdn.pixelbin.io/v2/super-fire-62c344/tirabz/wrkr/tiraz0/products/pictures/item/free/270x0/1020820/iM7wvxxxT5-1020820_2.jpg","https://cdn.pixelbin.io/v2/super-fire-62c344/tirabz/wrkr/tiraz0/products/pictures/item/free/270x0/1020820/TcPMevsr6O-1020820_3.jpg","https://cdn.pixelbin.io/v2/super-fire-62c344/tirabz/wrkr/tiraz0/products/pictures/item/free/270x0/1020820/BAiV5xox57-1020820_4.jpg","https://cdn.pixelbin.io/v2/super-fire-62c344/tirabz/wrkr/tiraz0/products/pictures/item/free/270x0/1020820/6wXPvugMto-1020820_5.jpg","https://cdn.pixelbin.io/v2/super-fire-62c344/tirabz/wrkr/tiraz0/products/pictures/item/free/270x0/1020820/LvlirqfHho-1020820_6.jpg","https://cdn.pixelbin.io/v2/super-fire-62c344/tirabz/wrkr/tiraz0/products/pictures/item/free/270x0/1020820/KKnZHIJwO-1020820_7.jpg","https://cdn.pixelbin.io/v2/super-fire-62c344/tirabz/wrkr/tiraz0/products/pictures/item/free/270x0/1020820/NheQB3HLlq-1020820_8.jpg"],"size":"OS","l1_category":["Makeup"],"l3_category":134},"brand":{"credit_note_expiry_days":null,"modified_on":"2022-11-22T09:08:25","id":2,"logo":"https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/tira-n/wrkr/tiraz0/brands/pictures/square-logo/original/iCMr3gmUF-Logo.jpeg","created_on":"2022-08-09T13:17:41","credit_note_allowed":false,"start_date":null,"company":null,"script_last_ran":null,"pickup_location":null,"brand_name":"L'Oreal Paris","invoice_prefix":null,"is_virtual_invoice":false},"gst_details":{"gstin_code":"null","gst_tag":"SGST","hsn_code":"20472574","value_of_good":401.91,"gst_tax_percentage":18,"is_default_hsn_code":true,"brand_calculated_amount":474.25,"tax_collected_at_source":0,"hsn_code_id":"62f3ad402cbb29a3a1c9186b","gst_fee":72.34,"igst_tax_percentage":0,"sgst_tax_percentage":9,"cgst_tax_percentage":9,"igst_gst_fee":0,"cgst_gst_fee":36.17,"sgst_gst_fee":36.17},"article":{"uid":"62f495f2a604499934540c69","identifiers":{"ean":"6902395784364","sku_code":"1020820"},"return_config":{"time":7,"unit":"days","returnable":true}},"affiliate_bag_details":{"coupon_code":null},"quantity":1,"identifier":"","applied_promos":[{"amount":50,"promo_id":"637cfcb19d43e76334b9fb6c","buy_rules":[{"item_criteria":{"item_brand":[2]},"cart_conditions":{}}],"mrp_promotion":false,"discount_rules":[{"type":"amount","value":100}],"promotion_name":"VS","promotion_type":"amount","article_quantity":2}],"mark_as_returnable":false}],"custom_message":"Please send the shipment as soon as possible.","company_id":2,"user":{"user_oid":"637cbf77e7706fbc79baa669","gender":"female","first_name":"Vaishakh","id":18052704,"mobile":"9892133001","mongo_user_id":"637cbf77e7706fbc79baa669","email":"vaishakhshetty@gofynd.com","last_name":"Shetty","is_anonymous_user":false},"pickup_slot":{},"delivery_slot":{"slot":"By 16:00 PM","upper_bound":"2022-11-25T16:45:50+00:00","lower_bound":"2022-11-23T16:45:50+00:00","date":"2022-11-25T16:45:50+00:00","type":"order_window"},"total_items":1,"payment_methods":{"PP":{"amount":474.25,"mode":"PP","name":"PartnerPay","collect_by":"seller","refund_by":"seller","meta":{}}},"vertical":null,"priority_text":null,"status":{"created_at":"2022-11-22T22:54:50+00:00","id":88117778,"meta":{"request_meta":{},"state_manager_used":"entity","kafka_emission_status":1},"status":"bag_confirmed","shipment_id":"16691355532841431595","bag_list":["20472628"],"current_shipment_status":"bag_confirmed","status_created_at":"2022-11-22T22:54:50"},"prices":{"amount_paid":474.25,"refund_amount":474.25,"price_marked":699,"cod_charges":0,"discount":174.75,"cashback_applied":0,"delivery_charge":0,"fynd_credits":0,"cashback":0,"price_effective":524.25,"refund_credit":0,"value_of_good":401.91,"coupon_value":0,"tax_collected_at_source":0,"promotion_effective_discount":50,"amount_paid_roundoff":474},"tracking_list":[{"text":"Placed","status":"processing","is_passed":true,"time":"2022-11-22T22:15:59+00:00"},{"text":"Bag Confirmed","status":"confirmed","is_passed":true,"time":"2022-11-22T22:54:50+00:00"},{"text":"Dp Assigned","status":"dp_assigned","is_passed":false,"time":""},{"text":"In Transit","status":"in_transit","is_passed":false,"time":""},{"text":"Out For Delivery","status":"out_for_delivery","is_passed":false,"time":""},{"text":"Delivered","status":"delivered","is_passed":false,"time":""}],"user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/107.0.0.0 Safari/537.36","platform_logo":"https://fynd-static.s3.amazonaws.com/mode_of_payment/ecomm_logo.png","packaging_type":"POLYB_DFLT_L","enable_dp_tracking":false,"invoice":{"updated_date":"1970-01-01T00:00:00","store_invoice_id":null,"invoice_url":"","label_url":"","external_invoice_id":""},"can_process":true,"estimated_sla_time":"null","tracking_url":"","meta":{"dp_id":"9","weight":300,"external":{},"formatted":{"max":"Fri, 25 Nov","min":"Wed, 23 Nov"},"timestamp":{"max":1669394750,"min":1669221950},"bag_weight":{"20472628":300},"debug_info":{"stormbreaker_uuid":"998171bb-67af-412a-a00a-12d436418ff2"},"dp_options":{},"order_type":null,"dp_sort_key":"fm_priority","packaging_name":"POLYB_DFLT_L","assign_dp_from_sb":true,"same_store_available":true,"fulfill_virtual_invoice":false,"fulfilment_priority_text":null,"auto_trigger_dp_assignment_ACF":true},"shipment_created_at":"2022-11-22T22:15:53+00:00","mark_as_returnable":false,"ordering_store":{"id":5,"code":"SF94","fulfillment_channel":"pulse","store_name":"RELIANCE RETAIL LTD - Beauty & Personal care","contact_person":"Anju Abraham","phone":"918898846722","address":"store 1ST FLOOR, WEWORK VIJAY DIAMOND, CROSS RD B, AJIT NAGAR, KONDIVITA, ANDHERI EAST, MUMBAI, MAHARASHTR Mumbai Maharashtra 400093","city":"Mumbai","state":"Maharashtra","country":"India","pincode":"400093","meta":{"stage":"verified","timing":[{"open":true,"closing":{"hour":22,"minute":0},"opening":{"hour":11,"minute":0},"weekday":"monday"},{"open":true,"closing":{"hour":22,"minute":0},"opening":{"hour":11,"minute":0},"weekday":"tuesday"},{"open":true,"closing":{"hour":22,"minute":0},"opening":{"hour":11,"minute":0},"weekday":"wednesday"},{"open":true,"closing":{"hour":22,"minute":0},"opening":{"hour":11,"minute":0},"weekday":"thursday"},{"open":true,"closing":{"hour":22,"minute":0},"opening":{"hour":11,"minute":0},"weekday":"friday"},{"open":true,"closing":{"hour":22,"minute":0},"opening":{"hour":11,"minute":0},"weekday":"saturday"},{"open":true,"closing":{"hour":22,"minute":0},"opening":{"hour":11,"minute":0},"weekday":"sunday"}],"documents":{},"gst_number":null,"display_name":"RELIANCE RETAIL LTD - Beauty & Personal care","gst_credentials":{"e_invoice":{"enabled":false},"e_waybill":{"enabled":false}},"notification_emails":["anjuabraham@gofynd.com"],"product_return_config":{"on_same_store":true},"additional_contact_details":{"number":["91 - 8898846722"]},"ewaybill_portal_details":null},"fulfilment_type":null},"custom_meta":[]}]}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"applicationId":[],"applicationToken":[]}],"summary":"getOrderById | undefined"}},"/service/platform/order/v1.0/company/{company_id}/lane-config/":{"get":{"tags":["Order"],"description":"Get lane config for the order","parameters":[{"in":"path","name":"company_id","description":"Id of company","required":true,"schema":{"type":"integer"}},{"in":"query","name":"super_lane","description":"Name of lane for which data is to be fetched","required":false,"schema":{"type":"string","enum":["unfulfilled","processed","returns","action_centre"],"default":"unfulfilled"}},{"in":"query","name":"group_entity","description":"Name of group entity","required":false,"schema":{"type":"string","enum":["shipments","orders","bags"],"default":"shipments"}},{"in":"query","name":"from_date","description":"Start Date in DD-MM-YYYY format","required":false,"schema":{"type":"string"}},{"in":"query","name":"to_date","description":"End Date in DD-MM-YYYY format","required":false,"schema":{"type":"string"}},{"in":"query","name":"start_date","description":"UTC Start Date in ISO format","required":false,"schema":{"type":"string"}},{"in":"query","name":"end_date","description":"UTC End Date in ISO format","required":false,"schema":{"type":"string"}},{"in":"query","name":"dp_ids","description":"Comma separated values of delivery partner ids","required":false,"schema":{"type":"string"}},{"in":"query","name":"stores","description":"Comma separated values of store ids","required":false,"schema":{"type":"string"}},{"in":"query","name":"sales_channels","required":false,"schema":{"type":"string"}},{"in":"query","name":"payment_mode","description":"Comma separated values of payment modes","required":false,"schema":{"type":"string"}},{"in":"query","name":"bag_status","description":"Comma separated values of bag statuses","required":false,"schema":{"type":"string"}},{"in":"query","name":"search_type","required":false,"schema":{"type":"string"}},{"in":"query","name":"search_value","required":false,"schema":{"type":"string"}},{"in":"query","name":"tags","required":false,"schema":{"type":"string"}},{"in":"query","name":"time_to_dispatch","required":false,"schema":{"type":"integer","example":1,"enum":[1,-1]}},{"in":"query","name":"payment_methods","required":false,"schema":{"type":"string"}},{"in":"query","name":"my_orders","required":false,"schema":{"type":"boolean"}},{"in":"query","name":"show_cross_company_data","description":"Flag to view cross & non-cross company order","required":false,"schema":{"type":"boolean","default":false}},{"in":"query","name":"order_type","required":false,"schema":{"type":"string","example":"HomeDelivery"}}],"responses":{"200":{"description":"Response containing count of shipments of the given status","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LaneConfigResponse"},"example":{"super_lanes":[{"text":"Unfulfilled","value":"unfulfilled","options":[{"text":"New","value":"new","total_items":18,"index":1,"actions":[]},{"text":"Confirmed","value":"confirmed","total_items":0,"index":2,"actions":[]},{"text":"To Be Packed","value":"to_be_packed","total_items":0,"index":3,"actions":[]},{"text":"Ready To Dispatch","value":"ready_for_dispatch","total_items":0,"index":4,"actions":[]}],"total_items":18},{"text":"Return","value":"return","options":[{"text":"Return Initiated","value":"return_initiated","total_items":0,"index":9,"actions":[]},{"text":"Return In Transit","value":"return_in_transit","total_items":0,"index":10,"actions":[]},{"text":"Return Delivered","value":"return_delivered","total_items":0,"index":11,"actions":[]},{"text":"Return Accepted","value":"return_accepted","total_items":0,"index":12,"actions":[]}],"total_items":0}]}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"applicationId":[],"applicationToken":[]}],"summary":"getLaneConfig | undefined"}},"/service/platform/order/v1.0/company/{company_id}/orders-listing":{"get":{"tags":["Order"],"description":"Get Orders Listing","parameters":[{"in":"path","name":"company_id","description":"Id of company","required":true,"schema":{"type":"integer","default":37}},{"in":"query","name":"lane","description":"lane refers to a section where orders are assigned, indicating its grouping","required":false,"schema":{"type":"string","default":"new"}},{"in":"query","name":"search_type","description":"search_type refers to the field that will be used as the target for the search operation","required":false,"schema":{"type":"string","default":"shipment_id"}},{"in":"query","name":"bag_status","description":"bag_status refers to status of the entity. Filters orders based on the status.","required":false,"schema":{"type":"string"}},{"in":"query","name":"time_to_dispatch","description":"time_to_dispatch refers to estimated SLA time.","required":false,"schema":{"type":"integer","example":1,"enum":[1,-1]}},{"in":"query","name":"payment_methods","required":false,"schema":{"type":"string"}},{"in":"query","name":"tags","description":"tags refers to additional descriptive labels associated with the order","required":false,"schema":{"type":"string"}},{"in":"query","name":"search_value","description":"search_value is matched against the field specified by the search_type","required":false,"schema":{"type":"string","default":"16854460524441037000"}},{"in":"query","name":"from_date","required":false,"schema":{"type":"string"}},{"in":"query","name":"to_date","required":false,"schema":{"type":"string"}},{"in":"query","name":"start_date","required":false,"schema":{"type":"string"}},{"in":"query","name":"end_date","required":false,"schema":{"type":"string"}},{"in":"query","name":"dp_ids","description":"Delivery Partner IDs to which shipments are assigned.","required":false,"schema":{"type":"string"}},{"in":"query","name":"stores","required":false,"schema":{"type":"string"}},{"in":"query","name":"sales_channels","required":false,"schema":{"type":"string"}},{"in":"query","name":"page_no","required":false,"schema":{"type":"integer"}},{"in":"query","name":"page_size","required":false,"schema":{"type":"integer"}},{"in":"query","name":"is_priority_sort","required":false,"schema":{"type":"boolean","default":true}},{"in":"query","name":"custom_meta","required":false,"schema":{"type":"string","default":"6388422a5ebd6a6cf4a8ede6"}},{"in":"query","name":"my_orders","required":false,"schema":{"type":"boolean"}},{"in":"query","name":"show_cross_company_data","description":"Flag to view cross & non-cross company order","required":false,"schema":{"type":"boolean","default":false}},{"in":"query","name":"customer_id","required":false,"schema":{"type":"string","example":"63a2ce177e9f59d3166dd700"}},{"in":"query","name":"order_type","required":false,"schema":{"type":"string","example":"HomeDelivery"}}],"responses":{"200":{"description":"We are processing the report!","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderListingResponse"}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"applicationId":[],"applicationToken":[]}],"summary":"getOrders | undefined"}},"/service/platform/order/v1.0/company/{company_id}/application/{application_id}/shipments/":{"get":{"tags":["Order"],"description":"Get cross selling platform shipments","parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer"}},{"name":"application_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"lane","in":"query","required":false,"schema":{"type":"string"}},{"name":"search_type","in":"query","required":false,"schema":{"type":"string"}},{"name":"search_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"from_date","in":"query","required":false,"schema":{"type":"string"}},{"name":"to_date","in":"query","required":false,"schema":{"type":"string"}},{"name":"dp_ids","in":"query","required":false,"schema":{"type":"string"}},{"name":"ordering_company_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"stores","in":"query","required":false,"schema":{"type":"string"}},{"name":"sales_channel","in":"query","required":false,"schema":{"type":"string"}},{"name":"request_by_ext","in":"query","required":false,"schema":{"type":"string"}},{"name":"page_no","in":"query","required":false,"schema":{"type":"integer"}},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer"}},{"name":"customer_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"is_priority_sort","in":"query","required":false,"schema":{"type":"boolean","default":true}},{"name":"exclude_locked_shipments","in":"query","required":false,"schema":{"type":"boolean","default":true}}],"responses":{"200":{"description":"We are processing the report!","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShipmentInternalPlatformViewResponse"}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"applicationId":[],"applicationToken":[]}],"summary":"getApplicationShipments | undefined"}},"/service/platform/order/v1.0/company/{company_id}/application/{application_id}/orders/shipments/{shipment_id}/track":{"get":{"summary":"trackShipmentPlatform | Track shipment","tags":["Order"],"description":"Track Shipment by shipment id, for application based on application Id","parameters":[{"in":"path","name":"company_id","description":"Id of company","required":true,"schema":{"type":"string"}},{"in":"path","name":"application_id","description":"Id of application","required":true,"schema":{"type":"string"}},{"in":"path","name":"shipment_id","description":"Shipment Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success. Check the example shown below or refer `PlatformShipmentTrack` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformShipmentTrack"},"example":{"meta":{},"results":[{"updated_at":"24 Nov, 12:39 PM","last_location_recieved_at":"Thane","reason":"Fyndr","shipment_type":"forward","status":"dp_assigned","updated_time":"2022-11-24T12:39:38+05:30","account_name":"fyndr","awb":"2125658183710","raw_status":"dp_assigned","meta":{}}]}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"applicationId":[],"applicationToken":[]}]}},"/service/platform/order/v1.0/company/{company_id}/filter-listing":{"get":{"tags":["Order"],"description":"Get Listing Filters","parameters":[{"in":"path","name":"company_id","description":"Id of company","required":true,"schema":{"type":"integer"}},{"in":"query","name":"view","description":"Name of view","required":true,"schema":{"type":"string","default":"manifest","enum":["my_orders","bulk_action","bulk_invoice","manifest"]}},{"in":"query","name":"group_entity","description":"Name of group entity","required":false,"schema":{"type":"string","default":"orders","enum":["orders","shipments"]}}],"responses":{"200":{"description":"List of filters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FiltersResponse"},"example":{"global":[{"text":"Fulfilling Stores","value":"stores","type":"single_select","options":null},{"text":"Search Types","value":"search_type","type":"single_select","options":[{"text":"Auto","value":"auto","placeholder_text":"Search by Shipment ID, Order ID & Customer Email","min_search_size":5,"show_ui":true},{"text":"Shipment ID","value":"shipment_id","placeholder_text":"Search by Shipment ID","min_search_size":6,"show_ui":true},{"text":"Order ID","value":"order_id","placeholder_text":"Search by Order ID","min_search_size":6,"show_ui":true},{"text":"Customer Name","value":"name","placeholder_text":"Search by Customer Name","min_search_size":3,"show_ui":true},{"text":"Customer Email","value":"email","placeholder_text":"Search by Customer Email","min_search_size":5,"show_ui":true},{"text":"AWB Number","value":"awb_no","placeholder_text":"Search by AWB Number","min_search_size":10,"show_ui":true},{"text":"Invoice Id","value":"invoice_id","placeholder_text":"Search by Invoice Id","min_search_size":5,"show_ui":true},{"text":"EAN","value":"ean","placeholder_text":"Search by EAN","min_search_size":3,"show_ui":true},{"text":"SKU","value":"sku","placeholder_text":"Search by SKU","min_search_size":3,"show_ui":true}]}],"advance":{"Unfulfilled":[{"text":"Store Type","value":"store_type","type":"single_select","options":[{"name":"Warehouse","value":"warehouse"},{"name":"High Street","value":"high_street"},{"name":"Mall","value":"mall"},{"name":"Web Store","value":"webstore"}]},{"text":"Order Source","value":"order_source","type":"single_select","options":[{"name":"Uniket","value":"uniket"},{"name":"Fynd","value":"fynd"},{"name":"Fynd Store","value":"fynd_store"},{"name":"Affiliate","value":"affiliate"}]},{"text":"Time to Dispatch","value":"time_to_dispatch","type":"single_select","options":[{"text":"Breached","value":1},{"text":"Not Breached","value":-1}]},{"text":"Payment Methods","value":"payment_methods","type":"single_select","options":[{"text":"COD","value":"COD"},{"text":"Prepaid","value":"PREPAID"}]}],"Processed":[{"text":"Store Type","value":"store_type","type":"single_select","options":[{"name":"Warehouse","value":"warehouse"},{"name":"High Street","value":"high_street"},{"name":"Mall","value":"mall"},{"name":"Web Store","value":"webstore"}]},{"text":"Order Source","value":"order_source","type":"single_select","options":[{"name":"Uniket","value":"uniket"},{"name":"Fynd","value":"fynd"},{"name":"Fynd Store","value":"fynd_store"},{"name":"Affiliate","value":"affiliate"}]},{"text":"Payment Methods","value":"payment_methods","type":"single_select","options":[{"text":"COD","value":"COD"},{"text":"Prepaid","value":"PREPAID"}]}],"Return":[{"text":"Store Type","value":"store_type","type":"single_select","options":[{"name":"Warehouse","value":"warehouse"},{"name":"High Street","value":"high_street"},{"name":"Mall","value":"mall"},{"name":"Web Store","value":"webstore"}]},{"text":"Order Source","value":"order_source","type":"single_select","options":[{"name":"Uniket","value":"uniket"},{"name":"Fynd","value":"fynd"},{"name":"Fynd Store","value":"fynd_store"},{"name":"Affiliate","value":"affiliate"}]},{"text":"Payment Methods","value":"payment_methods","type":"single_select","options":[{"text":"COD","value":"COD"},{"text":"Prepaid","value":"PREPAID"}]}],"ActionCentre":[{"text":"Store Type","value":"store_type","type":"single_select","options":[{"name":"Warehouse","value":"warehouse"},{"name":"High Street","value":"high_street"},{"name":"Mall","value":"mall"},{"name":"Web Store","value":"webstore"}]},{"text":"Order Source","value":"order_source","type":"single_select","options":[{"name":"Uniket","value":"uniket"},{"name":"Fynd","value":"fynd"},{"name":"Fynd Store","value":"fynd_store"},{"name":"Affiliate","value":"affiliate"}]},{"text":"Payment Methods","value":"payment_methods","type":"single_select","options":[{"text":"COD","value":"COD"},{"text":"Prepaid","value":"PREPAID"}]}]}}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"applicationId":[],"applicationToken":[]}],"summary":"getfilters | undefined"}},"/service/platform/order/v1.0/company/{company_id}/generate/file":{"get":{"tags":["Order"],"description":"Generate Bulk Shipment Excel Report.","parameters":[{"in":"path","name":"company_id","description":"Id of company","required":true,"schema":{"type":"integer"}},{"in":"query","name":"sales_channels","description":"Comma separated values of sales channel ids","required":false,"schema":{"type":"string"}},{"in":"query","name":"dp_ids","description":"Comma separated values of delivery partner ids","required":false,"schema":{"type":"string"}},{"in":"query","name":"start_date","description":"UTC start date in ISO format","required":false,"schema":{"type":"string","format":"date-time"}},{"in":"query","name":"end_date","description":"UTC end date in ISO format","required":false,"schema":{"type":"string","format":"date-time"}},{"in":"query","name":"stores","description":"Comma separated values of store ids","required":false,"schema":{"type":"string"}},{"in":"query","name":"tags","description":"Comma separated values of tags","required":false,"schema":{"type":"string"}},{"in":"query","name":"bag_status","description":"Comma separated values of bag statuses","required":false,"schema":{"type":"string"}},{"in":"query","name":"payment_methods","description":"Comma separated values of payment methods","required":false,"schema":{"type":"string"}},{"in":"query","name":"file_type","description":"File type to be downloaded","required":false,"schema":{"type":"string"}},{"in":"query","name":"time_to_dispatch","description":"Sla breached or not breached","required":false,"schema":{"type":"integer","example":1,"enum":[1,-1]}},{"in":"query","name":"page_no","required":false,"schema":{"type":"integer","default":1}},{"in":"query","name":"page_size","required":false,"schema":{"type":"integer","default":10}}],"responses":{"200":{"description":"We are processing the file!","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileResponse"},"example":{"file_name":"placed_352_1668856953.7936668.xlsx","operation":"putObject","size":13245,"namespace":"misc","content_type":"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet","file_path":"/misc/general/free/original/0Ex0-zTyw-placed_352_1668856953.7936668.xlsx","method":"PUT","tags":[],"upload":{"url":"https://fynd-staging-assets.s3-accelerate.amazonaws.com/x0/misc/general/free/original/0Ex0-zTyw-placed_352_1668856953.7936668.xlsx?Content-Type=application%2Fvnd.openxmlformats-officedocument.spreadsheetml.sheet&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAJUADR2WMPQT6ZJ2Q%2F20221119%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20221119T112233Z&X-Amz-Expires=1800&X-Amz-Signature=3408400dbe95ff12d0ea5487846aab74b0f2ae6963a58ac980fb46c11cd0b7be&X-Amz-SignedHeaders=host%3Bx-amz-acl&x-amz-acl=public-read","expiry":1800},"cdn":{"url":"https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/fyndnp/wrkr/x0/misc/general/free/original/0Ex0-zTyw-placed_352_1668856953.7936668.xlsx"}}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"applicationId":[],"applicationToken":[]}],"summary":"getBulkShipmentExcelFile | undefined"}},"/service/platform/order/v1.0/company/{company_id}/bulk-action/get-seller-templates":{"get":{"tags":["Order"],"description":"Get Bulk Action seller templates.","parameters":[{"in":"path","name":"company_id","description":"Id of company","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Slug names","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkActionTemplateResponse"},"example":{"template_x_slug":[{"text":"Partial Cancellation","value":"PARTIAL_CANCELLATION"}]}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"applicationId":[],"applicationToken":[]}],"summary":"getBulkActionTemplate | undefined"}},"/service/platform/order/v1.0/company/{company_id}/bulk-action/download-seller-templates":{"get":{"tags":["Order"],"description":"Download bulk actions seller templates.","parameters":[{"in":"path","name":"company_id","description":"Id of company","required":true,"schema":{"type":"integer"}},{"in":"query","name":"template_slug","description":"Slug name of template to be downloaded","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"We are processing the file!","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileResponse"},"example":{"file_name":"placed_352_1668856953.7936668.xlsx","operation":"putObject","size":13245,"namespace":"misc","content_type":"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet","file_path":"/misc/general/free/original/0Ex0-zTyw-placed_352_1668856953.7936668.xlsx","method":"PUT","tags":[],"upload":{"url":"https://fynd-staging-assets.s3-accelerate.amazonaws.com/x0/misc/general/free/original/0Ex0-zTyw-placed_352_1668856953.7936668.xlsx?Content-Type=application%2Fvnd.openxmlformats-officedocument.spreadsheetml.sheet&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAJUADR2WMPQT6ZJ2Q%2F20221119%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20221119T112233Z&X-Amz-Expires=1800&X-Amz-Signature=3408400dbe95ff12d0ea5487846aab74b0f2ae6963a58ac980fb46c11cd0b7be&X-Amz-SignedHeaders=host%3Bx-amz-acl&x-amz-acl=public-read","expiry":1800},"cdn":{"url":"https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/fyndnp/wrkr/x0/misc/general/free/original/0Ex0-zTyw-placed_352_1668856953.7936668.xlsx"}}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"applicationId":[],"applicationToken":[]}],"summary":"downloadBulkActionTemplate | undefined"}},"/service/platform/order/v1.0/company/{company_id}/shipments/{shipment_id}/bags/{bag_id}/state/{state}/reasons":{"get":{"summary":"getShipmentReasons | Get reasons behind full or partial cancellation of a shipment","description":"Use this API to retrieve the issues that led to the cancellation of bags within a shipment.","tags":["Order"],"parameters":[{"in":"path","name":"company_id","required":true,"schema":{"type":"integer"}},{"in":"path","name":"shipment_id","description":"ID of the shipment. An order may contain multiple items and may get divided into one or more shipment, each having its own ID.","required":true,"schema":{"type":"string"}},{"in":"path","description":"ID of the bag. An order may contain multiple items and may get divided into one or more shipment, each having its own ID.","name":"bag_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"state","description":"State for which reasons are required.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success. Check the example shown below or refer `PlatformShipmentReasonsResponse` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformShipmentReasonsResponse"},"example":{"success":true,"reasons":[{"id":84,"display_name":"Not Available to accept the Order","qc_type":[],"question_set":[]},{"id":85,"display_name":"Store Bulk Order","qc_type":[],"question_set":[]},{"id":86,"display_name":"Cancelled due to delayed delivery","qc_type":[],"question_set":[]},{"id":87,"display_name":"Others","qc_type":[],"question_set":[]}]}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"applicationId":[],"applicationToken":[]}]}},"/service/platform/order/v1.0/company/{company_id}/application/{application_id}/orders/shipments/reasons/{action}":{"get":{"summary":"getPlatformShipmentReasons | Use this API to retrieve the issues that led to the cancellation of bags within a shipment.","description":"Using action, get reasons behind full or partial cancellation of a shipment","tags":["Order"],"parameters":[{"in":"path","name":"company_id","required":true,"schema":{"type":"integer"}},{"in":"path","name":"application_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"action","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success. Check the example shown below or refer `ShipmentReasonsResponse` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShipmentReasonsResponse"}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/service/platform/order/v1.0/company/{company_id}/bag-details/":{"get":{"tags":["Order"],"description":"Get Order Bag Details.","parameters":[{"in":"path","name":"company_id","description":"Id of company","required":true,"schema":{"type":"integer"}},{"in":"query","name":"bag_id","description":"Id of bag","required":false,"schema":{"type":"string"}},{"in":"query","name":"channel_bag_id","description":"Id of application bag","required":false,"schema":{"type":"string"}},{"in":"query","name":"channel_id","description":"Id of application","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrived shipment details!","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BagDetailsPlatformResponse"}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"BAD_REQUEST","message":"Request pramas missing, i.e(company_id or shipment_id)"}}}},"5XX":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"INTERNAL_SERVER_ERROR","message":"query provided is invalid"}}}}},"security":[{"applicationId":[],"applicationToken":[]}],"summary":"getBagById | undefined"}},"/service/platform/order/v1.0/company/{company_id}/bags":{"get":{"tags":["Order"],"description":"Get Bags for the order","parameters":[{"in":"path","name":"company_id","description":"Id of company","required":true,"schema":{"type":"integer"}},{"in":"query","name":"bag_ids","description":"Comma separated values of bag ids","required":false,"schema":{"type":"string","example":"1234,2344"}},{"in":"query","name":"shipment_ids","description":"Comma separated values of shipment ids","required":false,"schema":{"type":"string","example":"1661111234,167772344"}},{"in":"query","name":"order_ids","description":"Comma separated values of order ids","required":false,"schema":{"type":"string","example":"1661111234,167772344"}},{"in":"query","name":"channel_bag_ids","description":"Comma separated values of app bag ids","required":false,"schema":{"type":"string","example":"B1234,B2344"}},{"in":"query","name":"channel_shipment_ids","description":"Comma separated values of app shipment ids","required":false,"schema":{"type":"string","example":"S1234,S2344"}},{"in":"query","name":"channel_order_ids","description":"Comma separated values of app order ids","required":false,"schema":{"type":"string","example":"O1234,02344"}},{"in":"query","name":"channel_id","description":"Comma separated values of app ids","required":false,"schema":{"type":"string","example":"000000000000000000000001,614b42d1ea943427b5f46d1e"}},{"in":"query","name":"page_no","description":"Page number for paginated data","required":false,"schema":{"type":"integer","default":1}},{"in":"query","name":"page_size","description":"Page size of data received per page","required":false,"schema":{"type":"integer","default":20}}],"responses":{"200":{"description":"Successfully retrived all the given shipments details!","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBagsPlatformResponse"}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"BAD_REQUEST","message":"Request params missing, i.e(company_id or shipment_ids)"}}}},"5XX":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"INTERNAL_SERVER_ERROR","message":"query provided is invalid"}}}}},"security":[{"applicationId":[],"applicationToken":[]}],"summary":"getBags | undefined"}},"/service/platform/order/v1.0/company/{company_id}/orders/{order_id}/generate/pos-receipt":{"get":{"tags":["Order"],"description":"Generate POS recipt by order id.","parameters":[{"in":"path","name":"company_id","required":true,"schema":{"type":"integer"}},{"in":"path","name":"order_id","required":true,"schema":{"type":"string"}},{"in":"query","name":"shipment_id","required":false,"schema":{"type":"string"}},{"in":"query","name":"document_type","required":false,"schema":{"type":"string","default":"invoice_receipt"}}],"responses":{"200":{"description":"We are processing the request!","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneratePosOrderReceiptResponse"}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"applicationId":[],"applicationToken":[]}],"summary":"generatePOSReceiptByOrderId | undefined"}},"/service/platform/order/v1.0/company/{company_id}/jobs/templates":{"get":{"tags":["Order"],"description":"Gets All the allowed Templates to perform Bulk Operations.","parameters":[{"in":"path","name":"company_id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successfully Found the templates.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AllowedTemplatesResponse"},"examples":{"AllowedTemplatesResponseExample":{"value":{"template_x_slug":[{"text":"DP Assignment","value":"MANUAL_DP_ASSIGNMENT"},{"text":"Fluid","value":"MOVE_TO_FLUID_STATE"},{"text":"Cancellation"}]}}}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkFailedResponse"},"examples":{"BulkFailedResponse":{"value":{"status":false,"error":"no job found against this provided Batch Id."}}}}}}},"security":[{"applicationId":[],"applicationToken":[]}],"summary":"getAllowedTemplatesForBulk | undefined"}},"/service/platform/order/v1.0/company/{company_id}/jobs/templates/{template_name}":{"get":{"tags":["Order"],"description":"Get the Excel file URL for the Template.","parameters":[{"in":"path","name":"company_id","required":true,"schema":{"type":"integer"}},{"in":"path","name":"template_name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Sucessfully Created the Template Url.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplateDownloadResponse"},"examples":{"AllowedTemplatesResponseExample":{"value":{"file_name":"template.xlsx","url":"www.fynd.com/excelfile.xlsx"}}}}}},"4XX":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkFailedResponse"},"examples":{"BulkFailedResponse":{"value":{"status":false,"error":"Unknown template passed."}}}}}}},"security":[{"applicationId":[],"applicationToken":[]}],"summary":"getTemplate | undefined"}},"/service/platform/partners/v1.0/company/{company_id}/application/{application_id}/proxy/{extension_id}":{"post":{"tags":["Partner"],"description":"Use this API to generate proxy URL for the external URL","summary":"addProxyPath | Create proxy URL for the external URL","parameters":[{"schema":{"type":"string"},"description":"Current company id","in":"path","required":true,"name":"company_id"},{"schema":{"type":"string"},"description":"Current application id","in":"path","required":true,"name":"application_id"},{"name":"extension_id","in":"path","description":"Extension id for which proxy URL will be generated","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddProxyReq"},"example":{"attached_path":"test","proxy_url":"https://www.abc.com/"}}}},"responses":{"200":{"description":"Proxy created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddProxyResponse"},"example":{"_id":"607406b8a472cd527303692f","attached_path":"test","proxy_url":"https://www.abc.com","company_id":"1","application_id":"000000000000000000000004","extension_id":"6073280be899ea5b1150fd9d","created_at":"2021-04-12T08:37:12.077Z","modified_at":"2021-04-12T08:37:12.077Z"}}}},"400":{"description":"Proxy URL already exists","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"},"example":{"code":"","message":"Already Present","meta":{"attached_path":"test","proxy_url":"https://www.abc.com"}}}}}}}},"/service/platform/partners/v1.0/company/{company_id}/application/{application_id}/proxy/{extension_id}/{attached_path}":{"delete":{"tags":["Partner"],"description":"Use this API to remove the proxy URL which is already generated for the external URL","summary":"removeProxyPath | Remove proxy URL for the external URL","parameters":[{"schema":{"type":"string"},"description":"Current company id","in":"path","required":true,"name":"company_id"},{"schema":{"type":"string"},"description":"Current application id","in":"path","required":true,"name":"application_id"},{"name":"extension_id","in":"path","description":"Extension id for which proxy URL needs to be removed","required":true,"schema":{"type":"string"}},{"name":"attached_path","in":"path","description":"Attachaed path slug","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoveProxyResponse"},"example":{"message":"Proxy URL deleted","data":{"_id":"607406b8a472cd527303692f","attached_path":"test","proxy_url":"https://www.abc.com","company_id":"1","application_id":"000000000000000000000004","extension_id":"6073280be899ea5b1150fd9d","created_at":"2021-04-12T08:37:12.077Z","modified_at":"2021-04-12T08:37:12.077Z"}}}}},"404":{"description":"Entry not found attached path","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"},"example":{"code":"","message":"Not found"}}}}}}},"/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/aggregator/request":{"get":{"summary":"getBrandPaymentGatewayConfig | Get All Brand Payment Gateway Config Secret","description":"Get All Brand Payment Gateway Config Secret","tags":["Payment"],"parameters":[{"name":"company_id","in":"path","description":"Company Id","schema":{"type":"integer"},"required":true},{"name":"application_id","in":"path","description":"Application id","schema":{"type":"string"},"required":true},{"name":"aggregator","in":"query","description":"aggregator slug","schema":{"type":"string"},"required":false},{"name":"config_type","in":"query","required":false,"schema":{"type":"string","enum":["self","partner","fynd"]}}],"responses":{"200":{"description":"Refund Transfer Mode","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentGatewayConfigResponse"},"example":{"success":true,"created":true,"app_id":"000000000000000000000004","excluded_fields":["config_type","aggregator"],"display_fields":["logo","display"],"aggregators":[{"key":"rrroooouuurrrrdddd","secret":"yyyyooo","is_active":false,"config_type":"","merchant_key":"vvvvvvvvddd","aggregator":"juspay","display":{"link":"","text":"Review in under process. Please  wait while process completed or contact us for any further query.","description":"Juspay is not a Payment Gateway (like Citrus, CCAvenue, PayU) but it works with any gateway or aggregator with zero interference in the Merchant-PG relations.","reviewed":false},"logo":"https://hdn-1.fynd.com/payment/juspay-pg-logo.jpg"},{"key":"","pin":"","secret":"","user_id":"","is_active":false,"config_type":"","merchant_id":"","aggregator":"mswipe","display":{"link":"","text":"Submitted request to be reviewed before going live. Please contact us for any further query.","description":"Mswipe card swipe machines are safe and secure and accepts all debit & credit cards."},"logo":"https://hdn-1.fynd.com/payment/mswipe-pg-logo.png"},{"key":"tttyyyyyy","secret":"rerrrrrrrr","is_active":false,"config_type":"","merchant_salt":"qqqqq","aggregator":"payumoney","display":{"link":"","text":"Review in under process. Please  wait while process completed or contact us for any further query.","description":"PayUmoney supports wide range of options for making online payments via wallets, UPI, cards, and netbanking.","reviewed":false},"logo":"https://hdn-1.fynd.com/payment/payu_logo_large.png"},{"key":"test","secret":"test","is_active":true,"config_type":"self","webhook_secret":"test","aggregator":"razorpay","display":{"link":"","text":"Well done, You payment gateway successfully lived. Collect your payment at your end.","description":"Razorpay is a payments platform which accept online payments via Credit Card, Debit Card, Net banking, UPI, BharatQR and Wallets.","reviewed":true},"logo":"https://hdn-1.fynd.com/payment/razorpay-pg-logo.jpg"},{"key":"","secret":"","is_active":false,"config_type":"","aggregator":"rupifi","display":{"link":"","text":"Submitted request to be reviewed before going live. Please contact us for any further query.","description":"Rupifi enables businesses to avail credits and allows a 'Buy now, Pay later' system for making transactions and purchases."},"logo":"https://hdn-1.fynd.com/payment/Rupifi.png"},{"key":"12345","secret":"12345","is_active":false,"config_type":"","aggregator":"simpl","display":{"link":"","text":"Review in under process. Please  wait while process completed or contact us for any further query.","description":"Simpl is a Pay Later payment method.","reviewed":false},"logo":"https://hdn-1.fynd.com/payment/simpl-pg-logo.jpg"},{"key":"","secret":"","is_active":false,"product_id":"","config_type":"","webhook_secret":"","aggregator":"stripe","display":{"link":"","text":"Submitted request to be reviewed before going live. Please contact us for any further query.","description":"Stripe is a payment processor that supports online payments, credit cards, recurring subscriptions and direct payouts to bank accounts."},"logo":"https://hdn-1.fynd.com/payment/Stripe.png"}]}}}},"400":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCodeDescription"},"example":{"code":"BAD_REQUEST_ERROR","description":"Internal Server Error","success":false}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCodeDescription"},"example":{"code":"INTERNAL_SERVER_ERROR","description":"Internal Server Error","success":false}}}}}},"post":{"summary":"saveBrandPaymentGatewayConfig | Save Config Secret For Brand Payment Gateway","description":"Save Config Secret For Brand Payment Gateway","tags":["Payment"],"parameters":[{"name":"company_id","in":"path","description":"Company Id","schema":{"type":"integer"},"required":true},{"name":"application_id","in":"path","description":"Application id","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentGatewayConfigRequest"},"example":{"payubiz":{"key":"test","secret":"test","merchant_salt":"test","config_type":"fynd","is_active":true},"is_active":true,"app_id":"000000000000000000000001"}}}},"responses":{"200":{"description":"Save Config Secret For Brand Payment Gateway Success Response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentGatewayToBeReviewed"},"example":{"success":true,"aggregator":["razorpay"]}}}},"400":{"description":"Bad Request Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"example":{"success":false,"error":{"code":"BAD_REQUEST_ERROR","description":""}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"example":{"success":false,"error":{"code":"BAD_REQUEST_ERROR","description":"No row was found for one()"}}}}}}}},"/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/options":{"get":{"summary":"getPaymentModeRoutes | Get All Valid Payment Options","description":"Use this API to get Get All Valid Payment Options for making payment","tags":["Payment"],"parameters":[{"name":"company_id","in":"path","description":"Company Id","schema":{"type":"integer"},"required":true},{"name":"application_id","in":"path","description":"Application id","schema":{"type":"string"},"required":true},{"name":"refresh","in":"query","required":true,"schema":{"type":"boolean"}},{"name":"request_type","in":"query","required":true,"schema":{"type":"string"}},{"name":"order_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"shipment_id","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentOptionsResponse"},"example":{"success":true,"payment_options":{"payment_option":[{"name":"CARD","display_priority":2,"payment_mode_id":2,"display_name":"Card","list":[],"anonymous_enable":true,"aggregator_name":"Razorpay","add_card_enabled":false,"save_card":true,"types":[],"networks":[],"banks":[]},{"name":"NB","display_priority":3,"payment_mode_id":3,"display_name":"Net Banking","list":[{"aggregator_name":"Razorpay","name":"ICICI Bank","code":"ICIC","bank_name":"ICICI Bank","bank_code":"ICIC","url":"https://hdn-1.fynd.com/payment/NB_ICICI.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_ICICI.png","large":"https://hdn-1.fynd.com/payment/NB_ICICI.png"},"merchant_code":"NB_ICICI","display_priority":1,"display_name":"ICICI Bank"},{"aggregator_name":"Razorpay","name":"HDFC Bank","code":"HDFC","bank_name":"HDFC Bank","bank_code":"HDFC","url":"https://hdn-1.fynd.com/payment/NB_HDFC.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_HDFC.png","large":"https://hdn-1.fynd.com/payment/NB_HDFC.png"},"merchant_code":"NB_HDFC","display_priority":2,"display_name":"HDFC Bank"},{"aggregator_name":"Razorpay","name":"Axis Bank","code":"UTIB","bank_name":"Axis Bank","bank_code":"UTIB","url":"https://hdn-1.fynd.com/payment/NB_AXIS.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_AXIS.png","large":"https://hdn-1.fynd.com/payment/NB_AXIS.png"},"merchant_code":"NB_AXIS","display_priority":3,"display_name":"Axis Bank"},{"aggregator_name":"Razorpay","name":"State Bank of India","code":"SBIN","bank_name":"State Bank of India","bank_code":"SBIN","url":"https://hdn-1.fynd.com/payment/NB_SBI.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_SBI.png","large":"https://hdn-1.fynd.com/payment/NB_SBI.png"},"merchant_code":"NB_SBI","display_priority":4,"display_name":"State Bank of India"},{"aggregator_name":"Razorpay","name":"Kotak Mahindra Bank","code":"KKBK","bank_name":"Kotak Mahindra Bank","bank_code":"KKBK","url":"https://hdn-1.fynd.com/payment/NB_KOTAK.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_KOTAK.png","large":"https://hdn-1.fynd.com/payment/NB_KOTAK.png"},"merchant_code":"NB_KOTAK","display_priority":5,"display_name":"Kotak Mahindra Bank"},{"aggregator_name":"Razorpay","name":"Indusind Bank","code":"INDB","bank_name":"Indusind Bank","bank_code":"INDB","url":"https://hdn-1.fynd.com/payment/NB_INDUS.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_INDUS.png","large":"https://hdn-1.fynd.com/payment/NB_INDUS.png"},"merchant_code":"INDB","display_priority":6,"display_name":"Indusind Bank"},{"aggregator_name":"Razorpay","name":"City Union Bank","code":"CIUB","bank_name":"City Union Bank","bank_code":"CIUB","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"NB_CUB","display_priority":9,"display_name":"City Union Bank"},{"aggregator_name":"Razorpay","name":"Catholic Syrian Bank","code":"CSBK","bank_name":"Catholic Syrian Bank","bank_code":"CSBK","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"CSBK","display_priority":11,"display_name":"Catholic Syrian Bank"},{"aggregator_name":"Razorpay","name":"State Bank of Hyderabad","code":"SBHY","bank_name":"State Bank of Hyderabad","bank_code":"SBHY","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"NB_SBH","display_priority":12,"display_name":"State Bank of Hyderabad"},{"aggregator_name":"Razorpay","name":"Allahabad Bank","code":"ALLA","bank_name":"Allahabad Bank","bank_code":"ALLA","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"ALLA","display_priority":15,"display_name":"Allahabad Bank"},{"aggregator_name":"Razorpay","name":"Syndicate Bank","code":"SYNB","bank_name":"Syndicate Bank","bank_code":"SYNB","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"SYNB","display_priority":17,"display_name":"Syndicate Bank"},{"aggregator_name":"Razorpay","name":"Corporation Bank","code":"CORP","bank_name":"Corporation Bank","bank_code":"CORP","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"NB_CORP","display_priority":18,"display_name":"Corporation Bank"},{"aggregator_name":"Razorpay","name":"Punjab National Bank - Corporate Banking","code":"PUNB_C","bank_name":"Punjab National Bank - Corporate Banking","bank_code":"PUNB_C","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"PUNB_C","display_priority":19,"display_name":"Punjab National Bank - Corporate Banking"},{"aggregator_name":"Razorpay","name":"Canara Bank","code":"CNRB","bank_name":"Canara Bank","bank_code":"CNRB","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"NB_CANR","display_priority":20,"display_name":"Canara Bank"},{"aggregator_name":"Razorpay","name":"Saraswat Co-operative Bank","code":"SRCB","bank_name":"Saraswat Co-operative Bank","bank_code":"SRCB","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"SRCB","display_priority":21,"display_name":"Saraswat Co-operative Bank"},{"aggregator_name":"Razorpay","name":"Deutsche Bank","code":"DEUT","bank_name":"Deutsche Bank","bank_code":"DEUT","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"NB_DEUT","display_priority":22,"display_name":"Deutsche Bank"},{"aggregator_name":"Razorpay","name":"Dhanlaxmi Bank","code":"DLXB","bank_name":"Dhanlaxmi Bank","bank_code":"DLXB","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"DLXB","display_priority":24,"display_name":"Dhanlaxmi Bank"},{"aggregator_name":"Razorpay","name":"Oriental Bank of Commerce","code":"ORBC","bank_name":"Oriental Bank of Commerce","bank_code":"ORBC","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"ORBC","display_priority":25,"display_name":"Oriental Bank of Commerce"},{"aggregator_name":"Razorpay","name":"Punjab National Bank - Retail Banking","code":"PUNB_R","bank_name":"Punjab National Bank - Retail Banking","bank_code":"PUNB_R","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"PUNB_R","display_priority":26,"display_name":"Punjab National Bank - Retail Banking"},{"aggregator_name":"Razorpay","name":"State Bank of Bikaner and Jaipur","code":"SBBJ","bank_name":"State Bank of Bikaner and Jaipur","bank_code":"SBBJ","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"NB_SBBJ","display_priority":27,"display_name":"State Bank of Bikaner and Jaipur"},{"aggregator_name":"Razorpay","name":"Indian Overseas Bank","code":"IOBA","bank_name":"Indian Overseas Bank","bank_code":"IOBA","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"NB_IOB","display_priority":28,"display_name":"Indian Overseas Bank"},{"aggregator_name":"Razorpay","name":"State Bank of Travancore","code":"SBTR","bank_name":"State Bank of Travancore","bank_code":"SBTR","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"NB_SBT","display_priority":29,"display_name":"State Bank of Travancore"},{"aggregator_name":"Razorpay","name":"Airtel Payments Bank","code":"AIRP","bank_name":"Airtel Payments Bank","bank_code":"AIRP","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"AIRP","display_priority":30,"display_name":"Airtel Payments Bank"},{"aggregator_name":"Razorpay","name":"Development Bank of Singapore","code":"DBSS","bank_name":"Development Bank of Singapore","bank_code":"DBSS","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"DBSS","display_priority":31,"display_name":"Development Bank of Singapore"},{"aggregator_name":"Razorpay","name":"Vijaya Bank","code":"VIJB","bank_name":"Vijaya Bank","bank_code":"VIJB","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"NB_VJYB","display_priority":32,"display_name":"Vijaya Bank"},{"aggregator_name":"Razorpay","name":"NKGSB Co-operative Bank","code":"NKGS","bank_name":"NKGSB Co-operative Bank","bank_code":"NKGS","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"NKGS","display_priority":33,"display_name":"NKGSB Co-operative Bank"},{"aggregator_name":"Razorpay","name":"RBL Bank","code":"RATN","bank_name":"RBL Bank","bank_code":"RATN","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"RATN","display_priority":35,"display_name":"RBL Bank"},{"aggregator_name":"Razorpay","name":"Bank of Baroda - Retail Banking","code":"BARB_R","bank_name":"Bank of Baroda - Retail Banking","bank_code":"BARB_R","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"BARB_R","display_priority":36,"display_name":"Bank of Baroda - Retail Banking"},{"aggregator_name":"Razorpay","name":"Karnataka Bank","code":"KARB","bank_name":"Karnataka Bank","bank_code":"KARB","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"NB_KARN","display_priority":37,"display_name":"Karnataka Bank"},{"aggregator_name":"Razorpay","name":"Tamilnadu State Apex Co-operative Bank","code":"TNSC","bank_name":"Tamilnadu State Apex Co-operative Bank","bank_code":"TNSC","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"TNSC","display_priority":38,"display_name":"Tamilnadu State Apex Co-operative Bank"},{"aggregator_name":"Razorpay","name":"Tamilnadu Mercantile Bank","code":"TMBL","bank_name":"Tamilnadu Mercantile Bank","bank_code":"TMBL","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"TMBL","display_priority":40,"display_name":"Tamilnadu Mercantile Bank"},{"aggregator_name":"Razorpay","name":"Lakshmi Vilas Bank - Retail Banking","code":"LAVB_R","bank_name":"Lakshmi Vilas Bank - Retail Banking","bank_code":"LAVB_R","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"LAVB_R","display_priority":42,"display_name":"Lakshmi Vilas Bank - Retail Banking"},{"aggregator_name":"Razorpay","name":"Dena Bank","code":"BKDN","bank_name":"Dena Bank","bank_code":"BKDN","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"BKDN","display_priority":43,"display_name":"Dena Bank"},{"aggregator_name":"Razorpay","name":"Federal Bank","code":"FDRL","bank_name":"Federal Bank","bank_code":"FDRL","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"NB_FED","display_priority":44,"display_name":"Federal Bank"},{"aggregator_name":"Razorpay","name":"Indian Bank","code":"IDIB","bank_name":"Indian Bank","bank_code":"IDIB","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"NB_INDB","display_priority":45,"display_name":"Indian Bank"},{"aggregator_name":"Razorpay","name":"South Indian Bank","code":"SIBL","bank_name":"South Indian Bank","bank_code":"SIBL","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"NB_SOIB","display_priority":46,"display_name":"South Indian Bank"},{"aggregator_name":"Razorpay","name":"IDBI","code":"IBKL","bank_name":"IDBI","bank_code":"IBKL","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"IBKL","display_priority":49,"display_name":"IDBI"},{"aggregator_name":"Razorpay","name":"Karur Vysya Bank","code":"KVBL","bank_name":"Karur Vysya Bank","bank_code":"KVBL","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"NB_KVB","display_priority":50,"display_name":"Karur Vysya Bank"},{"aggregator_name":"Razorpay","name":"Punjab & Sind Bank","code":"PSIB","bank_name":"Punjab & Sind Bank","bank_code":"PSIB","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"PSIB","display_priority":52,"display_name":"Punjab & Sind Bank"},{"aggregator_name":"Razorpay","name":"UCO Bank","code":"UCBA","bank_name":"UCO Bank","bank_code":"UCBA","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"UCBA","display_priority":53,"display_name":"UCO Bank"},{"aggregator_name":"Razorpay","name":"Bank of Bahrein and Kuwait","code":"BBKM","bank_name":"Bank of Bahrein and Kuwait","bank_code":"BBKM","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"BBKM","display_priority":54,"display_name":"Bank of Bahrein and Kuwait"},{"aggregator_name":"Razorpay","name":"Yes Bank","code":"YESB","bank_name":"Yes Bank","bank_code":"YESB","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"NB_YESB","display_priority":55,"display_name":"Yes Bank"},{"aggregator_name":"Razorpay","name":"Punjab & Maharashtra Co-operative Bank","code":"PMCB","bank_name":"Punjab & Maharashtra Co-operative Bank","bank_code":"PMCB","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"PMCB","display_priority":56,"display_name":"Punjab & Maharashtra Co-operative Bank"},{"aggregator_name":"Razorpay","name":"Bank of India","code":"BKID","bank_name":"Bank of India","bank_code":"BKID","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"NB_BOI","display_priority":57,"display_name":"Bank of India"},{"aggregator_name":"Razorpay","name":"Bank of Maharashtra","code":"MAHB","bank_name":"Bank of Maharashtra","bank_code":"MAHB","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"NB_BOM","display_priority":58,"display_name":"Bank of Maharashtra"},{"aggregator_name":"Razorpay","name":"IDFC Bank","code":"IDFB","bank_name":"IDFC Bank","bank_code":"IDFB","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"IDFB","display_priority":59,"display_name":"IDFC Bank"},{"aggregator_name":"Razorpay","name":"Janata Sahakari Bank (Pune)","code":"JSBP","bank_name":"Janata Sahakari Bank (Pune)","bank_code":"JSBP","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"JSBP","display_priority":60,"display_name":"Janata Sahakari Bank (Pune)"},{"aggregator_name":"Razorpay","name":"Shamrao Vithal Co-operative Bank","code":"SVCB","bank_name":"Shamrao Vithal Co-operative Bank","bank_code":"SVCB","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"SVCB","display_priority":61,"display_name":"Shamrao Vithal Co-operative Bank"},{"aggregator_name":"Razorpay","name":"Cosmos Co-operative Bank","code":"COSB","bank_name":"Cosmos Co-operative Bank","bank_code":"COSB","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"COSB","display_priority":62,"display_name":"Cosmos Co-operative Bank"},{"aggregator_name":"Razorpay","name":"State Bank of Mysore","code":"SBMY","bank_name":"State Bank of Mysore","bank_code":"SBMY","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"NB_SBM","display_priority":63,"display_name":"State Bank of Mysore"},{"aggregator_name":"Razorpay","name":"Andhra Bank","code":"ANDB","bank_name":"Andhra Bank","bank_code":"ANDB","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"ANDB","display_priority":65,"display_name":"Andhra Bank"},{"aggregator_name":"Razorpay","name":"Jammu and Kashmir Bank","code":"JAKA","bank_name":"Jammu and Kashmir Bank","bank_code":"JAKA","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"NB_JNK","display_priority":66,"display_name":"Jammu and Kashmir Bank"},{"aggregator_name":"Razorpay","name":"United Bank of India","code":"UTBI","bank_name":"United Bank of India","bank_code":"UTBI","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"UTBI","display_priority":67,"display_name":"United Bank of India"},{"aggregator_name":"Razorpay","name":"Lakshmi Vilas Bank - Corporate Banking","code":"LAVB_C","bank_name":"Lakshmi Vilas Bank - Corporate Banking","bank_code":"LAVB_C","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"LAVB_C","display_priority":69,"display_name":"Lakshmi Vilas Bank - Corporate Banking"},{"aggregator_name":"Razorpay","name":"State Bank of Patiala","code":"STBP","bank_name":"State Bank of Patiala","bank_code":"STBP","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"NB_SBP","display_priority":70,"display_name":"State Bank of Patiala"},{"aggregator_name":"Razorpay","name":"DCB Bank","code":"DCBL","bank_name":"DCB Bank","bank_code":"DCBL","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"DCBL","display_priority":71,"display_name":"DCB Bank"},{"aggregator_name":"Razorpay","name":"Union Bank of India","code":"UBIN","bank_name":"Union Bank of India","bank_code":"UBIN","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"NB_UBI","display_priority":73,"display_name":"Union Bank of India"},{"aggregator_name":"Razorpay","name":"Standard Chartered Bank","code":"SCBL","bank_name":"Standard Chartered Bank","bank_code":"SCBL","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"SCBL","display_priority":74,"display_name":"Standard Chartered Bank"}]},{"name":"WL","display_priority":4,"payment_mode_id":4,"display_name":"Wallet","list":[{"wallet_name":"Paytm","wallet_code":"paytm","name":"Paytm","display_name":"Paytm","code":"PAYTM","wallet_id":4,"merchant_code":"PAYTM","logo_url":{"small":"https://hdn-1.fynd.com/payment/paytm_logo_small.png","large":"https://hdn-1.fynd.com/payment/paytm_logo_large.png"},"aggregator_name":"Juspay","display_priority":1},{"wallet_name":"Mobikwik","wallet_code":"mobikwik","name":"Mobikwik","display_name":"Mobikwik","code":"MOBIKWIK","wallet_id":5,"merchant_code":"MOBIKWIK","logo_url":{"small":"https://hdn-1.fynd.com/payment/mobikwik_logo_small.png","large":"https://hdn-1.fynd.com/payment/mobikwik_logo_small.png"},"aggregator_name":"Juspay","display_priority":3},{"wallet_name":"Ola Money","wallet_code":"olamoney","name":"Ola Money","display_name":"Ola Money","code":"OLAMONEY","wallet_id":6,"merchant_code":"OLAMONEY","logo_url":{"small":"https://hdn-1.fynd.com/payment/olamoney.png","large":"https://hdn-1.fynd.com/payment/olamoney.png"},"aggregator_name":"Razorpay","display_priority":4},{"wallet_name":"Amazon Pay","wallet_code":"amazonpay","name":"Amazon Pay","display_name":"Amazon Pay","code":"AMAZONPAY","wallet_id":10,"merchant_code":"AMAZONPAY","logo_url":{"small":"https://hdn-1.fynd.com/payment/amazon-pay.png","large":"https://hdn-1.fynd.com/payment/amazon-pay.png"},"aggregator_name":"Razorpay","display_priority":9},{"wallet_name":"PayPal","wallet_code":"paypal","name":"PayPal","display_name":"PayPal","code":"PAYPAL","wallet_id":11,"merchant_code":"PAYPAL","logo_url":{"small":"https://hdn-1.fynd.com/payment/paypal.jpg","large":"https://hdn-1.fynd.com/payment/paypal.jpg"},"aggregator_name":"Razorpay","display_priority":10}]},{"name":"UPI","display_priority":9,"payment_mode_id":7,"display_name":"UPI","list":[{"aggregator_name":"Razorpay","name":"UPI","display_name":"BHIM UPI","code":"UPI","logo_url":{"large":"https://hdn-1.fynd.com/payment/upi_150x100.png","small":"https://hdn-1.fynd.com/payment/upi_100x78.png"},"merchant_code":"UPI","timeout":240,"retry_count":0,"fynd_vpa":"shopsense.rzp@hdfcbank","intent_flow":true,"intent_app":[{"code":"google_pay","display_name":"Google Pay","package_name":"com.google.android.apps.nbu.paisa.user","logos":{"small":"https://hdn-1.fynd.com/payment/upi-google-pay.png","large":"https://hdn-1.fynd.com/payment/upi-google-pay.png"}}],"intent_app_error_list":["com.csam.icici.bank.imobile","in.org.npci.upiapp","com.whatsapp"],"intent_app_error_dict_list":[{"package_name":"com.csam.icici.bank.imobile","code":"icici"},{"package_name":"in.org.npci.upiapp","code":"upiapp"},{"package_name":"com.whatsapp","code":"whatsapp"}]}]},{"name":"EMI","display_priority":18,"payment_mode_id":19,"display_name":"Easy EMI","list":[{"aggregator_name":"Razorpay","name":"EMI","display_name":"Easy EMI","code":"EMI","logo_url":{"large":"https://hdn-1.fynd.com/payment/Pos+Logo.png","small":"https://hdn-1.fynd.com/payment/Pos+Logo.png"},"merchant_code":"EMI"}]},{"name":"JUSPAYPG","display_priority":18,"payment_mode_id":23,"display_name":"Pay Using Juspay","list":[{"aggregator_name":"Juspay","name":"JUSPAYPG","display_name":"Pay Using Juspay","code":"JUSPAYPG","logo_url":{"large":"https://hdn-1.fynd.com/payment/netbanking.png","small":"https://hdn-1.fynd.com/payment/netbanking.png"},"merchant_code":"JUSPAYPG"}]},{"name":"PG_PAYMENT","display_priority":20,"display_name":"Other payment gateway","list":[{"aggregator_name":"Stripe","name":"STRIPEPG","display_name":"Pay using Stripe","code":"STRIPEPG","logo_url":{"large":"https://hdn-1.fynd.com/payment/Pos+Logo.png","small":"https://hdn-1.fynd.com/payment/Pos+Logo.png"},"merchant_code":"STRIPEPG"},{"aggregator_name":"Ccavenue","name":"CCAVENUEPG","display_name":"Pay using Ccavenue","code":"CCAVENUEPG","logo_url":{"large":"https://hdn-1.fynd.com/payment/Pos+Logo.png","small":"https://hdn-1.fynd.com/payment/Pos+Logo.png"},"merchant_code":"CCAVENUEPG"},{"aggregator_name":"Payumoney","name":"PAYUMONEYPG","display_name":"Pay using Payumoney","code":"PAYUMONEYPG","logo_url":{"large":"https://fynd-obscuro-media-new.s3.amazonaws.com/payment/payu_logo_large.png","small":"https://fynd-obscuro-media-new.s3.amazonaws.com/payment/payu_logo_small.png"},"merchant_code":"PAYUMONEYPG"},{"aggregator_name":"Payubiz","name":"PAYUBIZPG","display_name":"Pay using Payubiz","code":"PAYUBIZPG","logo_url":{"large":"https://hdn-1.fynd.com/payment/payu.png","small":"https://hdn-1.fynd.com/payment/payu.png"},"merchant_code":"PAYUBIZPG"}]},{"name":"PL","display_priority":21,"display_name":"Pay Later","list":[{"aggregator_name":"Simpl","name":"Simpl","display_name":"Simpl","code":"SIMPL","merchant_code":"SIMPL","logo":"https://hdn-1.fynd.com/payment/simpl_logo.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/simpl_logo.png","large":"https://hdn-1.fynd.com/payment/simpl_logo.png"}},{"aggregator_name":"Rupifi","name":"RUPIFIPG","display_name":"Pay using Rupifi","code":"RUPIFIPG","logo_url":{"large":"https://hdn-1.fynd.com/payment/Rupifi.png","small":"https://hdn-1.fynd.com/payment/Rupifi.png"},"merchant_code":"RUPIFIPG"}]}]}}}}},"400":{"description":"Bad Request Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"example":{"success":false,"error":{"code":"BAD_REQUEST_ERROR","description":""}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"example":{"success":false,"error":{"code":"INTERNAL_SERVER_ERROR","description":""}}}}}}}},"/service/platform/payment/v1.0/company/{company_id}/payouts":{"get":{"summary":"getAllPayouts | Get All Payouts","description":"Get All Payouts","tags":["Payment"],"parameters":[{"name":"company_id","in":"path","description":"Company Id","schema":{"type":"integer"},"required":true},{"name":"unique_external_id","in":"query","description":"Fetch payouts using unique external id","schema":{"type":"string"}}],"responses":{"200":{"description":"payouts response object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutsResponse"},"example":{"items":[{"unique_transfer_no":"d2ff79fcd3459831864824da8c9d7e5f","more_attributes":{"city":"","state":"","country":"","bank_name":"YES","ifsc_code":"IFSCYES101","account_no":"9876541234","branch_name":"Mumbai","account_type":"current","account_holder":"Vikas Kumar"},"transfer_type":"bank","is_default":true,"is_active":true,"customers":{"id":2,"name":"reliance retail","mobile":"1234567890","email":"reliance@gmail.com","unique_external_id":"company:1"},"payouts_aggregators":[{"payout_details_id":888,"aggregator_id":3,"aggregator_fund_id":null}]},{"unique_transfer_no":"e388c1c5df4933fa01f6da9f92595589","more_attributes":{"city":"","state":"","country":"","bank_name":"SBI","ifsc_code":"SBIN0011513","account_no":"9876543210","branch_name":"Mumbai","account_type":"saving","account_holder":"Vikas Kumar"},"transfer_type":"bank","is_default":false,"is_active":true,"customers":{"id":2,"name":"reliance retail","mobile":"1234567890","email":"reliance@gmail.com","unique_external_id":"company:1"},"payouts_aggregators":[{"payout_details_id":891,"aggregator_id":3,"aggregator_fund_id":null}]}],"success":true}}}},"400":{"description":"Bad Request Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"example":{"success":false,"error":{"code":"BAD_REQUEST_ERROR","description":""}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"example":{"success":false,"error":{"code":"INTERNAL_SERVER_ERROR","description":""}}}}}}},"post":{"summary":"savePayout | Save Payout","description":"Save Payout","tags":["Payment"],"parameters":[{"name":"company_id","in":"path","description":"Company Id","schema":{"type":"integer"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutRequest"},"example":{"unique_external_id":"company:1","transfer_type":"bank","aggregator":"Razorpay","is_active":true,"users":{"unique_external_id":"company:1","name":"reliance retail","email":"reliance@gmail.com","mobile":"1234567890"},"bank_details":{"country":"","state":"","city":"","account_no":"9876543210","bank_name":"SBI","branch_name":"Mumbai","account_holder":"Vikas Kumar","ifsc_code":"SBIN0011513","account_type":"saving"}}}}},"responses":{"200":{"description":"save payout response object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutResponse"},"example":{"success":true,"is_active":true,"bank_details":{"account_type":"saving","account_holder":"Vikas Kumar","branch_name":"Mumbai","country":"","ifsc_code":"SBIN0011513","account_no":"9876543210","city":"","state":"","bank_name":"SBI"},"unique_transfer_no":"e388c1c5df4933fa01f6da9f92595589","users":{"name":"reliance retail","unique_external_id":"company:1","mobile":"1234567890","email":"reliance@gmail.com"},"aggregator":"Razorpay","transfer_type":"bank","created":true,"payouts":{"aggregator_fund_id":null},"payment_status":"payout_initiated"}}}},"400":{"description":"Bad Request Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"example":{"success":false,"error":{"code":"BAD_REQUEST_ERROR","description":""}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"example":{"success":false,"error":{"code":"INTERNAL_SERVER_ERROR","description":""}}}}}}}},"/service/platform/payment/v1.0/company/{company_id}/payouts/{unique_transfer_no}":{"put":{"summary":"updatePayout | Update Payout","description":"Update Payout","tags":["Payment"],"parameters":[{"name":"company_id","in":"path","description":"Company Id","schema":{"type":"integer"},"required":true},{"name":"unique_transfer_no","in":"path","description":"Unique transfer id","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutRequest"},"example":{"unique_external_id":"company:1","transfer_type":"bank","aggregator":"Razorpay","is_active":true,"users":{"unique_external_id":"company:1","name":"reliance retail","email":"reliance@gmail.com","mobile":"1234567890"},"bank_details":{"country":"","state":"","city":"","account_no":"9876543210","bank_name":"SBI","branch_name":"Mumbai","account_holder":"Vikas Kumar","ifsc_code":"SBIN0011513","account_type":"saving"}}}}},"responses":{"200":{"description":"save payout response object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePayoutResponse"},"example":{"success":true,"is_default":true,"is_active":true}}}},"400":{"description":"Bad Request Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"example":{"success":false,"error":{"code":"BAD_REQUEST_ERROR","description":""}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"example":{"success":false,"error":{"code":"INTERNAL_SERVER_ERROR","description":""}}}}}}},"patch":{"summary":"activateAndDectivatePayout | Partial Update Payout","description":"Partial Update Payout","tags":["Payment"],"parameters":[{"name":"company_id","in":"path","description":"Company Id","schema":{"type":"integer"},"required":true},{"name":"unique_transfer_no","in":"path","description":"Unique transfer id","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePayoutRequest"},"example":{"is_active":true,"is_default":true,"unique_external_id":"company:1"}}}},"responses":{"200":{"description":"save payout response object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePayoutResponse"},"example":{"success":true,"is_default":true,"is_active":true}}}},"400":{"description":"Bad Request Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"example":{"success":false,"error":{"code":"BAD_REQUEST_ERROR","description":""}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"example":{"success":false,"error":{"code":"INTERNAL_SERVER_ERROR","description":""}}}}}}},"delete":{"summary":"deletePayout | Delete Payout","description":"Delete Payout","tags":["Payment"],"parameters":[{"name":"company_id","in":"path","description":"Company Id","schema":{"type":"integer"},"required":true},{"name":"unique_transfer_no","in":"path","description":"Unique transfer id","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"delete payout response object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeletePayoutResponse"},"example":{"success":true}}}},"400":{"description":"Bad Request Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"example":{"success":false,"error":{"code":"BAD_REQUEST_ERROR","description":""}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"example":{"success":false,"error":{"code":"INTERNAL_SERVER_ERROR","description":""}}}}}}}},"/service/platform/payment/v1.0/company/{company_id}/subscription/methods":{"get":{"summary":"getSubscriptionPaymentMethod | List Subscription Payment Method","description":"Get all  Subscription  Payment Method","tags":["Payment"],"parameters":[{"name":"company_id","in":"path","description":"Company Id","schema":{"type":"integer"},"required":true},{"name":"unique_external_id","in":"query","description":"Unique external id","schema":{"type":"string"}}],"responses":{"200":{"description":"List Subscription Payment Method Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionPaymentMethodResponse"},"example":{"success":true,"data":[{"id":68,"type":"card","pg_payment_method_id":"pm_1H8HyIJ1ZTFIN1aD5eDOL4nU","data":{"brand":"visa","last4":"4242","checks":{"cvc_check":"pass","address_line1_check":null,"address_postal_code_check":null},"wallet":null,"country":"US","funding":"credit","exp_year":2044,"networks":{"available":["visa"],"preferred":null},"exp_month":12,"fingerprint":"0aror24meTf8iYfw","generated_from":null,"three_d_secure_usage":{"supported":true}},"is_default":false},{"id":81,"type":"card","pg_payment_method_id":"pm_1Hc7tMJ1ZTFIN1aDCvMIIBeT","data":{"brand":"visa","last4":"4242","checks":{"cvc_check":"pass","address_line1_check":null,"address_postal_code_check":null},"wallet":null,"country":"US","funding":"credit","exp_year":2020,"networks":{"available":["visa"],"preferred":null},"exp_month":11,"fingerprint":"0aror24meTf8iYfw","generated_from":null,"three_d_secure_usage":{"supported":true}},"is_default":true},{"id":93,"type":"card","pg_payment_method_id":"pm_1HvddjJ1ZTFIN1aDgebQvuyi","data":{"brand":"visa","last4":"4242","checks":{"cvc_check":"pass","address_line1_check":"pass","address_postal_code_check":"pass"},"wallet":null,"country":"US","funding":"credit","exp_year":2022,"networks":{"available":["visa"],"preferred":null},"exp_month":11,"fingerprint":"0aror24meTf8iYfw","generated_from":null,"three_d_secure_usage":{"supported":true}},"is_default":false},{"id":98,"type":"card","pg_payment_method_id":"pm_1IJDF0J1ZTFIN1aDnJFi4i2v","data":{"brand":"visa","last4":"1111","checks":{"cvc_check":"pass","address_line1_check":"pass","address_postal_code_check":"pass"},"wallet":null,"country":"US","funding":"credit","exp_year":2025,"networks":{"available":["visa"],"preferred":null},"exp_month":11,"fingerprint":"ZtDTGycouUEup4Q4","generated_from":null,"three_d_secure_usage":{"supported":true}},"is_default":false}]}}}},"400":{"description":"Bad Request Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"example":{"success":false,"error":{"code":"BAD_REQUEST_ERROR","description":""}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"example":{"success":false,"error":{"code":"INTERNAL_SERVER_ERROR","description":""}}}}}}},"delete":{"summary":"deleteSubscriptionPaymentMethod | Delete Subscription Payment Method","description":"Uses this api to Delete Subscription Payment Method","tags":["Payment"],"parameters":[{"name":"company_id","in":"path","description":"Company Id","schema":{"type":"integer"},"required":true},{"name":"unique_external_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"payment_method_id","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Delete Subscription Payment Method Response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteSubscriptionPaymentMethodResponse"},"example":{"success":true}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"example":{"error":{"code":"INTERNAL_SERVER_ERROR","description":"Internal Server Error"},"success":false}}}}}}},"/service/platform/payment/v1.0/company/{company_id}/subscription/configs":{"get":{"summary":"getSubscriptionConfig | List Subscription Config","description":"Get all  Subscription Config details","tags":["Payment"],"parameters":[{"name":"company_id","in":"path","description":"Company Id","schema":{"type":"integer"},"required":true}],"responses":{"200":{"description":"List Subscription Config Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionConfigResponse"},"example":{"success":true,"aggregator":"stripe","config":{"public_key":"pk_test_lHBf12TZLa5"}}}}},"400":{"description":"Bad Request Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"example":{"success":false,"error":{"code":"BAD_REQUEST_ERROR","description":""}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"example":{"success":false,"error":{"code":"INTERNAL_SERVER_ERROR","description":""}}}}}}}},"/service/platform/payment/v1.0/company/{company_id}/subscription/setup/intent":{"post":{"summary":"saveSubscriptionSetupIntent | Save Subscription Setup Intent","description":"Uses this api to Save Subscription Setup Intent","tags":["Payment"],"parameters":[{"name":"company_id","in":"path","description":"Company Id","schema":{"type":"integer"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaveSubscriptionSetupIntentRequest"},"example":{"unique_external_id":"company:1"}}}},"responses":{"200":{"description":"Save Subscription Setup Intent Response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaveSubscriptionSetupIntentResponse"},"example":{"success":true,"data":{"id":"test","object":"test","client_secret":"test","customer":"test","status":"requires_payment_method"}}}}},"400":{"description":"Bad Request Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"example":{"success":false,"error":{"code":"BAD_REQUEST_ERROR","description":""}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"example":{"success":false,"error":{"code":"INTERNAL_SERVER_ERROR","description":""}}}}}}}},"/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/refund/account":{"get":{"summary":"getBankAccountDetailsOpenAPI | Get bank details","description":"Use this API to get saved bank details for returned/cancelled order using order id.","tags":["Payment"],"parameters":[{"in":"query","name":"order_id","required":true,"schema":{"type":"string"}},{"in":"query","name":"request_hash","required":false,"schema":{"type":"string"}},{"name":"company_id","in":"path","description":"Company Id","schema":{"type":"integer"},"required":true},{"name":"application_id","in":"path","description":"Application id","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefundAccountResponse"},"example":{"message":"Refund Success","success":true,"data":{"account_no":"XXXX-XXXX-6682","ifsc_code":"SBIEXAMPLE001","email":"loremipsum@example.com","address":"1773  Monroe Street","bank_name":"SBI","branch_name":"HOUSTON","comment":"Lorem Ipsum","account_holder":"Leslie Rice","mobile":"0987654321"}}}}},"400":{"description":"Bad Request Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResourceError"},"example":{"success":false,"code":"BAD_REQUEST_ERROR","description":"Bad Request"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"example":{"error":{"code":"INTERNAL_SERVER_ERROR","description":""},"success":false}}}}}},"post":{"summary":"addRefundBankAccountUsingOTP | Save bank details for cancelled/returned order","description":"Use this API to save bank details for returned/cancelled order to refund amount in his account.","tags":["Payment"],"parameters":[{"name":"company_id","in":"path","description":"Company Id","schema":{"type":"integer"},"required":true},{"name":"application_id","in":"path","description":"Application id","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddBeneficiaryDetailsOTPRequest"},"example":{"details":{"account_holder":"shashi bro","account_no":"000100289877623","address":"A-402, HARI SMRUTI BLDG, KHANDWALA LANE","bank_name":"Test","branch_name":"Test1","comment":"Test","email":"abc@example.com","ifsc_code":"SBIN0008752","mobile":"9999999999"},"order_id":"FY5DD3F05A09120FFE4B","transfer_mode":"bank","shipment_id":"16100144824381402124","delights":false}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefundAccountResponse"},"example":{"success":true,"message":"Account successfully created","data":{},"is_verified_flag":true}}}},"400":{"description":"Bad Request Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResourceError"},"example":{"success":false,"code":"BAD_REQUEST_ERROR","description":"Order not found!"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"example":{"error":{"code":"INTERNAL_SERVER_ERROR","description":"Internal Server Error"},"success":false}}}}}}},"/service/platform/payment/v1.0/company/{company_id}/ifsc-code/verify":{"get":{"summary":"verifyIfscCode | Ifsc Code Verification","description":"Get True or False for correct IFSC Code for adding bank details for refund","tags":["Payment"],"parameters":[{"name":"company_id","in":"path","description":"Company Id","schema":{"type":"integer"},"required":true},{"name":"ifsc_code","in":"query","schema":{"type":"string","description":"Fetch bank details for correct ifsc code"}}],"responses":{"200":{"description":"Bank details on correct Ifsc Code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IfscCodeResponse"},"example":{"branch_name":"MANPUR","bank_name":"GAYA","BRANCH":"MANPUR","CENTRE":"GAYA","DISTRICT":"GAYA","STATE":"BIHAR","ADDRESS":"POBUNIYADGANJBIHAR","CONTACT":"00","MICR":"816002103","UPI":true,"RTGS":true,"CITY":"GAYA","NEFT":true,"IMPS":true,"SWIFT":"","BANK":"State Bank of India","BANKCODE":"SBIN","IFSC":"SBIN0005611","success":true}}}},"400":{"description":"Bad Request Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResourceError"},"example":{"success":false,"code":"BAD_REQUEST_ERROR","description":"Ifsc Not found"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCodeDescription"},"example":{"code":"INTERNAL_SERVER_ERROR","description":"Internal Server Error","success":false}}}}}}},"/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/refund/accounts/order":{"get":{"summary":"getUserOrderBeneficiaries | List Order Beneficiary","description":"Get all active  beneficiary details added by the user for refund","tags":["Payment"],"parameters":[{"in":"query","name":"order_id","required":true,"schema":{"type":"string"}},{"name":"company_id","in":"path","description":"Company Id","schema":{"type":"integer"},"required":true},{"name":"application_id","in":"path","description":"Application id","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"List Order Beneficiary","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderBeneficiaryResponse"},"example":{"beneficiaries":[{"id":3695,"beneficiary_id":"4c86dd56e634a4c6a8fb51d195bc7b83","bank_name":"State Bank of India","branch_name":"BHOGAT","account_holder":"PRAKASH TEST","account_no":"3566342455454","ifsc_code":"SBIN0014982","mobile":"7819064010","email":"prakashtest@gmail.com","address":"49A, Dabhi seri, jodhpur, kalyanpur","comment":"COD Refund","is_active":true,"created_on":"2021-01-22 11:31:02","modified_on":"2021-01-22 11:31:02","display_name":"BANK","transfer_mode":"bank","title":"Bank Account","subtitle":"35663423659","delights_user_name":"shreeniwas_24x7_gmail_com_45978_16624463"}]}}}},"400":{"description":"Bad Request Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResourceError"},"example":{"success":false,"code":"BAD_REQUEST_ERROR","description":"Order not found!"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"example":{"error":{"code":"INTERNAL_SERVER_ERROR","description":"Internal Server Error"},"success":false}}}}}}},"/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/refund/accounts/user":{"get":{"summary":"getUserBeneficiaries | List User Beneficiary","description":"Get all active  beneficiary details added by the user for refund","tags":["Payment"],"parameters":[{"in":"query","name":"order_id","required":true,"schema":{"type":"string"}},{"name":"company_id","in":"path","description":"Company Id","schema":{"type":"integer"},"required":true},{"name":"application_id","in":"path","description":"Application id","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"List User Beneficiary","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderBeneficiaryResponse"},"example":{"beneficiaries":[{"id":221,"beneficiary_id":"0f7e44a922df352c05c5f73cb40ba115","bank_name":"State Bank of India","branch_name":"State Bank of India","account_holder":"SHASHI TEST","account_no":"1234567891","ifsc_code":"SBIN0005611","mobile":"9112042174","email":"payment@gofynd.com","address":"204A","comment":"","is_active":true,"created_on":"2020-06-29 12:38:39","modified_on":"2020-06-29 12:38:39","display_name":"BANK","transfer_mode":"bank","title":"Bank Account","subtitle":"1234567891","delights_user_name":null}],"show_beneficiary_details":false}}}},"400":{"description":"Bad Request Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResourceError"},"example":{"success":false,"code":"BAD_REQUEST_ERROR","description":"Order not found!"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"example":{"error":{"code":"INTERNAL_SERVER_ERROR","description":"Internal Server Error"},"success":false}}}}}}},"/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/confirm":{"post":{"summary":"confirmPayment | Confirm payment after successful payment from payment gateway","description":"Use this API to confirm payment after payment gateway accepted payment.","tags":["Payment"],"parameters":[{"name":"company_id","in":"path","description":"Company Id","schema":{"type":"integer"},"required":true},{"name":"application_id","in":"path","description":"Application id","schema":{"type":"string"},"required":true}],"requestBody":{"description":"Check the example of a request body below or refer `PaymentConfirmationRequestSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentConfirmationRequest"},"example":{"order_id":"FY60F90AEF01FF43E878","payment_methods":[{"mode":"PP","amount":123,"name":"prepaid","meta":{"order_id":"order_Hbs6ehtThDyJBf","payment_id":"pay_Hbs7Bm0cg07I2W","current_status":"captured","payment_gateway":"Razorpay"}},{"mode":"COD","name":"cod","amount":123,"meta":{}},{"name":"gift_card","mode":"GFTCRD","amount":123,"meta":{"key":"value"}}]}}}},"responses":{"200":{"description":"Success. Returns the status of payment. Check the example shown below or refer `PaymentConfirmationResponseSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentConfirmationResponse"},"example":{"success":true,"message":"Payment Successful","order_id":"FY60F90AEF01FF43E878"}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"example":{"success":false,"error":{"code":"BAD_REQUEST_ERROR","description":"Some thing wrong in payload"}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"example":{"success":false,"error":{"code":"INTERNAL_SERVER_ERROR","description":"Something went wrong on server. We are looking into it."}}}}}}}},"/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/user-cod":{"get":{"summary":"getUserCODlimitRoutes | Get COD limit for user","description":"Use this API to get user cod limit and reamining limit for the payment","tags":["Payment"],"parameters":[{"name":"company_id","in":"path","description":"Company Id","schema":{"type":"integer"},"required":true},{"name":"application_id","in":"path","description":"Application id","schema":{"type":"string"},"required":true},{"name":"merchant_user_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"mobile_no","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success. Returns user cod limit , remaining limit and usage of user for COD. Check the example shown below or refer `GetUserCODLimitResponseSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetUserCODLimitResponse"},"example":{"success":true,"user_cod_data":{"is_active":true,"user_id":"abc","usages":1000,"limit":10000,"remaining_limit":9000,"merchant_user_id":"5e199e6998cfe1776f1385dc"}}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"example":{"success":false,"error":{"code":"BAD_REQUEST_ERROR","description":""}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"example":{"success":false,"error":{"code":"INTERNAL_SERVER_ERROR","description":""}}}}}}},"put":{"summary":"setUserCODlimitRoutes | Set COD option for user for payment","description":"Use this API to set cod option as true or false for the payment","tags":["Payment"],"parameters":[{"name":"company_id","in":"path","description":"Company ID","schema":{"type":"integer"},"required":true},{"name":"application_id","in":"path","description":"Application id","schema":{"type":"string"},"required":true}],"requestBody":{"description":"Check the example of a request body below or refer `PaymentConfirmationRequestSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetCODForUserRequest"},"example":{"is_active":true,"merchant_user_id":"5e199e6998cfe1776f1385dc","mobileno":"9999632145"}}}},"responses":{"200":{"description":"Success. Returns true or false for user cod option for payment. Check the example shown below or refer `GetUserCODLimitResponseSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetCODOptionResponse"},"example":{"success":true,"message":"COD option for user {} is set to {}"}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"example":{"success":false,"error":{"code":"BAD_REQUEST_ERROR","description":""}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"example":{"success":false,"error":{"code":"INTERNAL_SERVER_ERROR","description":""}}}}}}}},"/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/edc-aggregator-list":{"get":{"summary":"edcAggregatorsAndModelList | get some information about the store and edc device","description":"Use this API to get info of devices linked to a particular app.","tags":["Payment"],"parameters":[{"name":"company_id","in":"path","description":"Company Id","schema":{"type":"integer"},"required":true},{"name":"application_id","in":"path","description":"Application id","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Success. Returns the list of devices linked to the application Check the example shown below or refer `EdcAggregatorAndModelListResponseSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EdcAggregatorAndModelListResponse"},"example":{"success":true,"data":[{"aggregator":"Pinelabs","aggregator_id":17,"models":["A910","A920"]}]}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResourceError"},"example":{"success":false,"code":"BAD_REQUEST_ERROR","description":""}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"example":{"success":false,"error":{"code":"INTERNAL_SERVER_ERROR","description":"Something went wrong on server. We are looking into it."}}}}}}}},"/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/edc-device-stats":{"get":{"summary":"edcDeviceStats | get some information about the store and edc device","description":"Use this API to get info of devices linked to a particular app.","tags":["Payment"],"parameters":[{"name":"company_id","in":"path","description":"Company Id","schema":{"type":"integer"},"required":true},{"name":"application_id","in":"path","description":"Application id","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Success. Returns the list of devices linked to the application Check the example shown below or refer `EdcDeviceStatsResponseSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EdcDeviceStatsResponse"},"example":{"success":true,"statistics":{"active_device_count":2,"inactive_device_count":0}}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResourceError"},"example":{"success":false,"code":"BAD_REQUEST_ERROR","description":""}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"example":{"success":false,"error":{"code":"INTERNAL_SERVER_ERROR","description":"Something went wrong on server. We are looking into it."}}}}}}}},"/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/edc-device":{"post":{"summary":"updateEdcDevice | map new edc device to the terminal","description":"Use this API to map new edc device to the terminal","tags":["Payment"],"parameters":[{"name":"company_id","in":"path","description":"Company Id","schema":{"type":"integer"},"required":true},{"name":"application_id","in":"path","description":"Application id","schema":{"type":"string"},"required":true}],"requestBody":{"description":"Check the example of a request body below or refer `EdcAddRequestSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EdcAddRequest"},"example":{"aggregator_id":1,"terminal_serial_no":"15c26ee7297e4334","edc_device_serial_no":"123456784","store_id":12312,"edc_model":"A910","device_tag":"Counter 2"}}}},"responses":{"200":{"description":"Success. Returns the single edc device mapped to the terminal. Check the example shown below or refer `EdcDeviceAddResponseSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EdcDeviceAddResponse"},"example":{"success":true,"data":{"application_id":"2","aggregator_id":1,"terminal_serial_no":"15c26ee7297e4334","edc_device_serial_no":"123456784","terminal_unique_identifier":"1231208734","merchant_store_pos_code":null,"store_id":12312,"device_tag":"Counter 2","is_active":false,"edc_model":"A910"}}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResourceError"},"example":{"success":false,"code":"BAD_REQUEST_ERROR","description":""}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"example":{"success":false,"error":{"code":"INTERNAL_SERVER_ERROR","description":"Something went wrong on server. We are looking into it."}}}}}}}},"/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/edc-device/{terminal_unique_identifier}":{"get":{"summary":"getEdcDevice | get details of a single edc device","description":"Use this API to get details of a single edc device","tags":["Payment"],"parameters":[{"name":"company_id","in":"path","description":"Company Id","schema":{"type":"integer"},"required":true},{"name":"application_id","in":"path","description":"Application id","schema":{"type":"string"},"required":true},{"name":"terminal_unique_identifier","in":"path","description":"Terminal unique identifier","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Success. Returns the single edc device mapped to the terminal. Check the example shown below or refer `EdcDeviceDetailsResponseSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EdcDeviceDetailsResponse"},"example":{"success":true,"data":{"application_id":"2","terminal_serial_no":"15c26ee7297e4334","edc_device_serial_no":"123456784","terminal_unique_identifier":"1231208734","merchant_store_pos_code":"12345123","store_id":12312,"aggregator_id":17,"aggregator_name":"Pinelabs","device_tag":"Counter 2","is_active":true,"edc_model":"A910"}}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResourceError"},"example":{"success":false,"code":"BAD_REQUEST_ERROR","description":""}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"example":{"success":false,"error":{"code":"INTERNAL_SERVER_ERROR","description":"Something went wrong on server. We are looking into it."}}}}}}},"put":{"summary":"addEdcDevice | Update store id and device tag of edc device","description":"Use this API to Update store id and device tag of edc device","tags":["Payment"],"parameters":[{"name":"company_id","in":"path","description":"Company Id","schema":{"type":"integer"},"required":true},{"name":"application_id","in":"path","description":"Application id","schema":{"type":"string"},"required":true},{"name":"terminal_unique_identifier","in":"path","description":"Terminal unique identifier","schema":{"type":"string"},"required":true}],"requestBody":{"description":"Check the example of a request body below or refer `EdcUpdateRequestSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EdcUpdateRequest"},"example":{"store_id":12312,"edc_device_serial_no":"123456784","merchant_store_pos_code":"122120009","device_tag":"Counter 200","is_active":true,"aggregator_id":17,"edc_model":"A910"}}}},"responses":{"200":{"description":"Check the example shown below or refer `EdcDeviceUpdateResponseSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EdcDeviceUpdateResponse"},"example":{"success":true}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResourceError"},"example":{"success":false,"code":"BAD_REQUEST_ERROR","description":""}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"example":{"success":false,"error":{"code":"INTERNAL_SERVER_ERROR","description":"Something went wrong on server. We are looking into it."}}}}}}}},"/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/edc-device-list":{"get":{"summary":"edcDeviceList | get all the device list of an app","description":"Use this API to get all devices linked to a particular app.","tags":["Payment"],"parameters":[{"in":"query","name":"page_no","required":false,"schema":{"type":"integer"}},{"in":"query","name":"page_size","required":false,"schema":{"type":"integer"}},{"in":"query","name":"is_active","required":false,"schema":{"type":"boolean"}},{"in":"query","name":"store_id","required":false,"schema":{"type":"integer"}},{"in":"query","name":"device_tag","required":false,"schema":{"type":"string"}},{"name":"company_id","in":"path","description":"Company Id","schema":{"type":"integer"},"required":true},{"name":"application_id","in":"path","description":"Application id","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Success. Returns the list of devices linked to the application Check the example shown below or refer `EdcDeviceListResponseSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EdcDeviceListResponse"},"example":{"success":true,"page":{"type":"number","size":1,"current":1,"has_next":false,"item_total":2},"items":[{"application_id":"2","terminal_serial_no":"15c26ee7297e4331","edc_device_serial_no":"123456781","terminal_unique_identifier":"1231242081","merchant_store_pos_code":"122120009","store_id":12312,"aggregator_id":17,"aggregator_name":"Pinelabs","device_tag":"Counter 2","is_active":true,"edc_model":"A910"}]}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResourceError"},"example":{"success":false,"code":"BAD_REQUEST_ERROR","description":""}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"example":{"success":false,"error":{"code":"INTERNAL_SERVER_ERROR","description":"Something went wrong on server. We are looking into it."}}}}}}}},"/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/options/pos":{"get":{"summary":"getPosPaymentModeRoutes | Get All Valid Payment Options","description":"Use this API to get Get All Valid Payment Options for making payment","tags":["Payment"],"parameters":[{"name":"company_id","in":"path","description":"Company Id","schema":{"type":"integer"},"required":true},{"name":"application_id","in":"path","description":"Application id","schema":{"type":"string"},"required":true},{"name":"amount","in":"query","description":"Payable amount.","required":true,"schema":{"type":"integer"}},{"name":"cart_id","in":"query","description":"Identifier of the cart.","required":false,"schema":{"type":"string"}},{"name":"pincode","in":"query","description":"The PIN Code of the destination address, e.g. 400059","required":true,"schema":{"type":"string"}},{"name":"checkout_mode","in":"query","description":"Option to checkout for self or for others.","required":false,"schema":{"type":"string"}},{"name":"refresh","in":"query","description":"This is a boolean value. Select `true` to remove temporary cache files on payment gateway and replace with the latest one.","schema":{"type":"boolean"}},{"name":"order_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"card_reference","in":"query","description":"Card reference id of user's debit or credit card.","schema":{"type":"string"}},{"name":"order_type","in":"query","required":true,"description":"The order type of shipment * HomeDelivery - If the customer wants the order home-delivered * PickAtStore - If the customer wants the handover of an order at the store itself.","schema":{"type":"string"}},{"name":"user_details","in":"query","description":"URIencoded JSON containing details of an anonymous user.","example":"%7B%22first_name%22:%22Fynd%22,%22last_name%22:%22Dummy%22,%22mobile%22:%229999999999%22,%22email%22:%22paymentsdummy@gofynd.com%22%7D","schema":{"type":"string"}},{"name":"display_split","in":"query","description":"Display Split Payment Option or not","schema":{"type":"boolean"}},{"name":"advance_payment","in":"query","description":"Display Advance Payment Options or Normal","schema":{"type":"boolean"}},{"name":"shipment_id","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentModeRouteResponse"},"example":{"success":true,"payment_options":{"payment_option":[{"name":"CARD","display_priority":2,"payment_mode_id":2,"display_name":"Card","list":[],"anonymous_enable":true,"aggregator_name":"Razorpay","add_card_enabled":false,"save_card":true,"types":[],"networks":[],"banks":[]},{"name":"NB","display_priority":3,"payment_mode_id":3,"display_name":"Net Banking","list":[{"aggregator_name":"Razorpay","name":"ICICI Bank","code":"ICIC","bank_name":"ICICI Bank","bank_code":"ICIC","url":"https://hdn-1.fynd.com/payment/NB_ICICI.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_ICICI.png","large":"https://hdn-1.fynd.com/payment/NB_ICICI.png"},"merchant_code":"NB_ICICI","display_priority":1,"display_name":"ICICI Bank"},{"aggregator_name":"Razorpay","name":"HDFC Bank","code":"HDFC","bank_name":"HDFC Bank","bank_code":"HDFC","url":"https://hdn-1.fynd.com/payment/NB_HDFC.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_HDFC.png","large":"https://hdn-1.fynd.com/payment/NB_HDFC.png"},"merchant_code":"NB_HDFC","display_priority":2,"display_name":"HDFC Bank"},{"aggregator_name":"Razorpay","name":"Axis Bank","code":"UTIB","bank_name":"Axis Bank","bank_code":"UTIB","url":"https://hdn-1.fynd.com/payment/NB_AXIS.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_AXIS.png","large":"https://hdn-1.fynd.com/payment/NB_AXIS.png"},"merchant_code":"NB_AXIS","display_priority":3,"display_name":"Axis Bank"},{"aggregator_name":"Razorpay","name":"State Bank of India","code":"SBIN","bank_name":"State Bank of India","bank_code":"SBIN","url":"https://hdn-1.fynd.com/payment/NB_SBI.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_SBI.png","large":"https://hdn-1.fynd.com/payment/NB_SBI.png"},"merchant_code":"NB_SBI","display_priority":4,"display_name":"State Bank of India"},{"aggregator_name":"Razorpay","name":"Kotak Mahindra Bank","code":"KKBK","bank_name":"Kotak Mahindra Bank","bank_code":"KKBK","url":"https://hdn-1.fynd.com/payment/NB_KOTAK.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_KOTAK.png","large":"https://hdn-1.fynd.com/payment/NB_KOTAK.png"},"merchant_code":"NB_KOTAK","display_priority":5,"display_name":"Kotak Mahindra Bank"},{"aggregator_name":"Razorpay","name":"Indusind Bank","code":"INDB","bank_name":"Indusind Bank","bank_code":"INDB","url":"https://hdn-1.fynd.com/payment/NB_INDUS.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_INDUS.png","large":"https://hdn-1.fynd.com/payment/NB_INDUS.png"},"merchant_code":"INDB","display_priority":6,"display_name":"Indusind Bank"},{"aggregator_name":"Razorpay","name":"City Union Bank","code":"CIUB","bank_name":"City Union Bank","bank_code":"CIUB","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"NB_CUB","display_priority":9,"display_name":"City Union Bank"},{"aggregator_name":"Razorpay","name":"Catholic Syrian Bank","code":"CSBK","bank_name":"Catholic Syrian Bank","bank_code":"CSBK","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"CSBK","display_priority":11,"display_name":"Catholic Syrian Bank"},{"aggregator_name":"Razorpay","name":"State Bank of Hyderabad","code":"SBHY","bank_name":"State Bank of Hyderabad","bank_code":"SBHY","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"NB_SBH","display_priority":12,"display_name":"State Bank of Hyderabad"},{"aggregator_name":"Razorpay","name":"Allahabad Bank","code":"ALLA","bank_name":"Allahabad Bank","bank_code":"ALLA","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"ALLA","display_priority":15,"display_name":"Allahabad Bank"},{"aggregator_name":"Razorpay","name":"Syndicate Bank","code":"SYNB","bank_name":"Syndicate Bank","bank_code":"SYNB","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"SYNB","display_priority":17,"display_name":"Syndicate Bank"},{"aggregator_name":"Razorpay","name":"Corporation Bank","code":"CORP","bank_name":"Corporation Bank","bank_code":"CORP","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"NB_CORP","display_priority":18,"display_name":"Corporation Bank"},{"aggregator_name":"Razorpay","name":"Punjab National Bank - Corporate Banking","code":"PUNB_C","bank_name":"Punjab National Bank - Corporate Banking","bank_code":"PUNB_C","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"PUNB_C","display_priority":19,"display_name":"Punjab National Bank - Corporate Banking"},{"aggregator_name":"Razorpay","name":"Canara Bank","code":"CNRB","bank_name":"Canara Bank","bank_code":"CNRB","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"NB_CANR","display_priority":20,"display_name":"Canara Bank"},{"aggregator_name":"Razorpay","name":"Saraswat Co-operative Bank","code":"SRCB","bank_name":"Saraswat Co-operative Bank","bank_code":"SRCB","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"SRCB","display_priority":21,"display_name":"Saraswat Co-operative Bank"},{"aggregator_name":"Razorpay","name":"Deutsche Bank","code":"DEUT","bank_name":"Deutsche Bank","bank_code":"DEUT","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"NB_DEUT","display_priority":22,"display_name":"Deutsche Bank"},{"aggregator_name":"Razorpay","name":"Dhanlaxmi Bank","code":"DLXB","bank_name":"Dhanlaxmi Bank","bank_code":"DLXB","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"DLXB","display_priority":24,"display_name":"Dhanlaxmi Bank"},{"aggregator_name":"Razorpay","name":"Oriental Bank of Commerce","code":"ORBC","bank_name":"Oriental Bank of Commerce","bank_code":"ORBC","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"ORBC","display_priority":25,"display_name":"Oriental Bank of Commerce"},{"aggregator_name":"Razorpay","name":"Punjab National Bank - Retail Banking","code":"PUNB_R","bank_name":"Punjab National Bank - Retail Banking","bank_code":"PUNB_R","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"PUNB_R","display_priority":26,"display_name":"Punjab National Bank - Retail Banking"},{"aggregator_name":"Razorpay","name":"State Bank of Bikaner and Jaipur","code":"SBBJ","bank_name":"State Bank of Bikaner and Jaipur","bank_code":"SBBJ","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"NB_SBBJ","display_priority":27,"display_name":"State Bank of Bikaner and Jaipur"},{"aggregator_name":"Razorpay","name":"Indian Overseas Bank","code":"IOBA","bank_name":"Indian Overseas Bank","bank_code":"IOBA","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"NB_IOB","display_priority":28,"display_name":"Indian Overseas Bank"},{"aggregator_name":"Razorpay","name":"State Bank of Travancore","code":"SBTR","bank_name":"State Bank of Travancore","bank_code":"SBTR","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"NB_SBT","display_priority":29,"display_name":"State Bank of Travancore"},{"aggregator_name":"Razorpay","name":"Airtel Payments Bank","code":"AIRP","bank_name":"Airtel Payments Bank","bank_code":"AIRP","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"AIRP","display_priority":30,"display_name":"Airtel Payments Bank"},{"aggregator_name":"Razorpay","name":"Development Bank of Singapore","code":"DBSS","bank_name":"Development Bank of Singapore","bank_code":"DBSS","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"DBSS","display_priority":31,"display_name":"Development Bank of Singapore"},{"aggregator_name":"Razorpay","name":"Vijaya Bank","code":"VIJB","bank_name":"Vijaya Bank","bank_code":"VIJB","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"NB_VJYB","display_priority":32,"display_name":"Vijaya Bank"},{"aggregator_name":"Razorpay","name":"NKGSB Co-operative Bank","code":"NKGS","bank_name":"NKGSB Co-operative Bank","bank_code":"NKGS","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"NKGS","display_priority":33,"display_name":"NKGSB Co-operative Bank"},{"aggregator_name":"Razorpay","name":"RBL Bank","code":"RATN","bank_name":"RBL Bank","bank_code":"RATN","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"RATN","display_priority":35,"display_name":"RBL Bank"},{"aggregator_name":"Razorpay","name":"Bank of Baroda - Retail Banking","code":"BARB_R","bank_name":"Bank of Baroda - Retail Banking","bank_code":"BARB_R","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"BARB_R","display_priority":36,"display_name":"Bank of Baroda - Retail Banking"},{"aggregator_name":"Razorpay","name":"Karnataka Bank","code":"KARB","bank_name":"Karnataka Bank","bank_code":"KARB","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"NB_KARN","display_priority":37,"display_name":"Karnataka Bank"},{"aggregator_name":"Razorpay","name":"Tamilnadu State Apex Co-operative Bank","code":"TNSC","bank_name":"Tamilnadu State Apex Co-operative Bank","bank_code":"TNSC","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"TNSC","display_priority":38,"display_name":"Tamilnadu State Apex Co-operative Bank"},{"aggregator_name":"Razorpay","name":"Tamilnadu Mercantile Bank","code":"TMBL","bank_name":"Tamilnadu Mercantile Bank","bank_code":"TMBL","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"TMBL","display_priority":40,"display_name":"Tamilnadu Mercantile Bank"},{"aggregator_name":"Razorpay","name":"Lakshmi Vilas Bank - Retail Banking","code":"LAVB_R","bank_name":"Lakshmi Vilas Bank - Retail Banking","bank_code":"LAVB_R","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"LAVB_R","display_priority":42,"display_name":"Lakshmi Vilas Bank - Retail Banking"},{"aggregator_name":"Razorpay","name":"Dena Bank","code":"BKDN","bank_name":"Dena Bank","bank_code":"BKDN","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"BKDN","display_priority":43,"display_name":"Dena Bank"},{"aggregator_name":"Razorpay","name":"Federal Bank","code":"FDRL","bank_name":"Federal Bank","bank_code":"FDRL","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"NB_FED","display_priority":44,"display_name":"Federal Bank"},{"aggregator_name":"Razorpay","name":"Indian Bank","code":"IDIB","bank_name":"Indian Bank","bank_code":"IDIB","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"NB_INDB","display_priority":45,"display_name":"Indian Bank"},{"aggregator_name":"Razorpay","name":"South Indian Bank","code":"SIBL","bank_name":"South Indian Bank","bank_code":"SIBL","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"NB_SOIB","display_priority":46,"display_name":"South Indian Bank"},{"aggregator_name":"Razorpay","name":"IDBI","code":"IBKL","bank_name":"IDBI","bank_code":"IBKL","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"IBKL","display_priority":49,"display_name":"IDBI"},{"aggregator_name":"Razorpay","name":"Karur Vysya Bank","code":"KVBL","bank_name":"Karur Vysya Bank","bank_code":"KVBL","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"NB_KVB","display_priority":50,"display_name":"Karur Vysya Bank"},{"aggregator_name":"Razorpay","name":"Punjab & Sind Bank","code":"PSIB","bank_name":"Punjab & Sind Bank","bank_code":"PSIB","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"PSIB","display_priority":52,"display_name":"Punjab & Sind Bank"},{"aggregator_name":"Razorpay","name":"UCO Bank","code":"UCBA","bank_name":"UCO Bank","bank_code":"UCBA","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"UCBA","display_priority":53,"display_name":"UCO Bank"},{"aggregator_name":"Razorpay","name":"Bank of Bahrein and Kuwait","code":"BBKM","bank_name":"Bank of Bahrein and Kuwait","bank_code":"BBKM","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"BBKM","display_priority":54,"display_name":"Bank of Bahrein and Kuwait"},{"aggregator_name":"Razorpay","name":"Yes Bank","code":"YESB","bank_name":"Yes Bank","bank_code":"YESB","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"NB_YESB","display_priority":55,"display_name":"Yes Bank"},{"aggregator_name":"Razorpay","name":"Punjab & Maharashtra Co-operative Bank","code":"PMCB","bank_name":"Punjab & Maharashtra Co-operative Bank","bank_code":"PMCB","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"PMCB","display_priority":56,"display_name":"Punjab & Maharashtra Co-operative Bank"},{"aggregator_name":"Razorpay","name":"Bank of India","code":"BKID","bank_name":"Bank of India","bank_code":"BKID","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"NB_BOI","display_priority":57,"display_name":"Bank of India"},{"aggregator_name":"Razorpay","name":"Bank of Maharashtra","code":"MAHB","bank_name":"Bank of Maharashtra","bank_code":"MAHB","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"NB_BOM","display_priority":58,"display_name":"Bank of Maharashtra"},{"aggregator_name":"Razorpay","name":"IDFC Bank","code":"IDFB","bank_name":"IDFC Bank","bank_code":"IDFB","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"IDFB","display_priority":59,"display_name":"IDFC Bank"},{"aggregator_name":"Razorpay","name":"Janata Sahakari Bank (Pune)","code":"JSBP","bank_name":"Janata Sahakari Bank (Pune)","bank_code":"JSBP","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"JSBP","display_priority":60,"display_name":"Janata Sahakari Bank (Pune)"},{"aggregator_name":"Razorpay","name":"Shamrao Vithal Co-operative Bank","code":"SVCB","bank_name":"Shamrao Vithal Co-operative Bank","bank_code":"SVCB","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"SVCB","display_priority":61,"display_name":"Shamrao Vithal Co-operative Bank"},{"aggregator_name":"Razorpay","name":"Cosmos Co-operative Bank","code":"COSB","bank_name":"Cosmos Co-operative Bank","bank_code":"COSB","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"COSB","display_priority":62,"display_name":"Cosmos Co-operative Bank"},{"aggregator_name":"Razorpay","name":"State Bank of Mysore","code":"SBMY","bank_name":"State Bank of Mysore","bank_code":"SBMY","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"NB_SBM","display_priority":63,"display_name":"State Bank of Mysore"},{"aggregator_name":"Razorpay","name":"Andhra Bank","code":"ANDB","bank_name":"Andhra Bank","bank_code":"ANDB","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"ANDB","display_priority":65,"display_name":"Andhra Bank"},{"aggregator_name":"Razorpay","name":"Jammu and Kashmir Bank","code":"JAKA","bank_name":"Jammu and Kashmir Bank","bank_code":"JAKA","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"NB_JNK","display_priority":66,"display_name":"Jammu and Kashmir Bank"},{"aggregator_name":"Razorpay","name":"United Bank of India","code":"UTBI","bank_name":"United Bank of India","bank_code":"UTBI","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"UTBI","display_priority":67,"display_name":"United Bank of India"},{"aggregator_name":"Razorpay","name":"Lakshmi Vilas Bank - Corporate Banking","code":"LAVB_C","bank_name":"Lakshmi Vilas Bank - Corporate Banking","bank_code":"LAVB_C","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"LAVB_C","display_priority":69,"display_name":"Lakshmi Vilas Bank - Corporate Banking"},{"aggregator_name":"Razorpay","name":"State Bank of Patiala","code":"STBP","bank_name":"State Bank of Patiala","bank_code":"STBP","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"NB_SBP","display_priority":70,"display_name":"State Bank of Patiala"},{"aggregator_name":"Razorpay","name":"DCB Bank","code":"DCBL","bank_name":"DCB Bank","bank_code":"DCBL","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"DCBL","display_priority":71,"display_name":"DCB Bank"},{"aggregator_name":"Razorpay","name":"Union Bank of India","code":"UBIN","bank_name":"Union Bank of India","bank_code":"UBIN","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"NB_UBI","display_priority":73,"display_name":"Union Bank of India"},{"aggregator_name":"Razorpay","name":"Standard Chartered Bank","code":"SCBL","bank_name":"Standard Chartered Bank","bank_code":"SCBL","url":"https://hdn-1.fynd.com/payment/NB_generic.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/NB_generic.png","large":"https://hdn-1.fynd.com/payment/NB_generic.png"},"merchant_code":"SCBL","display_priority":74,"display_name":"Standard Chartered Bank"}]},{"name":"WL","display_priority":4,"payment_mode_id":4,"display_name":"Wallet","list":[{"wallet_name":"Paytm","wallet_code":"paytm","name":"Paytm","display_name":"Paytm","code":"PAYTM","wallet_id":4,"merchant_code":"PAYTM","logo_url":{"small":"https://hdn-1.fynd.com/payment/paytm_logo_small.png","large":"https://hdn-1.fynd.com/payment/paytm_logo_large.png"},"aggregator_name":"Juspay","display_priority":1},{"wallet_name":"Mobikwik","wallet_code":"mobikwik","name":"Mobikwik","display_name":"Mobikwik","code":"MOBIKWIK","wallet_id":5,"merchant_code":"MOBIKWIK","logo_url":{"small":"https://hdn-1.fynd.com/payment/mobikwik_logo_small.png","large":"https://hdn-1.fynd.com/payment/mobikwik_logo_small.png"},"aggregator_name":"Juspay","display_priority":3},{"wallet_name":"Ola Money","wallet_code":"olamoney","name":"Ola Money","display_name":"Ola Money","code":"OLAMONEY","wallet_id":6,"merchant_code":"OLAMONEY","logo_url":{"small":"https://hdn-1.fynd.com/payment/olamoney.png","large":"https://hdn-1.fynd.com/payment/olamoney.png"},"aggregator_name":"Razorpay","display_priority":4},{"wallet_name":"Amazon Pay","wallet_code":"amazonpay","name":"Amazon Pay","display_name":"Amazon Pay","code":"AMAZONPAY","wallet_id":10,"merchant_code":"AMAZONPAY","logo_url":{"small":"https://hdn-1.fynd.com/payment/amazon-pay.png","large":"https://hdn-1.fynd.com/payment/amazon-pay.png"},"aggregator_name":"Razorpay","display_priority":9},{"wallet_name":"PayPal","wallet_code":"paypal","name":"PayPal","display_name":"PayPal","code":"PAYPAL","wallet_id":11,"merchant_code":"PAYPAL","logo_url":{"small":"https://hdn-1.fynd.com/payment/paypal.jpg","large":"https://hdn-1.fynd.com/payment/paypal.jpg"},"aggregator_name":"Razorpay","display_priority":10}]},{"name":"UPI","display_priority":9,"payment_mode_id":7,"display_name":"UPI","list":[{"aggregator_name":"Razorpay","name":"UPI","display_name":"BHIM UPI","code":"UPI","logo_url":{"large":"https://hdn-1.fynd.com/payment/upi_150x100.png","small":"https://hdn-1.fynd.com/payment/upi_100x78.png"},"merchant_code":"UPI","timeout":240,"retry_count":0,"fynd_vpa":"shopsense.rzp@hdfcbank","intent_flow":true,"intent_app":[{"code":"google_pay","display_name":"Google Pay","package_name":"com.google.android.apps.nbu.paisa.user","logos":{"small":"https://hdn-1.fynd.com/payment/upi-google-pay.png","large":"https://hdn-1.fynd.com/payment/upi-google-pay.png"}}],"intent_app_error_list":["com.csam.icici.bank.imobile","in.org.npci.upiapp","com.whatsapp"],"intent_app_error_dict_list":[{"package_name":"com.csam.icici.bank.imobile","code":"icici"},{"package_name":"in.org.npci.upiapp","code":"upiapp"},{"package_name":"com.whatsapp","code":"whatsapp"}]}]},{"name":"EMI","display_priority":18,"payment_mode_id":19,"display_name":"Easy EMI","list":[{"aggregator_name":"Razorpay","name":"EMI","display_name":"Easy EMI","code":"EMI","logo_url":{"large":"https://hdn-1.fynd.com/payment/Pos+Logo.png","small":"https://hdn-1.fynd.com/payment/Pos+Logo.png"},"merchant_code":"EMI"}]},{"name":"JUSPAYPG","display_priority":18,"payment_mode_id":23,"display_name":"Pay Using Juspay","list":[{"aggregator_name":"Juspay","name":"JUSPAYPG","display_name":"Pay Using Juspay","code":"JUSPAYPG","logo_url":{"large":"https://hdn-1.fynd.com/payment/netbanking.png","small":"https://hdn-1.fynd.com/payment/netbanking.png"},"merchant_code":"JUSPAYPG"}]},{"name":"PG_PAYMENT","display_priority":20,"display_name":"Other payment gateway","list":[{"aggregator_name":"Stripe","name":"STRIPEPG","display_name":"Pay using Stripe","code":"STRIPEPG","logo_url":{"large":"https://hdn-1.fynd.com/payment/Pos+Logo.png","small":"https://hdn-1.fynd.com/payment/Pos+Logo.png"},"merchant_code":"STRIPEPG"},{"aggregator_name":"Ccavenue","name":"CCAVENUEPG","display_name":"Pay using Ccavenue","code":"CCAVENUEPG","logo_url":{"large":"https://hdn-1.fynd.com/payment/Pos+Logo.png","small":"https://hdn-1.fynd.com/payment/Pos+Logo.png"},"merchant_code":"CCAVENUEPG"},{"aggregator_name":"Payumoney","name":"PAYUMONEYPG","display_name":"Pay using Payumoney","code":"PAYUMONEYPG","logo_url":{"large":"https://fynd-obscuro-media-new.s3.amazonaws.com/payment/payu_logo_large.png","small":"https://fynd-obscuro-media-new.s3.amazonaws.com/payment/payu_logo_small.png"},"merchant_code":"PAYUMONEYPG"},{"aggregator_name":"Payubiz","name":"PAYUBIZPG","display_name":"Pay using Payubiz","code":"PAYUBIZPG","logo_url":{"large":"https://hdn-1.fynd.com/payment/payu.png","small":"https://hdn-1.fynd.com/payment/payu.png"},"merchant_code":"PAYUBIZPG"}]},{"name":"PL","display_priority":21,"display_name":"Pay Later","list":[{"aggregator_name":"Simpl","name":"Simpl","display_name":"Simpl","code":"SIMPL","merchant_code":"SIMPL","logo":"https://hdn-1.fynd.com/payment/simpl_logo.png","logo_url":{"small":"https://hdn-1.fynd.com/payment/simpl_logo.png","large":"https://hdn-1.fynd.com/payment/simpl_logo.png"}},{"aggregator_name":"Rupifi","name":"RUPIFIPG","display_name":"Pay using Rupifi","code":"RUPIFIPG","logo_url":{"large":"https://hdn-1.fynd.com/payment/Rupifi.png","small":"https://hdn-1.fynd.com/payment/Rupifi.png"},"merchant_code":"RUPIFIPG"}]}]},"advance_payment":[{"name":"SPLIT","display_priority":22,"payment_mode_id":34,"display_name":"Split Payment","list":[{"aggregator_name":"Fynd","name":"Split Payment","display_name":"Split Payment","code":"SPLIT","logo_url":{"small":"https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/fyndnp/wrkr/testz0/misc/default-assets/original/yDRf9iyLbH-PosLogo.png","large":"https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/fyndnp/wrkr/testz0/misc/default-assets/original/yDRf9iyLbH-PosLogo.png"},"merchant_code":"SPLIT"}],"split":{"total_number_of_splits":7,"splits_remaining":7}},{"name":"ADVANCE","display_priority":22,"payment_mode_id":35,"display_name":"Advance Payment","list":[{"aggregator_name":"Fynd","name":"Advance Payment","display_name":"Advance Payment","code":"ADVANCE","logo_url":{"small":"https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/fyndnp/wrkr/testz0/misc/default-assets/original/yDRf9iyLbH-PosLogo.png","large":"https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/fyndnp/wrkr/testz0/misc/default-assets/original/yDRf9iyLbH-PosLogo.png"},"merchant_code":"ADVANCE"}],"advance":{"is_active":true,"time_unit":"DAYS","description":"Pay Rs 3000 or more of the total amount","display_name":"Pay using Advance Payment","prepayment_type":"PERCENTAGE","prepayment_value":20,"cancellation_type":"AUTO","refund_time_limit":4,"all_prepayment_type":["PERCENTAGE","FIXED"],"allow_custom_advance_amount":true}}]}}}},"400":{"description":"Bad Request Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"example":{"success":false,"error":{"code":"BAD_REQUEST_ERROR","description":""}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"example":{"success":false,"error":{"code":"INTERNAL_SERVER_ERROR","description":""}}}}}}}},"/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/request":{"post":{"summary":"initialisePayment | Initialize a payment (server-to-server) for UPI and BharatQR","description":"PUse this API to inititate payment using UPI, BharatQR, wherein the UPI requests are send to the app and QR code is displayed on the screen.","tags":["Payment"],"parameters":[{"name":"company_id","in":"path","description":"Company Id","schema":{"type":"integer"},"required":true},{"name":"application_id","in":"path","description":"Application id","schema":{"type":"string"},"required":true}],"requestBody":{"description":"Check the example of a request body below or refer `PaymentInitializationRequest` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentInitializationRequest"},"example":{"amount":10000,"order_id":"lorem_GX8W00p2ipsum","email":"dummy@example.com","contact":"9876543210","currency":"INR","customer_id":"cust_lorem_001","method":"upi","aggregator":"UPI_Razorpay","merchant_order_id":"FY000120000101","vpa":"success@razopray","device_id":"1234567890"}}}},"responses":{"200":{"description":"Success. Check the example shown below or refer `PaymentInitializationResponse` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentInitializationResponse"},"example":{"success":true,"aggregator":"UPI_Razorpay","method":"upi","status":"success","merchant_order_id":"FY000120000101","aggregator_order_id":"lorem_GX8W00p2ipsum","polling_url":"https://api.fynd.com/service/application/payment/v0.1/payments/confirm/polling/?app_id=000000000000000000000001","timeout":240,"virtual_id":null,"razorpay_payment_id":"pay_dummy_001","customer_id":"cust_dummy_001","device_id":"1234567890"}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"example":{"success":false,"aggregator":"UPI_Razorpay","method":"upi","error":{"code":"BAD_REQUEST_ERROR","description":"Invalid VPA. Please enter a valid Virtual Payment Address","source":null,"step":null,"reason":null,"metadata":{},"field":"vpa"}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"example":{"success":false,"error":{"code":"INTERNAL_SERVER_ERROR","description":"Something went wrong on server. We are looking into it."}}}}}}}},"/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/confirm/polling":{"post":{"summary":"checkAndUpdatePaymentStatus | Performs continuous polling to check status of payment on the server","description":"Use this API to perform continuous polling at intervals to check the status of payment until timeout.","tags":["Payment"],"parameters":[{"name":"company_id","in":"path","description":"Company Id","schema":{"type":"integer"},"required":true},{"name":"application_id","in":"path","description":"Application id","schema":{"type":"string"},"required":true}],"requestBody":{"description":"Check the example of a request body below or refer `PaymentStatusUpdateRequest` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentStatusUpdateRequest"},"example":{"merchant_transaction_id":"merchant_id","status":"Paid","amount":10000,"order_id":"lorem_GX8W00p2ipsum","email":"dummy@example.com","contact":"9876543210","currency":"INR","customer_id":"cust_lorem_001","method":"upi","aggregator":"UPI_Razorpay","merchant_order_id":"FY000120000101","vpa":"success@razopray","device_id":"1234567890"}}}},"responses":{"200":{"description":"Success. Returns the status of payment. Check the example shown below or refer `PaymentStatusUpdateResponse` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentStatusUpdateResponse"},"example":{"aggregator_name":"UPI_Razorpay","status":"success","retry":false}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"example":{"success":false,"error":{"code":"BAD_REQUEST_ERROR","description":"Some thing wrong in payload"}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"example":{"success":false,"error":{"code":"INTERNAL_SERVER_ERROR","description":"Something went wrong on server. We are looking into it."}}}}}}}},"/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/cancel":{"post":{"summary":"resendOrCancelPayment | API to resend and cancel a payment link which was already generated.","description":"Use this API to perform resend or cancel a payment link based on request payload.","tags":["Payment"],"parameters":[{"name":"company_id","in":"path","description":"Company Id","schema":{"type":"integer"},"required":true},{"name":"application_id","in":"path","description":"Application id","schema":{"type":"string"},"required":true}],"requestBody":{"description":"Check the example of a request body below or refer `ResendOrCancelPaymentRequest` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResendOrCancelPaymentRequest"},"example":{"order_id":"FY615DE25839C4AF3A5A","request_type":"cancel/resend","device_id":"1234567890"}}}},"responses":{"200":{"description":"Success. Returns the status of payment. Check the example shown below or refer `ResendOrCancelPaymentResponse` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResendOrCancelPaymentResponse"},"examples":{"request_type is cancel":{"value":{"success":true,"data":{"message":"Payment link Cancelled.","status":true}}},"request_type is resend":{"value":{"success":true,"data":{"message":"Notification triggered.","status":true}}}}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"example":{"success":false,"error":{"code":"BAD_REQUEST_ERROR","description":"Some thing wrong in payload"}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"example":{"success":false,"error":{"code":"INTERNAL_SERVER_ERROR","description":"Something went wrong on server. We are looking into it."}}}}}}}},"/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/payment-status-bulk/":{"post":{"summary":"paymentStatusBulk | Get Payment status and information for a list of order_ids","description":"Use this API to get Payment status and information for a list of order_ids","tags":["Payment"],"parameters":[{"name":"company_id","in":"path","description":"Company Id","schema":{"type":"integer"},"required":true},{"name":"application_id","in":"path","description":"Application id","schema":{"type":"string"},"required":true}],"requestBody":{"description":"Check the example of a request body below or refer `PaymentConfirmationRequestSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentStatusBulkHandlerRequest"},"example":{"merchant_order_id":["FY63C7B7D860DFC8F71A","FY63C7C40299476A9289"]}}}},"responses":{"200":{"description":"Success. Returns the status of payment. Check the example shown below or refer `PaymentConfirmationResponseSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentStatusBulkHandlerResponse"},"example":{"status":0,"success":"true","count":2,"data":[{"merchant_order_id":"FY63C7B7D860DFC8F71A","payment_object_list":[{"id":"FY63C7B7D860DFC8F71A","payment_id":"123","amount_in_paisa":"10000","currency":"INR","current_status":"started","all_status":["started","pending","complete"],"payment_mode":"Udhaari","payment_mode_identifier":"Udhaari","payment_gateway":"Fynd","application_id":"5cc04264ad924cea93ded855","company_id":"1","collected_by":"fynd","refunded_by":"fynd","created_on":"2023-01-18 14:41:53","modified_on":"2023-01-18 14:41:53","user_object":{"id":"615d39cf8a3b80b2427a4644","email":"pratikpatel@gofynd.com","mobile_number":"8879805874","merchant_user_id":"615d39cf8a3b80b2427a4644"},"aggregator_payment_object":{"trans_id":"123"},"refund_object":{}},{"id":"FY63C7B7D860DFC8F71A","payment_id":"123","amount_in_paisa":"2180000","currency":"INR","current_status":"started","all_status":["started","pending","complete"],"payment_mode":"UPI","payment_mode_identifier":"UPI","payment_gateway":"Razorpay","application_id":"5cc04264ad924cea93ded855","company_id":"1","collected_by":"fynd","refunded_by":"fynd","created_on":"2023-01-18 14:41:53","modified_on":"2023-01-18 14:41:53","user_object":{"id":"615d39cf8a3b80b2427a4644","email":"pratikpatel@gofynd.com","mobile_number":"8879805874","merchant_user_id":"615d39cf8a3b80b2427a4644"},"aggregator_payment_object":{"trans_id":"123"},"refund_object":{}}]}]}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"example":{"success":false,"error":{"code":"BAD_REQUEST_ERROR","description":"Some thing wrong in payload"}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"example":{"success":false,"error":{"code":"INTERNAL_SERVER_ERROR","description":"Something went wrong on server. We are looking into it."}}}}}}}},"/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/onboard/{aggregator}/":{"get":{"summary":"oauthGetUrl | API to Get the url to call for oauth","description":"Use this API to Get the url to call for oauth.","tags":["Payment"],"parameters":[{"name":"company_id","in":"path","description":"Company Id","schema":{"type":"integer"},"required":true},{"name":"application_id","in":"path","description":"Application id","schema":{"type":"string"},"required":true},{"name":"aggregator","in":"path","description":"aggregator","schema":{"type":"string"},"required":true},{"in":"query","name":"success_redirect_url","schema":{"type":"string","description":"This is the url which will come back to after success authorization complete"}},{"in":"query","name":"failure_redirect_url","schema":{"type":"string","description":"This is the url which will come back to after failure authorization"}}],"responses":{"200":{"description":"Success. Returns the status of payment. Check the example shown below or refer `GetOauthUrlResponseSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOauthUrlResponse"},"example":{"success":true,"url":"https://auth.razorpay.com/authorize?client_id=LlCp1Mj6YW6jFc&response_type=code&redirect_uri=http://localhost:8000/v1.0/partnership/authorize/razorpay&scope=read_only&state=000000000000000000000001"}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"example":{"error":{"code":"BAD_REQUEST","description":"Bad Request"},"success":false,"data":{"status":"failed"},"message":"error message"}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"example":{"error":{"code":"INTERNAL_SERVER_ERROR","description":"Internal Server Error"},"success":false,"data":{"status":"failed"},"message":"error message"}}}}}}},"/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/revoke/{aggregator}/":{"post":{"summary":"revokeOauthToken | API to Revoke oauth for razorpay partnership","description":"Use this API to Revoke oauth for razorpay partnership","tags":["Payment"],"parameters":[{"name":"company_id","in":"path","description":"Company Id","schema":{"type":"integer"},"required":true},{"name":"application_id","in":"path","description":"Application id","schema":{"type":"string"},"required":true},{"name":"aggregator","in":"path","description":"aggregator_slug","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Success. Returns the status of revokation. Check the example shown below or refer `RevokeOAuthTokenSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RevokeOAuthToken"},"example":{"success":true,"message":"Token Revoked"}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"example":{"error":{"code":"BAD_REQUEST","description":"Bad Request"},"success":false,"data":{"status":"failed"},"message":"error message"}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"example":{"error":{"code":"INTERNAL_SERVER_ERROR","description":"Internal Server Access"},"success":false,"data":{"status":"failed"},"message":"error message"}}}}}}},"/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/repayment-details":{"post":{"summary":"repaymentDetails | API to register repayment details","description":"Use this API to register any repayment record in the db and notify the aggrgator","tags":["Payment"],"parameters":[{"name":"company_id","in":"path","description":"Company Id","schema":{"type":"integer"},"required":true},{"name":"application_id","in":"path","description":"Application id","schema":{"type":"string"},"required":true}],"requestBody":{"description":"Check the example of a request body below.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RepaymentDetailsSerialiserPayAll"},"example":{"shipment_details":[{"outstanding_details_id":1487,"fwd_shipment_id":"2","merchant_order_id":"FY62F4C2A962451E9E62","amount":2190,"aggregator":"jiopay","aggregator_order_id":"rpsl_2","aggregator_transaction_id":"rpsl_trans_2","current_status":"complete","payment_mode":"UPI","payment_mode_identifier":"UPI"}],"extension_order_id":"603e8f17-dfc5-4ec0-b966-f66efbd75dd5","total_amount":1530,"aggregator_transaction_id":"rpsl_2","aggregator_order_id":"rpsl_trans_2"}}}},"responses":{"200":{"description":"Success. Returns the status of API. Check the example shown below or refer `RepaymentResponseSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RepaymentResponse"},"example":{"success":true,"data":{"status":true}}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"example":{"error":{"code":"BAD_REQUEST","description":""},"success":false,"data":{"status":"failed"},"message":"error message"}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"example":{"error":{"code":"INTERNAL_SERVER_ERROR","description":""},"success":false,"data":{"status":"failed"},"message":"error message"}}}}}}},"/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/merchant-onboarding":{"post":{"summary":"merchantOnBoarding | API to push Ajiodhan merchant data to Gringotts system","description":"Use this API to push Ajiodhan merchant data to Gringotts system","tags":["Payment"],"parameters":[{"name":"company_id","in":"path","description":"Company Id","schema":{"type":"integer"},"required":true},{"name":"application_id","in":"path","description":"Application id","schema":{"type":"string"},"required":true}],"requestBody":{"description":"Check the example of a request body below.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MerchantOnBoardingRequest"},"example":{"user_id":"62fc8e8551580d35ff8b8c77","credit_line_id":"100002000062250","app_id":"000000000000000000000001","status":"ACTIVE","aggregator":"ajiodhan"}}}},"responses":{"200":{"description":"Success. Returns the status of API. Check the example shown below or refer `RepaymentResponseSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MerchantOnBoardingResponse"},"example":{"success":true,"data":{"status":true,"status_code":200,"message":"Merchant onboarding details saved"}}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"example":{"error":{"code":"BAD_REQUEST","description":""},"success":false,"data":{"status":"failed"},"message":"error message"}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"example":{"error":{"code":"INTERNAL_SERVER_ERROR","description":""},"success":false,"data":{"status":"failed"},"message":"error message"}}}}}}},"/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/customer/validation":{"post":{"summary":"verifyCustomerForPayment | Validate customer for payment","description":"Use this API to check if the customer is eligible to use credit-line facilities such as Simpl Pay Later and Rupifi.","tags":["Payment"],"parameters":[{"name":"company_id","in":"path","description":"Company Id","schema":{"type":"integer"},"required":true},{"name":"application_id","in":"path","description":"Application id","schema":{"type":"string"},"required":true}],"requestBody":{"description":"Pass the payload, payment aggregator, phone number and other details in the request body as shown below.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidateCustomerRequest"},"example":{"payload":"hashed_encoded_payload","order_items":[{"sku":"1","price":100,"quantity":1}],"delivery_address":{"line1":"string","line2":"string","city":"string","state":"string","country":"string","pincode":"string","type":"string","geoLocation":{"latitude":"string","longitude":"string"}},"billing_address":{"line1":"string","line2":"string","city":"string","state":"string","country":"string","pincode":"string","type":"string","geoLocation":{"latitude":"string","longitude":"string"}},"aggregator":"Simpl","phone_number":"9876543210","merchant_params":{"dummy":"lorem"},"transaction_amount_in_paise":9128}}}},"responses":{"200":{"description":"Success. Check the example shown below or refer `ValidateCustomerResponse` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidateCustomerResponse"},"examples":{"success is True i.e user is allowed":{"value":{"success":true,"message":"data fetched","data":{"api_version":2,"data":{"approved":true,"button_text":"Buy Now, Pay Later","first_transaction":false},"aggregator":"Simpl"}}},"success is True i.e user not allowed":{"value":{"success":false,"message":"data fetched","error":{"api_version":2,"data":{"approved":false,"button_text":"Buy Now, Pay Later","first_transaction":false},"aggregator":"Simpl"},"data":{}}}}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"example":{"success":false,"error":{"code":"BAD_REQUEST_ERROR","description":"Some thing wrong in payload"}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"example":{"success":false,"error":{"code":"INTERNAL_SERVER_ERROR","description":"Something went wrong on server. We are looking into it."}}}}}}}},"/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/create-payment-link/":{"get":{"summary":"getPaymentLink | Get payment link","description":"Use this API to get a payment link","tags":["Payment"],"parameters":[{"name":"company_id","in":"path","description":"Company Id","schema":{"type":"integer"},"required":true},{"name":"application_id","in":"path","description":"Application id","schema":{"type":"string"},"required":true},{"in":"query","name":"payment_link_id","schema":{"type":"string","description":"Unique payment link id"}}],"responses":{"200":{"description":"Success. Check the example shown below","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetPaymentLinkResponse"},"example":{"success":true,"message":"Payment link","status_code":200,"payment_link_current_status":"resent","payment_link_url":"https://api.fyndx0.de/service/application/payment/v1.0/payment/options/link/?id=4adb4451720a82ee69a3c1c4cc9ab442&refresh=false","external_order_id":"FY62614DF9D5CF31D3D0","amount":21900,"merchant_name":"Fynd","polling_timeout":1800}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":{"code":"BAD_REQUEST","description":""},"success":false,"message":"Something wrong in payload","status_code":400}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":{"code":"INTERNAL_SERVER_ERROR","description":""},"message":"Something went wrong","success":false,"status_code":500}}}}}},"post":{"summary":"createPaymentLink | Create payment link","description":"Use this API to create a payment link for the customer","tags":["Payment"],"parameters":[{"name":"company_id","in":"path","description":"Company Id","schema":{"type":"integer"},"required":true},{"name":"application_id","in":"path","description":"Application id","schema":{"type":"string"},"required":true}],"requestBody":{"description":"Pass the external_order_id, amount, mobile number and other details in the request body as shown below.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePaymentLinkRequest"},"example":{"external_order_id":"FY62614DF9D5CF31D3D0","amount":21900,"meta":{"amount":"21900","cart_id":"124","pincode":"400059","checkout_mode":"self","assign_card_id":"12345678"},"mobile_number":"9999999999","country_phone_code":"+91","email":"abc@example.com","description":"Payment link for Uniket"}}}},"responses":{"200":{"description":"Success. Check the example shown below","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePaymentLinkResponse"},"example":{"success":true,"message":"Payment link created","status_code":200,"payment_link_url":"https://api.fyndx0.de/service/application/payment/v1.0/payment/options/link/?id=96b15ea2014a76c8d2774783e239ce26&refresh=false","payment_link_id":"96b15ea2014a76c8d2774783e239ce26","polling_timeout":480}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":{"code":"BAD_REQUEST","description":""},"success":false,"message":"Something wrong in payload","status_code":400}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":{"code":"INTERNAL_SERVER_ERROR","description":""},"success":false,"message":"Something went wrong","status_code":500}}}}}}},"/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/polling-payment-link/":{"get":{"summary":"pollingPaymentLink | Used for polling if payment successful or not","description":"Use this API to poll if payment through payment was successful or not","tags":["Payment"],"parameters":[{"name":"company_id","in":"path","description":"Company Id","schema":{"type":"integer"},"required":true},{"name":"application_id","in":"path","description":"Application id","schema":{"type":"string"},"required":true},{"in":"query","name":"payment_link_id","schema":{"type":"string","description":"Unique payment link id"}}],"responses":{"200":{"description":"Success. Check the example shown below","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollingPaymentLinkResponse"},"example":{"aggregator_name":"Fynd","status":"complete","redirect_url":"https://api.fyndx0.de/service/application/order/v1.0/orders/?success=true&order_id=FY62B3FF87016F24A4E6&aggregator_name=Fynd&cart_id=412&delivery_address_id=136&billing_address_id=136","payment_link_id":"223d2a8df39a5dcdd8525498bee73199","amount":21900,"order_id":"FY62B3FF87016F24A4E6","status_code":200}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":{"code":"BAD_REQUEST","description":""},"success":false,"message":"Something wrong in payload","status_code":400}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":{"code":"INTERNAL_SERVER_ERROR","description":""},"success":false,"message":"Something went wrong","status_code":500}}}}}}},"/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/resend-payment-link/":{"post":{"summary":"resendPaymentLink | Resend payment link","description":"Use this API to resend a payment link for the customer","tags":["Payment"],"parameters":[{"name":"company_id","in":"path","description":"Company Id","schema":{"type":"integer"},"required":true},{"name":"application_id","in":"path","description":"Application id","schema":{"type":"string"},"required":true}],"requestBody":{"description":"Pass payment_link_id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelOrResendPaymentLinkRequest"},"example":{"payment_link_id":"4adb4451720a82ee69a3c1c4cc9ab442"}}}},"responses":{"200":{"description":"Success. Check the example shown below","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResendPaymentLinkResponse"},"example":{"success":true,"message":"Payment link resent","status_code":200,"polling_timeout":480}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":{"code":"BAD_REQUEST","description":""},"success":false,"message":"Something wrong in payload","status_code":400}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":{"code":"INTERNAL_SERVER_ERROR","description":""},"success":false,"message":"Something went wrong","status_code":500}}}}}}},"/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/cancel-payment-link/":{"post":{"summary":"cancelPaymentLink | Cancel payment link","description":"Use this API to cancel a payment link for the customer","tags":["Payment"],"parameters":[{"name":"company_id","in":"path","description":"Company Id","schema":{"type":"integer"},"required":true},{"name":"application_id","in":"path","description":"Application id","schema":{"type":"string"},"required":true}],"requestBody":{"description":"Pass the payment_link_id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelOrResendPaymentLinkRequest"},"example":{"payment_link_id":"4adb4451720a82ee69a3c1c4cc9ab442"}}}},"responses":{"200":{"description":"Success. Check the example shown below","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelPaymentLinkResponse"},"example":{"success":true,"message":"Payment link cancelled","status_code":200}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"success":false,"message":"Something wrong in payload","status_code":400}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"success":false,"message":"Something went wrong","status_code":500}}}}}}},"/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/options/modes/{mode}":{"get":{"summary":"getPaymentModeControlRoutes | Get details for the given offline / advance payment mode for merchant","description":"Use this API to get details for the given offline / advance payment mode for merchant","tags":["Payment"],"parameters":[{"name":"company_id","in":"path","description":"Company Id","schema":{"type":"integer"},"required":true},{"name":"application_id","in":"path","description":"Application id","schema":{"type":"string"},"required":true},{"name":"mode","in":"path","description":"offline / advance  modes to get the payment modes","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Success. Returns user cod limit , remaining limit and usage of user for COD. Check the example shown below or refer `GetUserCODLimitResponseSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformPaymentModeResponse"},"example":{"success":true,"message":"get offline / advance payment mode details","items":[{"display_name":"Store OS","business_unit":"pos","config":[{"anonymous":false,"charges":100,"charges_max_value":1000,"charges_min_value":0,"max_order_value":30000,"min_order_value":0,"is_active":true,"name":"Cash on Delivery (COD)","slug":"cod","user_limit":10000}]}]}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"example":{"success":false,"error":{"code":"BAD_REQUEST_ERROR","description":""}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"example":{"success":false,"error":{"code":"INTERNAL_SERVER_ERROR","description":""}}}}}}},"patch":{"summary":"setMerchantModeControlRoutes | Update offline payment mode details for the merchant","description":"Use this API to update given offline / advance payment mode details for the merchant","tags":["Payment"],"parameters":[{"name":"company_id","in":"path","description":"Company ID","schema":{"type":"integer"},"required":true},{"name":"application_id","in":"path","description":"Application id","schema":{"type":"string"},"required":true},{"name":"mode","in":"path","description":"offline / advance payment mode","schema":{"type":"string"},"required":true}],"requestBody":{"description":"offline / advance payment mode details will be passed which needs to update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MerchantPaymentModeRequest"},"example":{"business_unit":"storefront","device":{"android":false,"desktop":true,"ios":false},"items":[{"anonymous":false,"charges":100,"charges_max_value":1000,"charges_min_value":0,"max_order_value":30000,"min_order_value":0,"is_active":true,"name":"Cash on Delivery (COD)","slug":"cod","user_limit":10000}]}}}},"responses":{"200":{"description":"Success. Returns true or false for user cod option for payment. Check the example shown below or refer `GetUserCODLimitResponseSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformPaymentModeResponse"},"example":{"success":true,"message":"","items":[{"anonymous":false,"charges":100,"charges_max_value":1000,"charges_min_value":0,"max_order_value":30000,"min_order_value":0,"is_active":true,"name":"Cash on Delivery (COD)","slug":"cod","user_limit":10000}]}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"example":{"success":false,"error":{"code":"BAD_REQUEST_ERROR","description":""}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"example":{"success":false,"error":{"code":"INTERNAL_SERVER_ERROR","description":""}}}}}}}},"/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/options/modes/{mode}/custom-config":{"get":{"summary":"getPaymentModeCustomConfig | Get details of advance payment custom configurations of merchant","description":"Use this API to Get details of advance payment custom configurations of merchant","tags":["Payment"],"parameters":[{"name":"company_id","in":"path","description":"Company Id","schema":{"type":"integer"},"required":true},{"name":"application_id","in":"path","description":"Application id","schema":{"type":"string"},"required":true},{"name":"mode","in":"path","description":"offline / advance  mode","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Success. Get Advance Payment Custom Configurations.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentCustomConfigResponseSchema"},"example":{"success":true,"message":"","items":[{"display_name":"Store OS","business_unit":"pos","custom_config":{"customer":{"restriction":"ALL_CUSTOMER","groups":[1,2,3],"types":["ALL_CUSTOMER","CUSTOMER_GROUP","REGISTERED_CUSTOMER"]},"payment_mode":{"available":true,"pre_order":["NB","UPI"],"post_order":["NB","UPI"]},"min_order_value":50}},{"display_name":"StoreFront","business_unit":"storefront","custom_config":{"customer":{"restriction":"ALL_CUSTOMER","groups":[1,2,3],"types":["ALL_CUSTOMER","CUSTOMER_GROUP","REGISTERED_CUSTOMER"]},"payment_mode":{"available":true,"pre_order":["NB","UPI"],"post_order":["NB","UPI"]},"min_order_value":50}}]}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"example":{"success":false,"error":{"code":"BAD_REQUEST_ERROR","description":""}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"example":{"success":false,"error":{"code":"INTERNAL_SERVER_ERROR","description":""}}}}}}},"patch":{"summary":"setPaymentModeCustomConfig | Update details of advance payment custom configurations of merchant","description":"Use this API to update given details of advance payment custom configurations of merchant","tags":["Payment"],"parameters":[{"name":"company_id","in":"path","description":"Company ID","schema":{"type":"integer"},"required":true},{"name":"application_id","in":"path","description":"Application id","schema":{"type":"string"},"required":true},{"name":"mode","in":"path","description":"offline / advance payment mode","schema":{"type":"string"},"required":true}],"requestBody":{"description":"offline / advance payment mode details will be passed which needs to update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentCustomConfigRequestSchema"},"example":{"business_unit":"storefront","items":[{"min_order_value":50,"customer":{"groups":[1,2,3],"restriction":"CUSTOMER_GROUP"},"payment_mode":{"available":true,"pre_order":["NB","UPI"],"post_order":["NB","UPI"]}}]}}}},"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentCustomConfigResponseSchema"},"example":{"success":true,"message":"","items":[{"display_name":"Store OS","business_unit":"pos","custom_config":{"customer":{"restriction":"ALL_CUSTOMER","groups":[1,2,3],"types":["ALL_CUSTOMER","CUSTOMER_GROUP","REGISTERED_CUSTOMER"]},"payment_mode":{"available":true,"pre_order":["NB","UPI"],"post_order":["NB","UPI"]},"min_order_value":50}},{"display_name":"StoreFront","business_unit":"storefront","custom_config":{"customer":{"restriction":"ALL_CUSTOMER","groups":[1,2,3],"types":["ALL_CUSTOMER","CUSTOMER_GROUP","REGISTERED_CUSTOMER"]},"payment_mode":{"available":true,"pre_order":["NB","UPI"],"post_order":["NB","UPI"]},"min_order_value":50}}]}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"example":{"success":false,"error":{"code":"BAD_REQUEST_ERROR","description":""}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"example":{"success":false,"error":{"code":"INTERNAL_SERVER_ERROR","description":""}}}}}}}},"/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/codes":{"get":{"summary":"getPaymentCodeOption | List Payment Options Method Codes","description":"Get all active List Payment Options Method Codes","tags":["Payment"],"parameters":[{"name":"company_id","in":"path","description":"Company Id","schema":{"type":"integer"},"required":true},{"name":"application_id","in":"path","description":"Application id","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"List Order Beneficiary","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetPaymentCodeResponse"},"example":{"success":true,"data":{"description":"Successful Payment","method_code":{"name":"Wallet","networks":"network","types":"","codes":{"code":"W","merchant_code":"MOBIKWIK","MOBIKWIK":null,"name":"Mobikwik"}},"networks":[],"types":[],"name":"Net Banking","codes":{"HDFC":{"merchant_code":"HDFC","name":"HDFC Bank"},"ICIC":{"merchant_code":"ICIC","name":"ICICI Bank"}},"CARD":{"codes":{"ICICI":{"merchant_code":"ICICI","name":"ICICI Bank"},"AXIS":{"merchant_code":"AXIS","name":"AXIS Bank"}},"networks":["RUPAY","VISA","MASTERCARD","MAESTRO","AMERICANEXPRESS","DINERSCLUB"],"types":["CREDIT","DEBIT"],"name":"CARD"}}}}}},"400":{"description":"Bad Request Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResourceError"},"example":{"success":false,"code":"BAD_REQUEST_ERROR","description":"Order not found!"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"example":{"error":{"code":"INTERNAL_SERVER_ERROR","description":""},"success":false}}}}}}},"/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/session/{gid}":{"get":{"summary":"getPaymentSession | API to get payment session details","description":"Use this API to fetch the payment session details for given order ID or Transaction ID.","tags":["Payment"],"parameters":[{"name":"company_id","in":"path","description":"Company Id","schema":{"type":"integer"},"examples":{"status_update_success":{"summary":"valid company id","value":1},"status_update_failed":{"summary":"invalid company id","value":0}},"required":true},{"name":"application_id","in":"path","description":"Application id","schema":{"type":"string"},"examples":{"status_update_success":{"summary":"valid app id","value":"64bf81dcc07acacc135733ea"},"status_update_failed":{"summary":"invalid app id","value":"123"}},"required":true},{"name":"gid","in":"path","description":"global identifier of the entity (e.g. order, cart etc.) against which payment session was initiated. This is generated by Fynd payments platform and is unique.","schema":{"type":"string"},"examples":{"transaction_details_success":{"summary":"valid global identifier","value":"TR9C4AF3A615DE251A23"},"order_details_success":{"summary":"valid Order ID","value":"FY615DE25839C4AF3A1A"},"payment_details_failed":{"summary":"invalid global identifier","value":"1"}},"required":true},{"name":"line-item","in":"query","description":"line-item to add extra data into response (e.g. cart details)","schema":{"type":"boolean"},"examples":{"line_item_success":{"summary":"Valid line-item options","value":true},"line_iteme_failed":{"summary":"invalid line-item options","value":false}}}],"responses":{"200":{"description":"Success. Returns the details of payment session. Check the example shown below or refer `PaymentSessionSerializer` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentSessionSerializer"},"example":{"gid":"TR9C4AF3A615DE251A23","status":"complete","total_amount":10000,"currency":"INR","payment_details":{"gid":"TR9C4AF3A615DE251A23","payment_mode":"JIOPAY","aggregator_order_id":"10772307355840195000","aggregator_customer_id":"63073b48e8d90abe20c42eb8","payment_mode_identifier":"JIOPAY","g_user_id":"63073b48e8d90abe20c42eb8","payment_id":"10772307355847914000","mode":"live","amount":56700,"currency":"INR","cancel_url":"","success_url":"","amount_captured":56700,"status":"refund_done","payment_methods":[],"meta":{"cod_eligibile":true}},"refund_details":[{"currency":"INR","request_id":"16787880654271907518","status":"refund_done","created":"2023-03-14 10:54:24","payment_id":"10772307355847914000","refund_utr":"10772307355847914000","amount":56700}],"cart_details":{"cart_value":56700,"total_quantity":10,"articles":[],"items":{}}}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"examples":{"payment_details_failed":{"summary":"payment session details failed","value":{"error":{"code":"INTERNAL_SERVER_ERROR","description":""},"success":false,"data":{"status":"failed"},"message":"gid not found. Invalid Request"}}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"examples":{"payment_details_failed":{"summary":"payment session details failed","value":{"error":{"code":"INTERNAL_SERVER_ERROR","description":""},"success":false,"data":{"status":"failed"},"message":"error message"}}}}}}}},"put":{"summary":"updatePaymentSession | API to update status of a payment.","description":"A payment_session is initiated against a global identifier (gid) which is identifies the entity payment is initiated against. e.g. order_id, cart_id. This endpoint is to update the status of the said payment_session.","tags":["Payment"],"parameters":[{"name":"company_id","in":"path","description":"Company Id","schema":{"type":"integer"},"examples":{"status_update_success":{"summary":"valid company id","value":1},"status_update_failed":{"summary":"invalid company id","value":0}},"required":true},{"name":"application_id","in":"path","description":"Application id","schema":{"type":"string"},"examples":{"status_update_success":{"summary":"valid app id","value":"64bf81dcc07acacc135733ea"},"status_update_failed":{"summary":"invalid app id","value":"123"}},"required":true},{"name":"gid","in":"path","description":"global identifier of the entity (e.g. order, cart etc.) against which payment_session was initiated. This is generated by Fynd payments platform and is unique.","schema":{"type":"string"},"examples":{"status_update_success":{"summary":"valid global identifier","value":"FY615DE25839C4AF3A1A"},"status_update_failed":{"summary":"invalid global identifier","value":"1"}},"required":true}],"requestBody":{"description":"Check the example of a request body below or refer `PaymentSessionRequestSerializer` for more details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentSessionRequestSerializer"},"examples":{"update_payment_status":{"summary":"update status of a payment of an entity identified by gid","value":{"gid":"FY615DE25839C4AF3A1A","status":"initiated","total_amount":100,"currency":"INR","payment_details":[{"payment_id":"pay_wtt5r23mpebexcjsxzylyjhn7a","aggregator_order_id":"hpp_yR3qKzIagWl9","aggregator_customer_id":"cust_123","captured":false,"amount_captured":100,"amount_refunded":100,"gid":"FY615DE25839C4AF3A1A","status":"complete","g_user_id":"1832452","amount":100,"currency":"INR","merchant_locale":"en","locale":"en","mode":"test","payment_methods":[{"code":"NB","name":"Net banking","sub_payment_mode":[{"code":"SBIN","name":"State Bank of India"}]}],"success_url":"","cancel_url":"","billing_address":{"country_phone_code":"91","country_iso_code":"IND","geo_location":{"longitude":73.9721802,"latitude":21.0643252},"google_map_point":{"address":"WXC7+AJC, Mumbai, Maharashtra, 400093, India","sub_locality":"Andheri East"},"expire_at":"timestamp","phone":"9876543210","state":"Maharashtra","landmark":"Andheri East","name":"Shopsense","tags":[],"address":"Ajit Nagar, Kondivita, Andheri East","area":"Andheri East","g_address_id":"507f191e810c19729de860ea","country":"India","city":"Mumbai","address_type":"office","area_code_slug":"400093","email":"care@fynd.com","area_code":"400093"},"shipping_address":{"country_phone_code":"91","country_iso_code":"IND","geo_location":{"longitude":73.9721802,"latitude":21.0643252},"google_map_point":{"address":"WXC7+AJC, Mumbai, Maharashtra, 400093, India","sub_locality":"Andheri East"},"expire_at":"timestamp","phone":"9876543210","state":"Maharashtra","landmark":"Andheri East","name":"Shopsense","tags":[],"address":"Ajit Nagar, Kondivita, Andheri East","area":"Andheri East","g_address_id":"507f191e810c19729de860ea","country":"India","city":"Mumbai","address_type":"office","area_code_slug":"400093","email":"care@fynd.com","area_code":"400093"},"kind":"sale","created":"9247387542"}],"order_details":{"gid":"FY615DE25839C4AF3A1A","status":"","amount":100,"currency":"INR","aggregator":"aggregator","aggregator_order_details":{"aggregator_order_id":"hpp_yR3qKzIagWl9","amount":100,"currency":"INR","aggregator":"checkoutcom","status":"complete"}}}}}}}},"responses":{"200":{"description":"Success. Returns the status of Update or not. Check the example shown below or refer `PaymentSessionResponseSerializer` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentSessionResponseSerializer"},"examples":{"status_update_success":{"summary":"payment status updated successfully","value":{"gid":"Payment Received","status":"initiated","total_amount":100,"currency":"INR","platform_transaction_details":[{"object":"platform_payment","transaction_id":"pay_wtt5r23mpebexcjsxzylyjhn7a","payment_id":"pay_wtt5r23mpebexcjsxzylyjhn7a"}]}}}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"examples":{"status_update_failed":{"summary":"status update failed","value":{"error":{"code":"BAD_REQUEST","description":""},"success":false,"data":{"status":"failed"},"message":"error message"}}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"examples":{"status_update_failed":{"summary":"status update failed","value":{"error":{"code":"INTERNAL_SERVER_ERROR","description":""},"success":false,"data":{"status":"failed"},"message":"error message"}}}}}}}}},"/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/{gid}/refund/session/{request_id}":{"put":{"summary":"updateRefundSession | API to update the status of a refund","description":"A refund_session is initiated against a refund request, and this endpoint is to update the status against the refund request_id. A gid is unique indentifier of the entity against which payment was received e.g. an order.","tags":["Payment"],"parameters":[{"name":"company_id","in":"path","description":"Company Id","schema":{"type":"integer"},"examples":{"status_update_success":{"summary":"valid company id","value":1},"status_update_failed":{"summary":"invalid company id","value":0}},"required":true},{"name":"application_id","in":"path","description":"Application id","schema":{"type":"string"},"examples":{"status_update_success":{"summary":"valid app id","value":"64bf81dcc07acacc135733ea"},"status_update_failed":{"summary":"invalid app id","value":"123"}},"required":true},{"name":"gid","in":"path","description":"global identifier of the entity (e.g. order, cart etc.) against which payment_session was initiated. This is generated by Fynd payments platform and is unique.","schema":{"type":"string"},"examples":{"status_update_success":{"summary":"valid global identifier","value":"FY615DE25839C4AF3A1A"},"status_update_failed":{"summary":"invalid global identifier","value":"1"}},"required":true},{"name":"request_id","in":"path","description":"A unique id that was used to initiate a refund session. This is generated by Fynd platform and is usually shipment_id.","schema":{"type":"string"},"examples":{"status_update_success":{"summary":"valid refund request id","value":"16100144824381402124"},"status_update_failed":{"summary":"invalid request id","value":"1"}},"required":true}],"requestBody":{"description":"Check the example of a request body below or refer `RefundSessionRequestSerializer` for more details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefundSessionRequestSerializer"},"examples":{"update_refund_status":{"summary":"update refund status for a request_id","value":{"gid":"FY615DE25839C4AF3A1A","status":"initiated","total_amount":100,"currency":"INR","refund_details":[{"request_id":"16100144824381402124","amount":100,"currency":"INR","status":"refund_done","refund_utr":"act_4lan4lrf2bxexdbinmqoln4nda","payment_id":"pay_wtt5r23mpebexcjsxzylyjhn7a","reason":"","receipt_number":"act_4lan4lrf2bxexdbinmqoln4nda","transfer_reversal":"","source_transfer_reversal":"","created":"","balance_transaction":""}],"payment_details":{"payment_id":"pay_wtt5r23mpebexcjsxzylyjhn7a","aggregator_order_id":"hpp_yR3qKzIagWl9","aggregator_customer_id":"cust_123","captured":false,"amount_captured":500,"status":"refund_done","amount_refunded":100,"gid":"FY615DE25839C4AF3A1A","g_user_id":"1832442","amount":100,"currency":"INR","merchant_locale":"en","locale":"en","mode":"test","payment_methods":[{"code":"NB","name":"Net banking","sub_payment_mode":[{"code":"SBIN","name":"State Bank of India"}]}],"success_url":"","cancel_url":"","billing_address":{"country_phone_code":"91","country_iso_code":"IND","geo_location":{"longitude":73.9721802,"latitude":21.0643252},"google_map_point":{"address":"WXC7+AJC, Mumbai, Maharashtra, 400093, India","sub_locality":"Andheri East"},"expire_at":"timestamp","phone":"9876543210","state":"Maharashtra","landmark":"Andheri East","name":"Shopsense","tags":[],"address":"Ajit Nagar, Kondivita, Andheri East","area":"Andheri East","g_address_id":"507f191e810c19729de860ea","country":"India","city":"Mumbai","address_type":"office","area_code_slug":"400093","email":"care@fynd.com","area_code":"400093"},"shipping_address":{"country_phone_code":"91","country_iso_code":"IND","geo_location":{"longitude":73.9721802,"latitude":21.0643252},"google_map_point":{"address":"WXC7+AJC, Mumbai, Maharashtra, 400093, India","sub_locality":"Andheri East"},"expire_at":"timestamp","phone":"9876543210","state":"Maharashtra","landmark":"Andheri East","name":"Shopsense","tags":[],"address":"Ajit Nagar, Kondivita, Andheri East","area":"Andheri East","g_address_id":"507f191e810c19729de860ea","country":"India","city":"Mumbai","address_type":"office","area_code_slug":"400093","email":"care@fynd.com","area_code":"400093"},"kind":"sale","created":"Date"}}}}}}},"responses":{"200":{"description":"Returns the response weather it is success or not. Check the example shown below or refer `RefundSessionResponseSerializer` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefundSessionResponseSerializer"},"examples":{"status_update_success":{"summary":"refund status is updated successfully","value":{"gid":"FY615DE25839C4AF3A1A","status":"initiated","total_refund_amount":100,"currency":"INR","platform_refund_details":[{"transaction_id":"pay_wtt5r23mpebexcjsxzylyjhn7a","refund_id":"act_4lan4lrf2bxexdbinmqoln4nda"}]}}}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"examples":{"status_update_failed":{"summary":"status update failed","value":{"error":{"code":"BAD_REQUEST","description":""},"success":false,"data":{"status":"failed"},"message":"error message"}}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"examples":{"status_update_failed":{"summary":"status update failed","value":{"error":{"code":"INTERNAL_SERVER_ERROR","description":""},"success":false,"data":{"status":"failed"},"message":"error message"}}}}}}}}},"/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/options/configuration":{"get":{"summary":"getMerchantPaymentOption | Get Payment modes and COD details.","description":"This api fetches all the available PGs for merchant and its offline payment mode details.","tags":["Payment"],"parameters":[{"name":"company_id","in":"path","description":"Company Id","schema":{"type":"integer"},"required":true,"examples":{"merchant_payment_response_success":{"summary":"valid company id","value":1}}},{"name":"application_id","in":"path","description":"Application id","schema":{"type":"string"},"required":true,"examples":{"merchant_payment_response_success":{"summary":"valid app id","value":"000000000000000000000001"}}}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformPaymentModeResponse"},"examples":{"merchant_payment_response_success":{"summary":"List of active PGs for merchant and its offline payment configurations","value":{"success":true,"message":"","items":[{"online":{"is_active":true,"aggregators":[{"id":1,"name":"Simpl","logo":"https://hdn-1.fynd.com/payment/simpl-pg-logo.jpg"}]},"offline":{"is_active":true,"payment_modes":{"cod":[{"name":"Cash on Delivery","slug":"cod","is_active":true,"logos":{"small":"https://hdn-1.fynd.com/payment/cod.png","large":"https://hdn-1.fynd.com/payment/cod.png"}}]}},"advance":{"is_active":true,"payment_modes":{"split":[{"name":"Split Payment","slug":"split","id":48,"is_active":true}]}}}]}}}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"examples":{"merchant_payment_response_fail":{"summary":"get merchant payment options failed","value":{"success":false,"error":{"code":"BAD_REQUEST_ERROR","description":""}}}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"examples":{"merchant_payment_response_fail":{"summary":"get merchant payment options failed","value":{"success":false,"error":{"code":"INTERNAL_SERVER_ERROR","description":""}}}}}}}}},"patch":{"summary":"patchMerchantPaymentOption | Update Payment modes and COD details.","description":"To updated online payment as active/inactive or offline payment configuration like cod charges, anonymous cod allowed flags.","tags":["Payment"],"parameters":[{"name":"company_id","in":"path","description":"Company Id","schema":{"type":"integer"},"required":true,"examples":{"merchant_payment_response_success":{"summary":"valid company id","value":1}}},{"name":"application_id","in":"path","description":"Application id","schema":{"type":"string"},"required":true,"examples":{"merchant_payment_response_success":{"summary":"valid app id","value":"000000000000000000000001"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MerchnatPaymentModeRequest"},"examples":{"update_merchant_payments_config":{"summary":"Update online or offline payment configurations","value":{"online":{"is_active":false},"offline":{"is_active":true}}}}}}},"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformPaymentModeResponse"},"examples":{"merchant_payment_response_success":{"summary":"updated payment mode configurations.","value":{"success":true,"message":"","items":[{"aggregators":[{"id":1,"name":"Simpl"}]}],"offline":{"is_active":true,"payment_modes":{"cod":{"name":"Cash on Delivery (COD)","slug":"cod","is_active":true}}}}}}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"example":{"success":false,"error":{"code":"BAD_REQUEST_ERROR","description":""}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"example":{"success":false,"error":{"code":"INTERNAL_SERVER_ERROR","description":""}}}}}}}},"/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/options/aggregators/{aggregator_id}":{"get":{"summary":"getMerchantAggregatorPaymentModeDetails | Get Aggregator, payment mode and sub payment mode.","description":"Get Aggregator, payment mode and sub payment mode details.","tags":["Payment"],"parameters":[{"name":"company_id","in":"path","description":"Company Id","schema":{"type":"integer"},"required":true},{"name":"application_id","in":"path","description":"Application id","schema":{"type":"string"},"required":true},{"name":"aggregator_id","in":"path","description":"Aggregators Id","schema":{"type":"integer"},"required":true},{"name":"business_unit","in":"query","required":true,"schema":{"type":"string"}},{"name":"device","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformPaymentModeResponse"},"example":{"success":true,"business_unit":"storefront","device":"android","is_active":true,"items":[{"id":1,"is_active":true}]}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"example":{"success":false,"error":{"code":"BAD_REQUEST_ERROR","description":""}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"example":{"success":false,"error":{"code":"INTERNAL_SERVER_ERROR","description":""}}}}}}},"patch":{"summary":"patchMerchantAggregatorPaymentModeDetails | Update Aggregator, payment mode and sub payment mode.","description":"Update Aggregator, payment mode and sub payment mode details.","tags":["Payment"],"parameters":[{"name":"company_id","in":"path","description":"Company Id","schema":{"type":"integer"},"required":true},{"name":"application_id","in":"path","description":"Application id","schema":{"type":"string"},"required":true},{"name":"aggregator_id","in":"path","description":"Aggregators Id","schema":{"type":"integer"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformPaymentModeResponse"},"example":{"success":true,"business_unit":"storefront","device":"android","is_active":true,"items":[{"id":1,"is_active":true}]}}}},"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformPaymentModeResponse"},"example":{"success":true,"business_unit":"storefront","device":"android","is_active":true,"items":[{"id":1,"is_active":true}]}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"example":{"success":false,"error":{"code":"BAD_REQUEST_ERROR","description":""}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"example":{"success":false,"error":{"code":"INTERNAL_SERVER_ERROR","description":""}}}}}}}},"/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/options/configuration/aggregator":{"get":{"summary":"getPGConfigAggregators | Get Aggregators available to be added as PG.","description":"Get Aggregators available to be added as PG.","tags":["Payment"],"parameters":[{"name":"company_id","in":"path","description":"Company Id","schema":{"type":"integer"},"required":true},{"name":"application_id","in":"path","description":"Application id","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformPaymentModeResponse"},"example":{"success":true,"message":"","items":[{"id":8,"name":"Jio","slug":"jio","logos":{"large":"","small":""},"is_active":true,"config":["self","fynd"],"status":"active"}]}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"example":{"success":false,"error":{"code":"BAD_REQUEST_ERROR","description":""}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"example":{"success":false,"error":{"code":"INTERNAL_SERVER_ERROR","description":""}}}}}}}},"/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/refund_priority/config/{config_type}":{"get":{"summary":"getMerchantRefundPriority | API to get merchant refund priority","description":"API to get merchant refund priority","tags":["Payment"],"parameters":[{"name":"company_id","in":"path","description":"Company Id","schema":{"type":"integer"},"examples":{"success":{"summary":"valid company id","value":1},"failed":{"summary":"invalid company id","value":0}},"required":true},{"name":"application_id","in":"path","description":"Application id","schema":{"type":"string"},"examples":{"success":{"summary":"valid app id","value":"64bf81dcc07acacc135733ea"},"failed":{"summary":"invalid app id","value":"123"}},"required":true},{"name":"config_type","in":"path","description":"configuration for merchant or customer","schema":{"type":"string","enum":["merchant","customer","default"]},"examples":{"success":{"summary":"config source valid","value":"merchant"}},"required":true}],"responses":{"200":{"description":"Success. Returns the status of Update or not. Check the example shown below or refer `RefundPriorityResponseSerializer` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefundPriorityResponseSerializer"},"examples":{"success":{"summary":"success","value":{"success":true,"message":"Created successfully","apportion":true,"configuration":"merchant","refund_sources_priority":[{"source":"back_to_online_source,","description":"Back to online payment source","priority":0},{"source":"RONE","description":"Rone wallet","priority":1},{"source":"FC","description":"Fynd Cash","priority":2},{"source":"CreditNote","description":"Credit Note","priority":3}]}}}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"examples":{"failed":{"summary":"failed","value":{"success":false,"error":{"code":"BAD_REQUEST_ERROR","description":"Bad request error message"}}}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"examples":{"failed":{"summary":"failed","value":{"success":false,"error":{"code":"INTERNAL_SERVER_ERROR","description":"Internal Server Error message"}}}}}}}}},"post":{"summary":"createMerchantRefundPriority | API to create merchant refund priority","description":"API to update merchant refund priority","tags":["Payment"],"parameters":[{"name":"company_id","in":"path","description":"Company Id","schema":{"type":"integer"},"examples":{"success":{"summary":"valid company id","value":1},"failed":{"summary":"invalid company id","value":0}},"required":true},{"name":"application_id","in":"path","description":"Application id","schema":{"type":"string"},"examples":{"success":{"summary":"valid app id","value":"64bf81dcc07acacc135733ea"},"failed":{"summary":"invalid app id","value":"123"}},"required":true},{"name":"config_type","in":"path","description":"configuration for merchant or customer","schema":{"type":"string","enum":["merchant","customer","default"]},"examples":{"success":{"summary":"config source valid","value":"merchant"}},"required":true}],"requestBody":{"description":"Check the example of a request body below or refer `RefundPriorityRequestSerializer` for more details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefundPriorityRequestSerializer"},"examples":{"create_refund_config":{"summary":"create merchant refund priority config","value":{"apportion":true,"refund_sources_priority":[{"source":"back_to_online_source","description":"Back to online payment source","priority":0},{"source":"RONE","description":"Rone wallet","priority":1},{"source":"FC","description":"Fynd Cash","priority":2},{"source":"CreditNote","description":"Credit Note","priority":3}]}}}}}},"responses":{"200":{"description":"Success. Returns the status of Update or not. Check the example shown below or refer `RefundPriorityResponseSerializer` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefundPriorityResponseSerializer"},"examples":{"success":{"summary":"success","value":{"success":true,"message":"Created successfully","apportion":true,"configuration":"merchant","refund_sources_priority":[{"source":"back_to_online_source,","description":"Back to online payment source","priority":0},{"source":"RONE","description":"Rone wallet","priority":1},{"source":"FC","description":"Fynd Cash","priority":2},{"source":"CreditNote","description":"Credit Note","priority":3}]}}}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"examples":{"failed":{"summary":"failed","value":{"success":false,"error":{"code":"BAD_REQUEST_ERROR","description":"Bad request error message"}}}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"examples":{"failed":{"summary":"failed","value":{"success":false,"error":{"code":"INTERNAL_SERVER_ERROR","description":"Internal Server Error message"}}}}}}}}},"put":{"summary":"updateMerchantRefundPriority | API to update merchant refund priority","description":"API to update merchant refund priority","tags":["Payment"],"parameters":[{"name":"company_id","in":"path","description":"Company Id","schema":{"type":"integer"},"examples":{"success":{"summary":"valid company id","value":1},"failed":{"summary":"invalid company id","value":0}},"required":true},{"name":"application_id","in":"path","description":"Application id","schema":{"type":"string"},"examples":{"success":{"summary":"valid app id","value":"64bf81dcc07acacc135733ea"},"failed":{"summary":"invalid app id","value":"123"}},"required":true},{"name":"config_type","in":"path","description":"configuration for merchant or customer","schema":{"type":"string","enum":["merchant","customer","default"]},"examples":{"success":{"summary":"config source valid","value":"merchant"}},"required":true}],"requestBody":{"description":"Check the example of a request body below or refer `RefundPriorityRequestSerializer` for more details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefundPriorityRequestSerializer"},"examples":{"create_refund_config":{"summary":"create merchant refund priority config","value":{"apportion":true,"refund_sources_priority":[{"source":"back_to_online_source","description":"Back to online payment source","priority":0},{"source":"RONE","description":"Rone wallet","priority":1},{"source":"FC","description":"Fynd Cash","priority":2},{"source":"CreditNote","description":"Credit Note","priority":3}]}}}}}},"responses":{"200":{"description":"Success. Returns the status of Update or not. Check the example shown below or refer `RefundPriorityResponseSerializer` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefundPriorityResponseSerializer"},"examples":{"success":{"summary":"success","value":{"success":true,"message":"Created successfully","apportion":true,"configuration":"merchant","refund_sources_priority":[{"source":"back_to_online_source,","description":"Back to online payment source","priority":0},{"source":"RONE","description":"Rone wallet","priority":1},{"source":"FC","description":"Fynd Cash","priority":2},{"source":"CreditNote","description":"Credit Note","priority":3}]}}}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"examples":{"failed":{"summary":"failed","value":{"success":false,"error":{"code":"BAD_REQUEST_ERROR","description":"Bad request error message"}}}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"examples":{"failed":{"summary":"failed","value":{"success":false,"error":{"code":"INTERNAL_SERVER_ERROR","description":"Internal Server Error message"}}}}}}}}}},"/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment-orders/":{"post":{"summary":"createPaymentOrder | Create Order","description":"Use this API to create a order and payment on aggregator side","tags":["Payment"],"parameters":[{"name":"company_id","in":"path","description":"Company Id","schema":{"type":"integer"},"required":true},{"name":"application_id","in":"path","description":"Application id","schema":{"type":"string"},"required":true}],"requestBody":{"description":"Pass the details in the request body as shown below.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentOrderRequest"},"example":{"order_id":"FY64D25C440EB75A484F","shipment_id":16260188949011882000,"payment_methods":[{"mode":"NB","name":"NB","amount":1690,"meta":{"logo_url":{"large":"payments/original/hlQxI5lMq-NB_HDFC.png","small":"payments/original/hlQxI5lMq-NB_HDFC.png"},"merchant_code":"NB_HDFC","payment_gateway":"Razorpay","payment_identifier":"HDFC"}}]}}}},"responses":{"200":{"description":"Success. Check the example shown below","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentOrderResponse"},"example":{"message":"","success":true,"status_code":200,"data":{"amount":2190000,"order_id":"order_JeaZ5ryKO01rno","email":"abc@example.com","contact":"9999999999","currency":"INR","customer_id":"cust_CZgcLVGsGP8BUQ","callback_url":"https://api.fyndx0.com/service/webhooks/payment/v1.0/callback/link/?razorpay_order_id=order_JeaZ5ryKO01rno","method":"upi","aggregator":"Razorpay","merchant_order_id":"FY629EDC0980B6A8C1EA"},"callback_url":"https://api.fyndx0.com/service/webhooks/payment/v1.0/callback/link/?razorpay_order_id=order_JeaZ5ryKO01rno","payment_confirm_url":"https://api.fyndx0.com/service/webhooks/payment/v1.0/callback/link/?razorpay_order_id=order_JeaZ5ryKO01rno","order_id":"FY629EDC0980B6A8C1EA"}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"success":false,"message":"Something wrong in payload","status_code":400}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"success":false,"message":"Something went wrong","status_code":500}}}}}}},"/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/options/aggregators/{aggregator_id}/version":{"get":{"summary":"getMerchantAggregatorAppVersion | Get app version required for Payment Mode.","description":"This api provide read operations on the app version required for Payment Mode or sub payment mode for an Aggregator.","tags":["Payment"],"parameters":[{"name":"company_id","in":"path","description":"Company Id","schema":{"type":"integer"},"required":true,"examples":{"merchant_payment_response_success":{"summary":"valid company id","value":1}}},{"name":"application_id","in":"path","description":"Application id","schema":{"type":"string"},"required":true,"examples":{"merchant_payment_response_success":{"summary":"valid app id","value":"000000000000000000000001"}}},{"name":"aggregator_id","in":"path","description":"Aggregators Id","schema":{"type":"integer"},"required":true,"examples":{"merchant_payment_response_success":{"summary":"valid aggregator id","value":1}}},{"name":"business_unit","in":"query","required":true,"schema":{"type":"string"},"examples":{"merchant_payment_response_success":{"summary":"valid business unit","value":"storefront"}}},{"name":"device","in":"query","required":true,"schema":{"type":"string"},"examples":{"merchant_payment_response_success":{"summary":"valid device","value":"desktop"}}},{"name":"payment_mode_id","in":"query","required":false,"schema":{"type":"integer"},"examples":{"merchant_payment_response_success":{"summary":"valid payment mode id","value":3}}},{"name":"sub_payment_mode","in":"query","required":false,"schema":{"type":"string"},"examples":{"merchant_payment_response_success":{"summary":"valid sub payment mode code.","value":"LAVB_R"}}}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AggregatorVersionResponse"},"examples":{"merchant_payment_response_success":{"summary":"List of active PGs for merchant and its offline payment configurations","value":{"success":true,"message":"","items":{"is_equal_to":13,"is_less_than":12,"is_greater_than\"":10}}}}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"examples":{"merchant_payment_response_fail":{"summary":"get merchant payment options failed","value":{"success":false,"error":{"code":"BAD_REQUEST_ERROR","description":""}}}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"examples":{"merchant_payment_response_fail":{"summary":"get merchant payment options failed","value":{"success":false,"error":{"code":"INTERNAL_SERVER_ERROR","description":""}}}}}}}}},"patch":{"summary":"patchMerchantPaymentOptionVersion | Update app version required for Payment Mode.","description":"This api provide wrote operations on the app version required for Payment Mode or sub payment mode for an Aggregator.","tags":["Payment"],"parameters":[{"name":"company_id","in":"path","description":"Company Id","schema":{"type":"integer"},"required":true,"examples":{"merchant_payment_response_success":{"summary":"valid company id","value":1}}},{"name":"application_id","in":"path","description":"Application id","schema":{"type":"string"},"required":true,"examples":{"merchant_payment_response_success":{"summary":"valid app id","value":"000000000000000000000001"}}},{"name":"aggregator_id","in":"path","description":"Aggregators Id","schema":{"type":"integer"},"required":true,"examples":{"merchant_payment_response_success":{"summary":"valid aggregator id","value":1}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AggregatorControlRequest"},"examples":{"update_merchant_payments_version":{"summary":"Update online or offline payment configurations","value":{"business_unit":"storefront","device":"desktop","payment_mode_id":4,"sub_payment_mode":"mobikwik","version":{"is_greater_than":"1.6","is_less_than":"2"},"items":[{"id":"4,","name":"Wallet","logos":"","is_active":false}]}}}}}},"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformPaymentModeResponse"},"examples":{"merchant_payment_response_success":{"summary":"updated payment mode configurations.","value":{"success":true,"message":"request is being performed","items":null}}}}}},"400":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"example":{"success":false,"error":{"code":"BAD_REQUEST_ERROR","description":""}}}}},"500":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorCodeAndResponse"},"example":{"success":false,"error":{"code":"INTERNAL_SERVER_ERROR","description":""}}}}}}}},"/service/platform/rewards/v1.0/company/{company_id}/application/{application_id}/giveaways":{"get":{"description":"Fetch the detailed compilation of live, completed, and scheduled point-based giveaways created.","summary":"showGiveaways | List of giveaways of the current application.","tags":["Rewards"],"parameters":[{"name":"company_id","in":"path","description":"company id","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"application id","required":true,"schema":{"type":"string"}},{"name":"page_id","in":"query","description":"pagination page id","required":true,"schema":{"type":"string"}},{"name":"page_size","in":"query","description":"pagination page size","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GiveawayResponse"},"examples":{"Success":{"$ref":"#/components/examples/GiveawayResponse"}}}}},"400":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/E"}}}}}},"post":{"description":"Creates a new giveaway in the current application, specifying the target audience, points allocation, as well as the name and display name of the giveaway.","summary":"saveGiveAway | List of giveaways of the current application.","tags":["Rewards"],"parameters":[{"name":"company_id","in":"path","description":"company id","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"application id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Add Giveaway","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Giveaway"},"examples":{"Giveaway":{"$ref":"#/components/examples/Giveaway"}}}}},"responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Giveaway"},"examples":{"Success":{"$ref":"#/components/examples/Giveaway"}}}}},"400":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/E"}}}}}}},"/service/platform/rewards/v1.0/company/{company_id}/application/{application_id}/giveaways/{id}":{"get":{"description":"Retrieve the specific giveaway by giveaway ID. It will show all the details of the requested giveaway.","summary":"getGiveawayById | Get giveaway by ID.","tags":["Rewards"],"parameters":[{"name":"company_id","in":"path","description":"company id","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"application id","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Giveaway ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Giveaway"},"examples":{"Success":{"$ref":"#/components/examples/Giveaway"}}}}},"400":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/E"}}}}}},"put":{"description":"Make the necessary updates to the giveaway based on its giveaway ID.","summary":"updateGiveAway | Updates the giveaway by it's ID.","tags":["Rewards"],"parameters":[{"name":"company_id","in":"path","description":"company id","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"application id","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Giveaway ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Update Giveaway Request","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Giveaway"},"examples":{"Giveaway":{"$ref":"#/components/examples/Giveaway"}}}}},"responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Giveaway"},"examples":{"Success":{"$ref":"#/components/examples/Giveaway"}}}}},"400":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/E"}}}}}}},"/service/platform/rewards/v1.0/company/{company_id}/application/{application_id}/offers/":{"get":{"description":"Retrieve the list of offers within the current application, including order_discount, order, sign_up, and referral, along with their respective details.","summary":"showOffers | List of offers of the current application.","tags":["Rewards"],"parameters":[{"name":"company_id","in":"path","description":"company id","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"application id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Offer"}},"examples":{"Offer":{"$ref":"#/components/examples/Offers"}}}}},"400":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/E"}}}}}}},"/service/platform/rewards/v1.0/company/{company_id}/application/{application_id}/offers/{name}/":{"get":{"description":"Fetch the specific offer details and configuration by the name of the offer.","summary":"getOfferByName | Fetch a offer by its name","tags":["Rewards"],"parameters":[{"name":"name","in":"path","description":"The name given to the offer.","required":true,"schema":{"type":"string"}},{"name":"company_id","in":"path","description":"company id","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"application id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success. Check example below or refer `Offer` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Offer"},"examples":{"Success":{"$ref":"#/components/examples/Offer"}}}}},"500":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/E"}}}}},"x-private":true},"put":{"description":"Update the specific offer details and its configuration by offer name.","summary":"updateOfferByName | Update offer by name","tags":["Rewards"],"parameters":[{"name":"name","in":"path","description":"The name given to the offer.","required":true,"schema":{"type":"string"}},{"name":"company_id","in":"path","description":"company id","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"application id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Update Offers Request","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Offer"},"examples":{"Offer":{"$ref":"#/components/examples/Offer"}}}}},"responses":{"200":{"description":"Success. Check example below or refer `Offer` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Offer"},"examples":{"Success":{"$ref":"#/components/examples/Offer"}}}}},"400":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/E"}}}}}}},"/service/platform/rewards/v1.0/company/{company_id}/application/{application_id}/users/{user_id}/":{"patch":{"description":"Update the user status by marking them as a block or unblock. It can be done by changing the active flag in request body.","summary":"updateUserStatus | Update user status","tags":["Rewards"],"parameters":[{"name":"user_id","in":"path","description":"user id","required":true,"schema":{"type":"string"}},{"name":"company_id","in":"path","description":"company id","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"application id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"UpdateUserStatus","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppUser"},"examples":{"AppUser":{"$ref":"#/components/examples/UpdateAppUser"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppUser"},"examples":{"Success":{"$ref":"#/components/examples/AppUser"}}}}},"400":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/E"}}}}}},"get":{"description":"Fetches the user details and the user reward details with their current reward points for the specific user.","summary":"getUserDetails | Get user reward details","tags":["Rewards"],"parameters":[{"name":"user_id","in":"path","description":"user id","required":true,"schema":{"type":"string"}},{"name":"company_id","in":"path","description":"company id","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"application id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success. Check example below or refer `UserRes` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserRes"},"examples":{"Success":{"$ref":"#/components/examples/AppUser"}}}}},"400":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/E"}}}}}}},"/service/platform/rewards/v1.0/company/{company_id}/application/{application_id}/users/{user_id}/points/history/":{"get":{"description":"Fetches a list of points transactions like giveaway points, signup points, referral points, order earn points, redeem points and expired points.","summary":"getUserPointsHistory | Get all transactions of reward points","parameters":[{"name":"user_id","in":"path","description":"user id","required":true,"schema":{"type":"string"}},{"name":"company_id","in":"path","description":"company id","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"application id","required":true,"schema":{"type":"string"}},{"name":"page_id","in":"query","description":"PageID is the ID of the requested page. For first request it should be kept empty.","schema":{"type":"string"}},{"name":"page_size","in":"query","description":"The number of items to retrieve in each page.","schema":{"type":"integer"}}],"tags":["Rewards"],"responses":{"200":{"description":"Success. Check example below or refer `HistoryRes` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HistoryRes"},"examples":{"Success":{"$ref":"#/components/examples/HistoryRes"}}}}},"500":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/E"}}}}}}},"/service/platform/rewards/v1.0/company/{company_id}/application/{application_id}/configuration/":{"get":{"description":"Use this API to get a list of valid android paths required by the Rewards INIT API to validate a fraudulent device.","summary":"getRewardsConfiguration | Get all valid android paths","parameters":[{"name":"company_id","in":"path","description":"company id","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"application id","required":true,"schema":{"type":"string"}}],"tags":["Rewards"],"responses":{"200":{"description":"Success. Refer `ConfigurationRes` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigurationRes"},"examples":{"ConfigurationRes":{"$ref":"#/components/examples/ConfigurationRes"}}}}},"500":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/E"}}}}}},"post":{"description":"Updates the configuration or inserts new records with the given android paths.","summary":"setRewardsConfiguration | Updates the collection with given android paths.","tags":["Rewards"],"parameters":[{"name":"company_id","in":"path","description":"company id","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"application id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Upsert Android paths","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigurationRequest"},"examples":{"ConfigurationRequest":{"$ref":"#/components/examples/ConfigurationRequest"}}}}},"responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetConfigurationRes"},"examples":{"Success":{"$ref":"#/components/examples/ConfigurationRes"}}}}},"400":{"description":"Bad request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/E"}}}}}}},"/service/platform/share/v1.0/company/{company_id}/application/{application_id}/links/short-link/":{"post":{"description":"Create short link","summary":"createShortLink | Create short link","tags":["Share"],"parameters":[{"name":"company_id","in":"path","description":"Company Id","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Application Id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShortLinkReq"},"example":{"title":"brand","url":"https://0icof6vvsf.hostx0.de/products/?brand=ruosh"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShortLinkRes"},"example":{"url":{"original":"https://0icof6vvsf.hostx0.de/products/?brand=ruosh","short":"https://0icof6vvsf.hostx0.de/l/3qKlnsq-x","hash":"3qKlnsq-x"},"redirects":{"ios":{"type":"web","link":"https://0icof6vvsf.hostx0.de/products/?brand=ruosh"},"android":{"type":"web","link":"https://0icof6vvsf.hostx0.de/products/?brand=ruosh"},"web":{"type":"web","link":"https://0icof6vvsf.hostx0.de/products/?brand=ruosh"},"expiry":"","url":"","force_web":false},"created_by":"team","personalized":false,"app_redirect":false,"fallback":"web","enable_tracking":false,"active":true,"count":0,"_id":"601a54054c0349592e76c8f3","title":"new ","meta":{"type":"brand"},"expire_at":"","application":"5eda528b97457fe43a733ace","user_id":"5e4d01e2c39837ab66144f6d","created_at":"2021-02-03T07:43:01.342Z","updated_at":"2021-02-03T07:43:01.342Z"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorRes"}}}}}},"get":{"description":"Get short links","summary":"getShortLinks | Get short links","tags":["Share"],"parameters":[{"name":"company_id","in":"path","description":"Company Id","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Application Id","required":true,"schema":{"type":"string"}},{"name":"page_no","in":"query","description":"Current page number","required":false,"schema":{"default":1,"type":"integer"}},{"name":"page_size","in":"query","description":"Current page size","required":false,"schema":{"default":10,"type":"integer"}},{"name":"created_by","in":"query","description":"Short link creator","required":false,"schema":{"type":"string","enum":["team"]}},{"name":"active","in":"query","description":"Short link active status","required":false,"schema":{"type":"string","enum":["true","false"]}},{"name":"q","in":"query","description":"Search text for original and short url","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShortLinkList"},"example":{"items":[{"url":{"original":"https://0icof6vvsf.hostx0.de/products/?brand=ruosh","short":"https://0icof6vvsf.hostx0.de/l/3qKlnsq-x","hash":"3qKlnsq-x"},"redirects":{"ios":{"type":"web","link":"https://0icof6vvsf.hostx0.de/products/?brand=ruosh"},"android":{"type":"web","link":"https://0icof6vvsf.hostx0.de/products/?brand=ruosh"},"web":{"type":"web","link":"https://0icof6vvsf.hostx0.de/products/?brand=ruosh"},"expiry":"","url":"","force_web":false},"created_by":"team","personalized":false,"app_redirect":false,"fallback":"web","enable_tracking":false,"active":true,"count":0,"_id":"601a54054c0349592e76c8f3","title":"new ","meta":{"type":"brand"},"expire_at":"","application":"5eda528b97457fe43a733ace","user_id":"5e4d01e2c39837ab66144f6d","created_at":"2021-02-03T07:43:01.342Z","updated_at":"2021-02-03T07:43:01.342Z"}],"page":{"size":10,"type":"number","page":1,"item_total":30,"has_next":true}}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorRes"}}}}}}},"/service/platform/share/v1.0/company/{company_id}/application/{application_id}/links/short-link/{hash}/":{"get":{"description":"Get short link by hash","summary":"getShortLinkByHash | Get short link by hash","tags":["Share"],"parameters":[{"name":"company_id","in":"path","description":"Company Id","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Application Id","required":true,"schema":{"type":"string"}},{"name":"hash","in":"path","description":"Hash of short url","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShortLinkRes"},"example":{"url":{"original":"https://0icof6vvsf.hostx0.de/products/?brand=ruosh","short":"https://0icof6vvsf.hostx0.de/l/3qKlnsq-x","hash":"3qKlnsq-x"},"redirects":{"ios":{"type":"web","link":"https://0icof6vvsf.hostx0.de/products/?brand=ruosh"},"android":{"type":"web","link":"https://0icof6vvsf.hostx0.de/products/?brand=ruosh"},"web":{"type":"web","link":"https://0icof6vvsf.hostx0.de/products/?brand=ruosh"},"expiry":"","url":"","force_web":false},"created_by":"team","personalized":false,"app_redirect":false,"fallback":"web","enable_tracking":false,"active":true,"count":0,"_id":"601a54054c0349592e76c8f3","title":"new ","meta":{"type":"brand"},"expire_at":"","application":"5eda528b97457fe43a733ace","user_id":"5e4d01e2c39837ab66144f6d","created_at":"2021-02-03T07:43:01.342Z","updated_at":"2021-02-03T07:43:01.342Z"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorRes"}}}}}}},"/service/platform/share/v1.0/company/{company_id}/application/{application_id}/links/short-link/{id}/":{"patch":{"description":"Update short link by id","summary":"updateShortLinkById | Update short link by id","tags":["Share"],"parameters":[{"name":"company_id","in":"path","description":"Company Id","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Application Id","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Short link document identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShortLinkReq"},"example":{"url":"","title":"brand"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShortLinkRes"},"example":{"url":{"original":"https://0icof6vvsf.hostx0.de/products/?brand=ruosh","short":"https://0icof6vvsf.hostx0.de/l/3qKlnsq-x","hash":"3qKlnsq-x"},"redirects":{"ios":{"type":"web","link":"https://0icof6vvsf.hostx0.de/products/?brand=ruosh"},"android":{"type":"web","link":"https://0icof6vvsf.hostx0.de/products/?brand=ruosh"},"web":{"type":"web","link":"https://0icof6vvsf.hostx0.de/products/?brand=ruosh"},"expiry":"","url":"","force_web":false},"created_by":"team","personalized":false,"app_redirect":false,"fallback":"web","enable_tracking":false,"active":true,"count":0,"_id":"601a54054c0349592e76c8f3","title":"new ","meta":{"type":"brand"},"expire_at":"","application":"5eda528b97457fe43a733ace","user_id":"5e4d01e2c39837ab66144f6d","created_at":"2021-02-03T07:43:01.342Z","updated_at":"2021-02-03T07:43:01.342Z"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorRes"}}}}}}},"/service/platform/share/v1.0/company/{company_id}/application/{application_id}/links/short-link/click-stats":{"get":{"summary":"getShortLinkClickStats | Get click statistics for a short link","description":"Retrieve click statistics for a given short link ID.","tags":["Share"],"parameters":[{"in":"query","name":"surl_id","schema":{"type":"string","example":"52Bfbf"},"required":true,"description":"Short link ID for which click statistics are to be retrieved."},{"in":"path","name":"company_id","description":"Company Id","required":true,"schema":{"type":"string"}},{"in":"path","name":"application_id","description":"Application Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful retrieval of click statistics.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClickStatsResponse"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorRes"}}}}}}},"/service/platform/theme/v1.0/company/{company_id}/application/{application_id}/{theme_id}/page":{"get":{"summary":"getAllPages | Get all pages of a theme","description":"Use this API to retrieve all the available pages of a theme by its ID.","tags":["Theme"],"parameters":[{"name":"company_id","in":"path","description":"Company ID","required":true,"schema":{"type":"integer","example":19243}},{"name":"application_id","in":"path","description":"Application ID","required":true,"schema":{"type":"string","example":"6487ea376e1442284917c44e"}},{"name":"theme_id","in":"path","description":"ID of the theme to be retrieved","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success. Returns an array all the pages of the theme. Refer `AllAvailablePageSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AllAvailablePageSchema"},"examples":{"All pages":{"$ref":"#/components/examples/AllAvailablePagesExample"}}}}},"4XX":{"$ref":"#/components/responses/BlitzkriegApiError"},"5XX":{"$ref":"#/components/responses/BlitzkriegInternalServerError"}}},"post":{"summary":"createPage | Create a page ","description":"Use this API to create a page for a theme by its ID.","tags":["Theme"],"parameters":[{"name":"company_id","in":"path","description":"Company ID","required":true,"schema":{"type":"integer","example":19243}},{"name":"application_id","in":"path","description":"Application ID","required":true,"schema":{"type":"string","example":"6487ea376e1442284917c44e"}},{"name":"theme_id","in":"path","description":"ID of the theme","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AvailablePageSchema"},"examples":{"Success":{"$ref":"#/components/examples/AvailablePageExample"}}}}},"responses":{"200":{"description":"Success. Returns the page of the theme. Refer `AvailablePageSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AvailablePageSchema"},"examples":{"page":{"$ref":"#/components/examples/AvailablePageExample"}}}}},"4XX":{"$ref":"#/components/responses/BlitzkriegApiError"},"5XX":{"$ref":"#/components/responses/BlitzkriegInternalServerError"}}},"put":{"summary":"updateMultiplePages | Update multiple pages of a theme","description":"Use this API to update multiple pages of a theme by its ID.","tags":["Theme"],"parameters":[{"name":"company_id","in":"path","description":"Company ID","required":true,"schema":{"type":"integer","example":19243}},{"name":"application_id","in":"path","description":"Application ID","required":true,"schema":{"type":"string","example":"6487ea376e1442284917c44e"}},{"name":"theme_id","in":"path","description":"ID of the theme to be retrieved","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AllAvailablePageSchema"},"examples":{"Success":{"$ref":"#/components/examples/AllAvailablePagesExample"}}}}},"responses":{"200":{"description":"Success. Returns an array all the pages of the theme. Refer `AllAvailablePageSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AllAvailablePageSchema"},"examples":{"All pages":{"$ref":"#/components/examples/AllAvailablePagesExample"}}}}},"4XX":{"$ref":"#/components/responses/BlitzkriegApiError"},"5XX":{"$ref":"#/components/responses/BlitzkriegInternalServerError"}}}},"/service/platform/theme/v1.0/company/{company_id}/application/{application_id}/{theme_id}/{page_value}":{"get":{"summary":"getPage | Get page of a theme","description":"Use this API to retrieve a page of a theme.","tags":["Theme"],"parameters":[{"name":"company_id","in":"path","description":"Company ID","required":true,"schema":{"type":"integer","example":19243}},{"name":"application_id","in":"path","description":"Application ID","required":true,"schema":{"type":"string","example":"6487ea376e1442284917c44e"}},{"name":"theme_id","in":"path","description":"ID of the theme to be retrieved","required":true,"schema":{"type":"string"}},{"name":"page_value","in":"path","description":"Value of the page to be retrieved","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success. Returns an object of the page.  Refer `AvailablePageSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AvailablePageSchema"},"examples":{"Home page":{"$ref":"#/components/examples/AvailablePageExample"}}}}},"4XX":{"$ref":"#/components/responses/BlitzkriegApiError"},"5XX":{"$ref":"#/components/responses/BlitzkriegInternalServerError"}}},"put":{"summary":"updatePage | Updates a page ","description":"Use this API to update a page for a theme by its ID.","tags":["Theme"],"parameters":[{"name":"company_id","in":"path","description":"Company ID","required":true,"schema":{"type":"integer","example":19243}},{"name":"application_id","in":"path","description":"Application ID","required":true,"schema":{"type":"string","example":"6487ea376e1442284917c44e"}},{"name":"theme_id","in":"path","description":"ID of the theme","required":true,"schema":{"type":"string"}},{"name":"page_value","in":"path","description":"Value of the page to be updated","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AvailablePageSchema"},"examples":{"Success":{"$ref":"#/components/examples/AvailablePageExample"}}}}},"responses":{"200":{"description":"Success. Returns a the page of the theme. Refer `AvailablePageSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AvailablePageSchema"},"examples":{"page":{"$ref":"#/components/examples/AvailablePageExample"}}}}},"4XX":{"$ref":"#/components/responses/BlitzkriegApiError"},"5XX":{"$ref":"#/components/responses/BlitzkriegInternalServerError"}}},"delete":{"summary":"deletePage | Deletes a page ","description":"Use this API to delete a page for a theme by its ID and page_value.","tags":["Theme"],"parameters":[{"name":"company_id","in":"path","description":"Company ID","required":true,"schema":{"type":"integer","example":19243}},{"name":"application_id","in":"path","description":"Application ID","required":true,"schema":{"type":"string","example":"6487ea376e1442284917c44e"}},{"name":"theme_id","in":"path","description":"ID of the theme","required":true,"schema":{"type":"string"}},{"name":"page_value","in":"path","description":"Value of the page to be updated","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success. Returns a the page of the theme. Refer `AvailablePageSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AvailablePageSchema"},"examples":{"page":{"$ref":"#/components/examples/AvailablePageExample"}}}}},"4XX":{"$ref":"#/components/responses/BlitzkriegApiError"},"5XX":{"$ref":"#/components/responses/BlitzkriegInternalServerError"}}}},"/service/platform/theme/v1.0/company/{company_id}/application/{application_id}/library":{"get":{"deprecated":true,"summary":"getThemeLibrary | Get a list of themes from the theme library","description":"Theme library is a personalized collection of themes that are chosen and added from the available themes. Use this API to fetch a list of themes from the library along with their configuration details. ","tags":["Theme"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform.","required":true,"schema":{"type":"integer","example":19243}},{"name":"application_id","in":"path","description":"Alphanumeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string","example":"6487ea376e1442284917c44e"}},{"name":"page_size","in":"query","description":"The number of items to retrieve in each page. Default value is 10. ","required":false,"schema":{"type":"integer","default":10}},{"name":"page_no","in":"query","description":"The page number to navigate through the given set of results. Default value is 1.","required":false,"schema":{"type":"integer","default":1}}],"responses":{"200":{"description":"Success. Refer `FontsSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DummyResponse"}}}},"404":{"$ref":"#/components/responses/DeprecatedApiError"}}},"post":{"deprecated":true,"summary":"addToThemeLibrary | Add a theme to the theme library","description":"Theme library is a personalized collection of themes that are chosen and added from the available themes. Use this API to choose a theme and add it to the theme library.","tags":["Theme"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform.","required":true,"schema":{"type":"integer","example":19243}},{"name":"application_id","in":"path","description":"Alphanumeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string","example":"6487ea376e1442284917c44e"}}],"requestBody":{"description":"Pass the theme id in the request body.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddThemeRequestSchema"},"example":{"theme_id":"5e5bbf3ce442c5033e90935b"}}}},"responses":{"200":{"description":"Success. Refer `FontsSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DummyResponse"}}}},"404":{"$ref":"#/components/responses/DeprecatedApiError"}}}},"/service/platform/theme/v1.0/company/{company_id}/application/{application_id}/list/public":{"get":{"deprecated":true,"summary":"getPublicThemes | Get all public themes","description":"Use this API to get a list of free themes that you can apply to your website.","tags":["Theme"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform.","required":true,"schema":{"type":"integer","example":19243}},{"name":"application_id","in":"path","description":"Alphanumeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string","example":"6487ea376e1442284917c44e"}},{"name":"page_size","in":"query","description":"The number of items to retrieve in each page. Default value is 10. ","required":false,"schema":{"type":"integer","default":10}},{"name":"page_no","in":"query","description":"The page number to navigate through the given set of results. Default value is 1. ","required":false,"schema":{"type":"integer","default":1}}],"responses":{"200":{"description":"Success. Refer `FontsSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DummyResponse"}}}},"404":{"$ref":"#/components/responses/DeprecatedApiError"}}}},"/service/platform/theme/v1.0/company/{company_id}/application/{application_id}/fonts":{"get":{"summary":"getFonts | Get all the supported fonts in a theme","description":"Font is a collection of characters with a similar design. Use this API to retrieve a list of website fonts.","tags":["Theme"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform.","required":true,"schema":{"type":"integer","example":19243}},{"name":"application_id","in":"path","description":"Alphanumeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string","example":"6487ea376e1442284917c44e"}}],"responses":{"200":{"description":"Success. Refer `FontsSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FontsSchema"},"examples":{"Success":{"$ref":"#/components/examples/FontsResponse"}}}}},"4XX":{"$ref":"#/components/responses/BlitzkriegApiError"},"5XX":{"$ref":"#/components/responses/BlitzkriegApiError"}}}},"/service/platform/theme/v1.0/company/{company_id}/application/{application_id}/{theme_id}/publish":{"put":{"deprecated":true,"summary":"publishTheme | Publish a theme","description":"Use this API to publish a theme that is either newly created or edited.","tags":["Theme"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform.","required":true,"schema":{"type":"integer","example":19243}},{"name":"application_id","in":"path","description":"Alphanumeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string","example":"6487ea376e1442284917c44e"}},{"name":"theme_id","in":"path","description":"ID allotted to the theme.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success. Refer `FontsSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DummyResponse"}}}},"404":{"$ref":"#/components/responses/DeprecatedApiError"}}}},"/service/platform/theme/v1.0/company/{company_id}/application/{application_id}/{theme_id}/unpublish":{"put":{"deprecated":true,"summary":"unpublishTheme | Unpublish a theme","description":"Use this API to remove an existing theme from the list of available themes.","tags":["Theme"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform.","required":true,"schema":{"type":"integer","example":19243}},{"name":"application_id","in":"path","description":"Alphanumeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string","example":"6487ea376e1442284917c44e"}},{"name":"theme_id","in":"path","description":"ID allotted to the theme.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success. Refer `FontsSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DummyResponse"}}}},"404":{"$ref":"#/components/responses/DeprecatedApiError"}}}},"/service/platform/theme/v1.0/company/{company_id}/application/{application_id}/{theme_id}/archive":{"put":{"deprecated":true,"summary":"archiveTheme | Archive a theme","description":"Use this API to store an existing theme but not delete it so that it can be used in future if required. ","tags":["Theme"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform.","required":true,"schema":{"type":"integer","example":19243}},{"name":"application_id","in":"path","description":"Alphanumeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string","example":"6487ea376e1442284917c44e"}},{"name":"theme_id","in":"path","description":"ID allotted to the theme.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success. Refer `FontsSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DummyResponse"}}}},"404":{"$ref":"#/components/responses/DeprecatedApiError"}}}},"/service/platform/theme/v1.0/company/{company_id}/application/{application_id}/{theme_id}/unarchive":{"put":{"deprecated":true,"summary":"unarchiveTheme | Unarchive a theme","description":"Use this API to restore an archived theme and bring it back for editing or publishing. ","tags":["Theme"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform.","required":true,"schema":{"type":"integer","example":19243}},{"name":"application_id","in":"path","description":"Alphanumeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string","example":"6487ea376e1442284917c44e"}},{"name":"theme_id","in":"path","description":"ID allotted to the theme.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success. Refer `FontsSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DummyResponse"}}}},"404":{"$ref":"#/components/responses/DeprecatedApiError"}}}},"/service/platform/theme/v2.0/company/{company_id}/themes":{"get":{"tags":["Theme"],"summary":"getCompanyLevelThemes | Get themes for a company","description":"Retrieve a list of themes available for a specific company.","parameters":[{"name":"company_id","in":"path","description":"The ID of the company to retrieve the themes associated with it.","required":true,"schema":{"type":"integer","example":19243}},{"name":"search_text","in":"query","description":"Search Text to match the Theme Names and return the response.","required":false,"schema":{"type":"string","example":"Astra"}}],"responses":{"200":{"description":"A list of themes for the company.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CompanyThemeSchema"}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BlitzkriegApiErrorSchema"}}}}}}}},"/service/platform/theme/v2.0/company/{company_id}/private_themes":{"get":{"tags":["Theme"],"summary":"getCompanyLevelPrivateThemes | Get private themes for a company","description":"Retrieve a list of private themes available for a specific company.","parameters":[{"name":"company_id","in":"path","description":"The ID of the company to retrieve the themes associated with it.","required":true,"schema":{"type":"integer","example":19243}},{"name":"search_text","in":"query","description":"Search Text to match the Theme Names and return the response.","schema":{"type":"string","example":"Astra"}}],"responses":{"200":{"description":"A list of Private themes for the company.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CompanyPrivateTheme"}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BlitzkriegApiErrorSchema"}}}}}}}},"/service/platform/theme/v2.0/company/{company_id}":{"post":{"tags":["Theme"],"summary":"addMarketplaceThemeToCompany | Add a theme to a company","description":"Add a marketplace theme to a company by providing the theme ID and company ID.","parameters":[{"name":"company_id","in":"path","description":"The ID of the company to apply the theme to.","required":true,"schema":{"type":"integer","example":19243}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThemeReq"}}}},"responses":{"200":{"description":"The theme was successfully applied to the company.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyThemeSchema"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlitzkriegApiErrorSchema"}}}}}}},"/service/platform/theme/v2.0/company/{company_id}/{theme_id}":{"delete":{"tags":["Theme"],"summary":"deleteCompanyTheme | Delete a theme","description":"Delete a specific theme for a company by providing the company ID and theme ID.","parameters":[{"in":"path","name":"company_id","schema":{"type":"integer","example":19243},"required":true,"description":"The ID of the company."},{"in":"path","name":"theme_id","schema":{"type":"string"},"required":true,"description":"The ID of the theme."}],"responses":{"200":{"description":"Theme deleted successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyThemeSchema"}}}}}}},"/service/platform/theme/v2.0/company/{company_id}/application/{application_id}/themes":{"get":{"summary":"getApplicationThemes | Get all the themes for a specific application","description":"Get all the themes for a specific application","tags":["Theme"],"parameters":[{"in":"path","name":"company_id","required":true,"description":"The ID of the company","schema":{"type":"integer"},"examples":{"example1":{"summary":"Example 1 - Company ID","value":19243},"example2":{"summary":"Example 2 - Company ID","value":98765}}},{"in":"path","name":"application_id","required":true,"description":"The ID of the application","schema":{"type":"string"},"examples":{"example1":{"summary":"Example 1 - Application ID","value":"6487ea376e1442284917c44e"},"example2":{"summary":"Example 2 - Application ID","value":"7487ea376e1442284917c44e"}}}],"responses":{"200":{"description":"The list of themes for the application was fetched successfully.","content":{"application/json":{"schema":{"type":"array","description":"The body of the response object containing the list of themes for a specific application.","items":{"$ref":"#/components/schemas/ThemesSchema"}},"examples":{"example1":{"$ref":"#/components/examples/ThemesExample1"},"example2":{"$ref":"#/components/examples/ThemesExample2"}}}}}}}},"/service/platform/theme/v2.0/company/{company_id}/application/{application_id}/application_themes_count":{"get":{"summary":"getApplicationThemesCount | Get the count of themes for a specific application","description":"Get the count of themes for a specific application","tags":["Theme"],"parameters":[{"in":"path","name":"company_id","required":true,"description":"The ID of the company","schema":{"type":"integer","example":19243}},{"in":"path","name":"application_id","required":true,"description":"The ID of the application","schema":{"type":"string","example":"6487ea376e1442284917c44e"}}],"responses":{"200":{"description":"The count of themes for the application was fetched successfully.","content":{"application/json":{"schema":{"type":"object","description":"The body of the response object containing the count of themes for a specific application.","properties":{"message":{"type":"string","description":"A message indicating the success of fetching the themes count.","example":"Themes Count For Application Fetched Succesfully"},"count":{"type":"integer","description":"The count of themes for the application.","example":10}}}}}}}}},"/service/platform/theme/v2.0/company/{company_id}/application/{application_id}/{theme_id}":{"get":{"summary":"getThemeById | Get Theme By Theme Id","description":"Get Theme By Theme Id","tags":["Theme"],"parameters":[{"in":"path","name":"company_id","required":true,"description":"The ID of the company","schema":{"type":"integer","example":19243}},{"in":"path","name":"application_id","required":true,"description":"The ID of the application","schema":{"type":"string","example":"6487ea376e1442284917c44e"}},{"in":"path","name":"theme_id","required":true,"description":"The ID of the theme","schema":{"type":"string","example":"64be4423bc7b28003211322e"}}],"responses":{"200":{"description":"The Details of themes for the application was fetched successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThemesSchema"}}}}}},"put":{"summary":"updateTheme | Update theme for a specific company and application","description":"Update theme for a specific company and application","tags":["Theme"],"parameters":[{"in":"path","name":"company_id","schema":{"type":"integer","example":19243},"required":true,"description":"The ID of the company."},{"in":"path","name":"application_id","schema":{"type":"string","example":"6487ea376e1442284917c44e"},"required":true,"description":"The ID of the application."},{"in":"path","name":"theme_id","schema":{"type":"string","example":"64be4423bc7b28003211322e"},"required":true,"description":"The ID of the theme."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateThemeRequestBody"}}}},"responses":{"200":{"description":"Theme updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThemesSchema"},"examples":{"example1":{"$ref":"#/components/examples/ThemeExample1"},"example2":{"$ref":"#/components/examples/ThemeExample2"}}}}}}},"delete":{"tags":["Theme"],"summary":"deleteTheme | Delete a theme","description":"This endpoint is used to delete a theme from the specified company and application.","parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","example":19243},"description":"The ID of the company."},{"name":"application_id","in":"path","required":true,"schema":{"type":"string","example":"6487ea376e1442284917c44e"},"description":"The ID of the application."},{"name":"theme_id","in":"path","required":true,"schema":{"type":"string","example":"64be4423bc7b28003211322e"},"description":"The ID of the theme to be deleted."}],"responses":{"200":{"description":"Theme successfully deleted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThemesSchema"},"examples":{"example1":{"$ref":"#/components/examples/ThemeExample1"},"example2":{"$ref":"#/components/examples/ThemeExample2"}}}}}}}},"/service/platform/theme/v2.0/company/{company_id}/application/{application_id}/":{"post":{"summary":"addThemeToApplication | Add a theme to an application","description":"Add a theme to an application by providing the marketplace theme ID.","tags":["Theme"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform.","required":true,"schema":{"type":"integer","example":19243}},{"name":"application_id","in":"path","description":"Alphanumeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string","example":"6487ea376e1442284917c44e"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThemeReq"},"examples":{"example1":{"$ref":"#/components/examples/ThemeExample1"},"example2":{"$ref":"#/components/examples/ThemeExample2"}}}}},"responses":{"200":{"description":"Theme","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThemesSchema"},"examples":{"example1":{"$ref":"#/components/examples/ThemeExample1"},"example2":{"$ref":"#/components/examples/ThemeExample2"}}}}},"4XX":{"$ref":"#/components/responses/BlitzkriegApiError"},"5XX":{"$ref":"#/components/responses/BlitzkriegApiError"}}}},"/service/platform/theme/v2.0/company/{company_id}/application/{application_id}/{theme_id}/name":{"patch":{"summary":"updateThemeName | Update Theme Name","description":"Update the name of a theme for a specific company and application.","tags":["Theme"],"parameters":[{"in":"path","name":"company_id","required":true,"schema":{"type":"integer","example":19243},"description":"The ID of the company."},{"in":"path","name":"application_id","required":true,"schema":{"type":"string","example":"6487ea376e1442284917c44e"},"description":"The ID of the application."},{"in":"path","name":"theme_id","required":true,"schema":{"type":"string"},"description":"The ID of the theme to be updated."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateThemeNameRequestBody"},"examples":{"example1":{"$ref":"#/components/examples/UpdateThemeNameRequestBodyExample1"},"example2":{"$ref":"#/components/examples/UpdateThemeNameRequestBodyExample2"}}}}},"responses":{"200":{"description":"Theme name updated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThemesSchema"},"examples":{"example1":{"$ref":"#/components/examples/ThemeExample1"},"example2":{"$ref":"#/components/examples/ThemeExample2"}}}}}}}},"/service/platform/theme/v2.0/company/{company_id}/application/{application_id}/{theme_id}/apply":{"patch":{"summary":"applyTheme | Apply theme to a specific application","description":"Apply theme to a specific application by providing company_id, application_id, and theme_id.","tags":["Theme"],"parameters":[{"in":"path","name":"company_id","description":"The ID of the company","required":true,"schema":{"type":"integer","example":19243}},{"in":"path","name":"application_id","description":"The ID of the application","required":true,"schema":{"type":"string","example":"6487ea376e1442284917c44e"}},{"in":"path","name":"theme_id","description":"The ID of the apply","required":true,"schema":{"type":"string"},"examples":{"example1":{"summary":"Example 1 - Theme ID","value":"648832dcb99296ab200fbaaa"},"example2":{"summary":"Example 2 - Theme ID","value":"64b91fe317422a1e1392f85b"}}}],"responses":{"200":{"description":"Theme applied successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThemesSchema"},"examples":{"example1":{"$ref":"#/components/examples/ThemeExample1"},"example2":{"$ref":"#/components/examples/ThemeExample2"}}}}}}}},"/service/platform/theme/v2.0/company/{company_id}/application/{application_id}/{theme_id}/duplicate":{"post":{"summary":"duplicateTheme | Duplicate a Theme","description":"This endpoint duplicates a Theme in the specified application.","tags":["Theme"],"parameters":[{"name":"company_id","in":"path","description":"The ID of the company","required":true,"schema":{"type":"integer","example":19243}},{"name":"application_id","in":"path","description":"The ID of the application","required":true,"schema":{"type":"string","example":"6487ea376e1442284917c44e"}},{"name":"theme_id","in":"path","description":"The ID of the theme to be duplicated","required":true,"schema":{"type":"string"},"examples":{"example1":{"summary":"Example 1 - Theme ID","value":"648832dcb99296ab200fbaaa"},"example2":{"summary":"Example 2 - Theme ID","value":"64b91fe317422a1e1392f85b"}}}],"responses":{"200":{"description":"Resource duplicated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThemesSchema"},"examples":{"example1":{"$ref":"#/components/examples/ThemeExample1"},"example2":{"$ref":"#/components/examples/ThemeExample2"}}}}}}}},"/service/platform/theme/v2.0/company/{company_id}/application/{application_id}":{"get":{"summary":"getAppliedTheme | Get the Applied theme of an Application","description":"Get Applied Theme of an Application by Application Id","tags":["Theme"],"parameters":[{"name":"company_id","in":"path","description":"The ID of the company","required":true,"schema":{"type":"integer","example":19243}},{"name":"application_id","in":"path","description":"The ID of the application","required":true,"schema":{"type":"string","example":"6487ea376e1442284917c44e"}}],"responses":{"200":{"description":"Successfully fetch the applied theme","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThemesSchema"},"examples":{"example1":{"$ref":"#/components/examples/ThemeExample1"},"example2":{"$ref":"#/components/examples/ThemeExample2"}}}}}}}},"/service/platform/theme/v2.0/company/{company_id}/application/{application_id}/{theme_id}/preview":{"get":{"summary":"getThemeForPreview | Get Theme Preview By Theme Id","description":"Get Theme Preview By Theme Id","tags":["Theme"],"parameters":[{"in":"path","name":"company_id","required":true,"description":"The ID of the company","schema":{"type":"integer","example":19243}},{"in":"path","name":"application_id","required":true,"description":"The ID of the application","schema":{"type":"string","example":"6487ea376e1442284917c44e"}},{"in":"path","name":"theme_id","required":true,"description":"The ID of the theme","schema":{"type":"string","example":"6487ea376e1442284917c44e"}}],"responses":{"200":{"description":"Get the details of the theme for preview purpose.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThemesSchema"},"examples":{"example1":{"$ref":"#/components/examples/ThemeExample1"},"example2":{"$ref":"#/components/examples/ThemeExample2"}}}}}}}},"/service/platform/theme/v2.0/company/{company_id}/application/{application_id}/{theme_id}/polling":{"head":{"summary":"getThemeLastModified | Fetch last modified timestamp","description":"Use this API to fetch Last-Modified timestamp in header metadata.","tags":["Theme"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform.","required":true,"schema":{"type":"integer","example":19243}},{"name":"application_id","in":"path","description":"Alphanumeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string","example":"6487ea376e1442284917c44e"}},{"name":"theme_id","in":"path","description":"ID allotted to the theme.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success. Recieves last modified timestamp in the header.","headers":{"Last-Modified":{"schema":{"type":"string","format":"date","description":"Last-modified action on Theme"}}}},"4XX":{"$ref":"#/components/responses/BlitzkriegApiError"},"5XX":{"$ref":"#/components/responses/BlitzkriegApiError"}}}},"/service/platform/theme/v2.0/company/{company_id}/application/{application_id}/{theme_id}/upgradable":{"get":{"summary":"isUpgradable | Check if the theme is upgradable","description":"This API endpoint checks if the theme is upgradable for a specific company and application.","tags":["Theme"],"parameters":[{"name":"company_id","in":"path","required":true,"description":"The ID of the company","schema":{"type":"integer","example":19243}},{"name":"application_id","in":"path","required":true,"description":"The ID of the application","schema":{"type":"string","example":"6487ea376e1442284917c44e"}},{"name":"theme_id","in":"path","required":true,"description":"The ID of the theme","schema":{"type":"string","example":"648832dcb99296ab200fbaaa"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThemeUpgradableResponse"},"examples":{"example1":{"$ref":"#/components/examples/ThemeUpgradableResponseExapmple1"},"example2":{"$ref":"#/components/examples/ThemeUpgradableResponseExapmple2"}}}}}}}},"/service/platform/theme/v2.0/company/{company_id}/application/{application_id}/{theme_id}/upgrade":{"put":{"summary":"upgradeTheme | Upgrade an application","description":"This endpoint allows you to upgrade an application.","tags":["Theme"],"parameters":[{"name":"company_id","in":"path","description":"The ID of the company","required":true,"schema":{"type":"integer","example":19243}},{"name":"application_id","in":"path","description":"The ID of the application","required":true,"schema":{"type":"string","example":"6487ea376e1442284917c44e"}},{"name":"theme_id","in":"path","description":"The ID of the upgrade","required":true,"schema":{"type":"string","example":"64883302baad790ae4898314"}}],"responses":{"200":{"description":"Successful upgrade","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThemesSchema"},"examples":{"example1":{"$ref":"#/components/examples/ThemeExample1"},"example2":{"$ref":"#/components/examples/ThemeExample2"}}}}}}}},"/service/platform/user/v1.0/company/{company_id}/application/{application_id}/customers/list":{"get":{"summary":"getCustomers | Get a list of customers","description":"Use this API to retrieve a list of customers who have registered in the application.","tags":["User"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform.","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Alphanumeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}},{"name":"q","in":"query","description":"The search query. Mobile number or email ID of a customer.","required":false,"schema":{"type":"string"}},{"name":"page_size","in":"query","description":"The number of items to retrieve in each page. Default value is 10.","required":false,"schema":{"type":"integer","default":10}},{"name":"page_no","in":"query","description":"The page number to navigate through the given set of results. Default value is 1. ","required":false,"schema":{"type":"integer","default":1}}],"responses":{"200":{"description":"Success. Refer `CustomerListResponseSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerListResponseSchema"},"examples":{"Success":{"$ref":"#/components/examples/CustomersListResponse"}}}}},"4XX":{"$ref":"#/components/responses/AuthenticationApiError"},"5XX":{"$ref":"#/components/responses/AuthenticationApiError"}}}},"/service/platform/user/v1.0/company/{company_id}/application/{application_id}/customers/search":{"get":{"summary":"searchUsers | Search an existing user.","description":"Use this API to retrieve an existing user from a list.","tags":["User"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform.","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Alphanumeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}},{"name":"q","in":"query","description":"The search query. Mobile number or email ID of a customer.","required":false,"schema":{"type":"string"}},{"name":"query","in":"query","description":"The search queries. Mobile numbers or email IDs of customers.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success. Returns first name, last name, emails, phone number and gender of the user. Refer `UserSearchResponseSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserSearchResponseSchema"},"example":{"users":[{"_id":"5e68af49cfa09bf7233022f1","gender":"male","active":true,"emails":[{"active":true,"primary":true,"verified":true,"email":"akashmane@gofynd.com"},{"active":true,"primary":false,"verified":true,"email":"akashmane@fynd.com"},{"active":true,"primary":false,"verified":true,"email":"akashmane@uniket.store"}],"account_type":"user","first_name":"Akash","last_name":"Mane","phone_numbers":[{"active":true,"primary":true,"verified":true,"phone":"8652523958","country_code":91}],"created_at":"2020-03-11T09:28:41.982Z","updated_at":"2020-03-11T09:28:41.982Z"}]}}}},"4XX":{"$ref":"#/components/responses/AuthenticationApiError"},"5XX":{"$ref":"#/components/responses/AuthenticationApiError"}}}},"/service/platform/user/v1.0/company/{company_id}/application/{application_id}/customers":{"post":{"summary":"createUser | Create user","description":"Create user","tags":["User"],"parameters":[{"name":"company_id","in":"path","description":"Company ID","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Application ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUserRequestSchema"},"example":{"gender":"male","first_name":"Akash","last_name":"Mane","phone_number":"919987258698","email":"akashmane@gofynd.com","username":"akashmane@gofynd.com","external_id":"100002000036789","meta":{}}}}},"responses":{"200":{"description":"User create","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUserResponseSchema"},"example":{"user":{"_id":"5e68af49cfa09bf7233022f1","gender":"male","active":true,"emails":[{"active":true,"primary":true,"verified":true,"email":"akashmane@gofynd.com"},{"active":true,"primary":false,"verified":true,"email":"akashmane@fynd.com"},{"active":true,"primary":false,"verified":true,"email":"akashmane@uniket.store"}],"external_id":"100002000036789","account_type":"user","first_name":"Akash","last_name":"Mane","phone_numbers":[{"active":true,"primary":true,"verified":true,"phone":"8652523958","country_code":91}],"meta":{},"created_at":"2020-03-11T09:28:41.982Z","updated_at":"2020-03-11T09:28:41.982Z"}}}}},"4XX":{"$ref":"#/components/responses/AuthenticationApiError"},"5XX":{"$ref":"#/components/responses/AuthenticationApiError"}}}},"/service/platform/user/v1.0/company/{company_id}/application/{application_id}/customers/activation":{"put":{"summary":"blockOrUnblockUsers | Block/Unblock user","description":"Block/Unblock user","tags":["User"],"parameters":[{"name":"company_id","in":"path","description":"Company ID","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Application ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUserRequestSchema"},"example":{"user_id":["61f02c3dcc701256044ed6c0"],"status":false,"reason":"Multiple fake orders or returns"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUserSuccess"},"example":{"success":true}}}},"4XX":{"$ref":"#/components/responses/AuthenticationApiError"},"5XX":{"$ref":"#/components/responses/AuthenticationApiError"}}}},"/service/platform/user/v1.0/company/{company_id}/application/{application_id}/customers/archive":{"put":{"summary":"archiveUser | archive user","description":"archive user","tags":["User"],"parameters":[{"name":"company_id","in":"path","description":"Company ID","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Application ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ArchiveUserRequestSchema"},"example":{"user_id":"61f02c3dcc701256044ed6c0"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ArchiveUserSuccess"},"example":{"success":true}}}},"4XX":{"$ref":"#/components/responses/AuthenticationApiError"},"5XX":{"$ref":"#/components/responses/AuthenticationApiError"}}}},"/service/platform/user/v1.0/company/{company_id}/application/{application_id}/customers/undelete":{"put":{"summary":"unDeleteUser | undelete user who deleted from application and have not elapsed the platform configured delete days","description":"undelete user who deleted from application and have not elapsed the platform configured delete days","tags":["User"],"parameters":[{"name":"company_id","in":"path","description":"Company ID","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Application ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnDeleteUserRequestSchema"},"example":{"user_id":"61f02c3dcc701256044ed6c0","reason":"test","reason_id":"1234"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnDeleteUserSuccess"},"example":{"success":true}}}},"4XX":{"$ref":"#/components/responses/AuthenticationApiError"},"5XX":{"$ref":"#/components/responses/AuthenticationApiError"}}}},"/service/platform/user/v1.0/company/{company_id}/application/{application_id}/customers/{user_id}":{"put":{"summary":"updateUser | Update user","description":"Use this API to update user details, Note: Existing emails and phone numbers of user will be replaced directly if phone_numbers or emails field sent in request data.","tags":["User"],"parameters":[{"name":"company_id","in":"path","description":"Company ID","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Application ID","required":true,"schema":{"type":"string"}},{"name":"user_id","in":"path","description":"User ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUserRequestSchema"},"example":{"gender":"male","first_name":"Akash","last_name":"Mane","external_id":"100002000036789","meta":{},"emails":[{"active":true,"primary":true,"verified":true,"email":"testuser@gofynd.com"}],"phoneNumbers":[{"active":true,"primary":true,"verified":true,"phone":"9988779988","country_code":91}]}}}},"responses":{"200":{"description":"User update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUserResponseSchema"},"example":{"user":{"_id":"5e68af49cfa09bf7233022f1","gender":"male","active":true,"emails":[{"active":true,"primary":true,"verified":true,"email":"akashmane@gofynd.com"},{"active":true,"primary":false,"verified":true,"email":"akashmane@fynd.com"},{"active":true,"primary":false,"verified":true,"email":"akashmane@uniket.store"}],"external_id":"100002000036789","account_type":"user","first_name":"Akash","last_name":"Mane","phone_numbers":[{"active":true,"primary":true,"verified":true,"phone":"8652523958","country_code":91}],"meta":{},"created_at":"2020-03-11T09:28:41.982Z","updated_at":"2020-03-11T09:28:41.982Z"}}}}},"4XX":{"$ref":"#/components/responses/AuthenticationApiError"},"5XX":{"$ref":"#/components/responses/AuthenticationApiError"}}}},"/service/platform/user/v1.0/company/{company_id}/application/{application_id}/customers/session":{"post":{"summary":"createUserSession | Create user session","description":"Create user session","tags":["User"],"parameters":[{"name":"company_id","in":"path","description":"Company ID","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Application ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUserSessionRequestSchema"},"example":{"domain":"vinit.com","max_age":4555555,"user_id":"606da812f004bb7c655f70bb"}}}},"responses":{"200":{"description":"Create user session","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUserSessionResponseSchema"},"example":{"domain":"vinit.com","max_age":4555555,"secure":true,"http_only":true,"cookie":{"f.session":"s%3A-LrEF5FVR8jrT5DCtCHSbAy7JFyX-f9T.uXOQwzje8nOfx4ODANrLi4yNX5fW2W5kLQ2rkBdO2xE"}}}}},"4XX":{"$ref":"#/components/responses/AuthenticationApiError"},"5XX":{"$ref":"#/components/responses/AuthenticationApiError"}}},"delete":{"summary":"deleteSession | Delete a session for a user","description":"Use this API to Delete a session of customers who have registered in the application.","tags":["User"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform.","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Alphanumeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}},{"name":"id","in":"query","description":"ID of a customer.","required":true,"schema":{"type":"string"}},{"name":"session_id","in":"query","description":"Session ID of a customer.","required":true,"schema":{"type":"string"}},{"name":"reason","in":"query","description":"Reason for deleting session.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success. Refer `SessionDeleteResponseSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SessionDeleteResponseSchema"},"examples":{"Success":{"$ref":"#/components/examples/SessionDeleteResponse"}}}}},"4XX":{"$ref":"#/components/responses/AuthenticationApiError"},"5XX":{"$ref":"#/components/responses/AuthenticationApiError"}}}},"/service/platform/user/v1.0/company/{company_id}/application/{application_id}/customers/sessions":{"get":{"summary":"getActiveSessions | Get a list of all session with info for a user","description":"Use this API to retrieve a list of session with info of customers who have registered in the application.","tags":["User"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform.","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Alphanumeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}},{"name":"id","in":"query","description":"ID of a customer.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success. Refer `SessionListResponseSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SessionListResponseSchema"},"examples":{"Success":{"$ref":"#/components/examples/SessionListResponse"}}}}},"4XX":{"$ref":"#/components/responses/AuthenticationApiError"},"5XX":{"$ref":"#/components/responses/AuthenticationApiError"}}},"delete":{"summary":"deleteActiveSessions | Delete a list of all session for a user","description":"Use this API to Delete a list of session of customers who have registered in the application.","tags":["User"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform.","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Alphanumeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}},{"name":"id","in":"query","description":"ID of a customer.","required":true,"schema":{"type":"string"}},{"name":"reason","in":"query","description":"Reason to delete sessions.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success. Refer `SessionsDeleteResponseSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SessionsDeleteResponseSchema"},"examples":{"Success":{"$ref":"#/components/examples/SessionsDeleteResponse"}}}}},"4XX":{"$ref":"#/components/responses/AuthenticationApiError"},"5XX":{"$ref":"#/components/responses/AuthenticationApiError"}}}},"/service/platform/user/v1.0/company/{company_id}/application/{application_id}/platform/config":{"get":{"summary":"getPlatformConfig | Get platform configurations","description":"Use this API to get all the platform configurations such as mobile image, desktop image, social logins, and all other text.","tags":["User"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform.","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Alphanumeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success. Returns a JSON object containing the all the platform configurations. Refer `PlatformSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformSchema"},"example":{"active":true,"mobile_image":"","desktop_image":"","social":{"facebook":true,"google":true,"account_kit":true},"flash_card":{"text":"","text_color":"#FFFFFF","background_color":"#EF5350"},"register":true,"forgot_password":true,"login":{"password":true,"otp":true},"skip_captcha":false,"display":"Fynd","subtext":"Login to Fynd","name":"Fynd","meta":{},"required_fields":{"email":{"is_required":false,"level":"hard"},"mobile":{"is_required":true,"level":"hard"}},"register_required_fields":{"email":{"is_required":false,"level":"hard"},"mobile":{"is_required":true,"level":"hard"}},"skip_login":false,"look_and_feel":{"background_color":"#F5F5F5","card_position":"center"},"social_tokens":{"google":{"appId":"token_123"},"facebook":{"appId":"token_123"},"account_kit":{"appId":"token_123"}},"session_config":{"duration":30,"type":"Days","is_rolling":false},"delete_account_reasons":[{"reason_text":"test","reason_id":"123","show_text_area":true}],"delete_account_day":7,"delete_account_consent":{"consent_text":""},"_id":"5e04a5e5220bc15839ad9bc0","created_at":"2019-12-26T12:21:57.878Z","updated_at":"2020-08-13T14:31:09.878Z","__v":0}}}},"4XX":{"$ref":"#/components/responses/AuthenticationApiError"},"5XX":{"$ref":"#/components/responses/AuthenticationApiError"}}},"post":{"summary":"updatePlatformConfig | Update platform configurations","description":"Use this API to edit the existing platform configurations such as mobile image, desktop image, social logins, and all other text.","tags":["User"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform.","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Alphanumeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformSchema"},"example":{"active":true,"mobile_image":"","desktop_image":"","social":{"facebook":true,"google":true,"account_kit":true},"flash_card":{"text":"","text_color":"#FFFFFF","background_color":"#EF5350"},"register":true,"forgot_password":true,"login":{"password":true,"otp":true},"skip_captcha":false,"display":"Fynd","subtext":"Login to Fynd","name":"Fynd","meta":{},"required_fields":{"email":{"is_required":false,"level":"hard"},"mobile":{"is_required":true,"level":"hard"}},"register_required_fields":{"email":{"is_required":false,"level":"hard"},"mobile":{"is_required":true,"level":"hard"}},"skip_login":false,"look_and_feel":{"background_color":"#F5F5F5","card_position":"center"},"social_tokens":{"google":{"appId":"token_123"},"facebook":{"appId":"token_123"},"account_kit":{"appId":"token_123"}},"session_config":{"duration":30,"type":"Days","is_rolling":false},"delete_account_reasons":[{"reason_text":"test","reason_id":"123","show_text_area":true}],"delete_account_day":7,"delete_account_consent":{"consent_text":""},"_id":"5e04a5e5220bc15839ad9bc0","created_at":"2019-12-26T12:21:57.878Z","updated_at":"2020-08-13T14:31:09.878Z","__v":0}}}},"responses":{"200":{"description":"Success. Returns a JSON object with the updated platform configurations. Refer `PlatformSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformSchema"},"example":{"active":true,"mobile_image":"","desktop_image":"","social":{"facebook":true,"google":true,"account_kit":true},"flash_card":{"text":"","text_color":"#FFFFFF","background_color":"#EF5350"},"register":true,"forgot_password":true,"login":{"password":true,"otp":true},"skip_captcha":false,"display":"Fynd","subtext":"Login to Fynd","name":"Fynd","meta":{},"required_fields":{"email":{"is_required":false,"level":"hard"},"mobile":{"is_required":true,"level":"hard"}},"register_required_fields":{"email":{"is_required":false,"level":"hard"},"mobile":{"is_required":true,"level":"hard"}},"skip_login":false,"look_and_feel":{"background_color":"#F5F5F5","card_position":"center"},"social_tokens":{"google":{"appId":"token_123"},"facebook":{"appId":"token_123"},"account_kit":{"appId":"token_123"}},"session_config":{"duration":30,"type":"Days","is_rolling":false},"delete_account_reasons":[{"reason_text":"test","reason_id":"123","show_text_area":true}],"delete_account_day":7,"delete_account_consent":{"consent_text":""},"_id":"5e04a5e5220bc15839ad9bc0","created_at":"2019-12-26T12:21:57.878Z","updated_at":"2020-08-13T14:31:09.878Z","__v":0}}}},"4XX":{"$ref":"#/components/responses/AuthenticationApiError"},"5XX":{"$ref":"#/components/responses/AuthenticationApiError"}}}},"/service/platform/user/v1.0/company/{company_id}/application/{application_id}/user_group":{"post":{"summary":"createUserGroup | Create an User Group","description":"Use this API to create new user Group","tags":["User"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform.","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Alphanumeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUserGroup"},"example":{"name":"Group 1","description":"description","file_url":"url"}}}},"responses":{"201":{"description":"Success. returns created User Group. `UserGroupResponseSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserGroupResponseSchema"},"example":{"uid":469,"name":"test2","description":"test2","application_id":"000000000000000000000004","status":"pending","is_active":true,"type":"bulk","_id":"6540da9759b4f70ad817ace7","file_url":"testuerl2","created_at":"2023-10-31T10:44:39.809Z","modified_at":"2023-10-31T10:44:39.809Z","__v":0}}}},"4XX":{"$ref":"#/components/responses/AuthenticationApiError"},"5XX":{"$ref":"#/components/responses/AuthenticationApiError"}}},"get":{"summary":"getUserGroups | Get User Groups mathcing criteria","description":"Use this API to get User Groups mathing criteria passed in query","tags":["User"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform.","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Alphanumeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}},{"name":"page_no","in":"query","description":"page number for pagination result","required":false,"schema":{"type":"string"}},{"name":"page_size","in":"query","description":"page size for pagination result","required":false,"schema":{"type":"string"}},{"name":"name","in":"query","description":"to search for User Groups which contains given string in their name","required":false,"schema":{"type":"string"}},{"name":"type","in":"query","description":"to search for User Groups with given type","required":false,"schema":{"type":"string","enum":["bulk","conditional"]}},{"name":"status","in":"query","description":"to get User Groups with given status","required":false,"schema":{"type":"string"}},{"name":"group_uid","in":"query","description":"to get User Groups with given uid","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success. User Group details. `UserGroupListResponseSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserGroupListResponseSchema"},"example":{"items":[{"uid":469,"name":"test2","description":"test2","application_id":"000000000000000000000004","status":"pending","is_active":true,"type":"bulk","_id":"6540da9759b4f70ad817ace7","file_url":"testuerl2","created_at":"2023-10-31T10:44:39.809Z","modified_at":"2023-10-31T10:44:39.809Z","__v":0},{"uid":460,"name":"test","description":"test","application_id":"000000000000000000000004","status":"pending","is_active":true,"type":"bulk","_id":"6540da9759b4f70ad817ace8","file_url":"testuerl2","created_at":"2023-10-31T10:44:39.809Z","modified_at":"2023-10-31T10:44:39.809Z","__v":0}],"page":{"type":"number","current":1,"size":10,"item_total":0,"has_next":false}}}}},"4XX":{"$ref":"#/components/responses/AuthenticationApiError"},"5XX":{"$ref":"#/components/responses/AuthenticationApiError"}}}},"/service/platform/user/v1.0/company/{company_id}/application/{application_id}/user_group/{group_id}":{"put":{"summary":"updateUserGroup | Update an User Group","description":"Use this API to update an existing user Group","tags":["User"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform.","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Alphanumeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}},{"name":"group_id","in":"path","description":"Numeric ID allotted to a User Group","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUserGroupSchema"},"example":{"name":"Group 1","description":"description","file_url":"url"}}}},"responses":{"200":{"description":"Success. returns updated User Group. `UserGroupResponseSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserGroupResponseSchema"},"example":{"uid":469,"name":"test2","description":"test2","application_id":"000000000000000000000004","status":"pending","is_active":true,"type":"bulk","_id":"6540da9759b4f70ad817ace7","file_url":"testuerl2","created_at":"2023-10-31T10:44:39.809Z","modified_at":"2023-10-31T10:44:39.809Z","__v":0}}}},"4XX":{"$ref":"#/components/responses/AuthenticationApiError"},"5XX":{"$ref":"#/components/responses/AuthenticationApiError"}}},"get":{"summary":"getUserGroupById | Get an User Group by Id","description":"Use this API to get details of an existing user Group","tags":["User"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform.","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Alphanumeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}},{"name":"group_id","in":"path","description":"Numeric ID allotted to a User Group","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success. User Group details. `UserGroupResponseSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserGroupResponseSchema"},"example":{"is_active":true,"_id":"6345677535474fbb6944b7ce","name":"Group 1","description":"description","file_url":"url","status":"pending","uid":1,"application_id":"000000000000000000000001","created_at":"2022-10-11T12:54:13.539Z","modified_at":"2022-10-11T12:54:13.539Z","__v":0}}}},"4XX":{"$ref":"#/components/responses/AuthenticationApiError"},"5XX":{"$ref":"#/components/responses/AuthenticationApiError"}}},"patch":{"summary":"updateUserGroupPartially | Add or Remove an user from particular user group and update user group details","description":"Use this API to update user group details and add or remove an user to the user group.","tags":["User"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform.","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Alphanumeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}},{"name":"group_id","in":"path","description":"Numeric ID allotted to a User Group","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartialUserGroupUpdateSchema"},"examples":{"Update paritially via csv file":{"value":{"type":"file_url","file_url":"csv_file.url"}},"Update paritially via json object with phone number":{"value":{"type":"json","user_data":[{"phone_number":"0099889988","action":"add"}]}},"Update paritially via json object with user_id":{"value":{"type":"json","user_data":[{"user_id":"6515eae8a0a8295e2ba942ba","action":"add"}]}}}}}},"responses":{"200":{"description":"Success. returns updated User Group. `UserGroupResponseSchema` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserGroupResponseSchema"},"example":{"is_active":true,"_id":"6345677535474fbb6944b7ce","name":"Group 1","description":"description","file_url":"url","status":"pending","uid":1,"application_id":"000000000000000000000001","created_at":"2022-10-11T12:54:13.539Z","modified_at":"2022-10-11T12:54:13.539Z","__v":0}}}},"4XX":{"$ref":"#/components/responses/AuthenticationApiError"},"5XX":{"$ref":"#/components/responses/AuthenticationApiError"}}}},"/service/platform/user/v1.0/company/{company_id}/application/{application_id}/user_attribute/definition":{"post":{"summary":"createUserAttributeDefinition | Create a User Attribute Definition","description":"Use this API to areate a new User Attribute Definition","tags":["User"],"parameters":[{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform.","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Alphanumeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUserAttributeDefinition"},"example":{"name":"Attribute 1","description":"description","type":"string","slug":"attribute-1","default_value":"abcd","customer_editable":false,"encrypted":false,"pinned":true,"pin_order":1,"validations":[{"type":"min","value":8},{"type":"max","value":16}]}}}},"responses":{"200":{"description":"Success. returns created User Attribute Definition. `UserAttributeDefinitionResponse` for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserAttributeDefinitionResponse"},"example":{"_id":"5e68af49cfa09bf7233022f1","name":"example_name","slug":"example_key","description":"example_description","application_id":"application_id_example","type":"string","multi_value":false,"customer_editable":true,"encrypted":false,"pinned":true,"pin_order":2,"validations":[{"type":"min","value":1}],"is_locked":false,"created_by":"5f6d1d7774e48a04969b2ea7","updated_by":"5f6d1d7774e48a04969b2ea7","created_at":"2023-10-17T10:00:00Z","modified_at":"2023-10-17T10:05:00Z"}}}},"4XX":{"$ref":"#/components/responses/AuthenticationApiError"},"5XX":{"$ref":"#/components/responses/AuthenticationApiError"}}},"get":{"summary":"getUserAttributeDefinitions | Get User Attribute Definitions","description":"Retrieve user attribute definitions.","parameters":[{"in":"query","name":"excluding_ids","schema":{"type":"string"},"description":"Exclude attribute definitions by Ids"},{"in":"query","name":"slug","schema":{"type":"string"},"description":"Filter by attribute slug."},{"in":"query","name":"type","schema":{"type":"string"},"description":"Filter by attribute type."},{"in":"query","name":"customer_editable","schema":{"type":"boolean"},"description":"Filter by customer_editable status."},{"in":"query","name":"encrypted","schema":{"type":"boolean"},"description":"Filter by encrypted status."},{"in":"query","name":"pinned","schema":{"type":"boolean"},"description":"Filter by pinned status."},{"in":"query","name":"pin_order","schema":{"type":"integer"},"description":"Filter by pin order."},{"in":"query","name":"is_locked","schema":{"type":"boolean"},"description":"Filter by locked status."},{"in":"query","name":"name","schema":{"type":"string"},"description":"Filter by attribute name using a case-insensitive regex."},{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform.","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Alphanumeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}},{"name":"page_size","in":"query","description":"The number of items to retrieve in each page. Default value is 10.","required":false,"schema":{"type":"integer","default":10}},{"name":"page_no","in":"query","description":"The page number to navigate through the given set of results. Default value is 1. ","required":false,"schema":{"type":"integer","default":1}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/UserAttributeDefinition"},"example":[{"_id":"652ecb965ec66ef03da26f77","name":"Attribute Def 6","slug":"attribute6","description":"attribute6","application_id":"000000000000000000000001","type":"date","multi_value":false,"customer_editable":false,"encrypted":false,"pinned":false,"validations":[{"type":"max","value":"2100-01-14T17:59:50.463Z"},{"type":"min","value":"2000-01-14T17:59:50.463Z"}],"is_locked":false,"created_at":"2023-10-17T17:59:50.647Z","modified_at":"2023-10-17T17:59:50.647Z","__v":0},{"_id":"652ecb965ec66ef03da26f72","name":"Attribute Def 1","slug":"attribute1","description":"attribute1","application_id":"000000000000000000000001","type":"string","multi_value":false,"customer_editable":false,"encrypted":false,"pinned":false,"validations":[{"type":"regex","value":"^[a-zA-Z]+$"},{"type":"max","value":10},{"type":"min","value":1}],"is_locked":false,"created_at":"2023-10-17T17:59:50.646Z","modified_at":"2023-10-17T17:59:50.646Z","__v":0},{"_id":"652ecb965ec66ef03da26f73","name":"Attribute Def 2","slug":"attribute2","description":"attribute2","application_id":"000000000000000000000001","type":"string","multi_value":false,"customer_editable":false,"encrypted":false,"pinned":false,"validations":[{"type":"regex","value":"^[a-zA-Z]+$"}],"is_locked":false,"created_at":"2023-10-17T17:59:50.646Z","modified_at":"2023-10-17T17:59:50.646Z","__v":0},{"_id":"652ecb965ec66ef03da26f74","name":"Attribute Def 3","slug":"attribute3","description":"attribute3","application_id":"000000000000000000000001","type":"number","multi_value":false,"customer_editable":false,"encrypted":false,"pinned":false,"validations":[{"type":"max","value":10},{"type":"min","value":1}],"is_locked":false,"created_at":"2023-10-17T17:59:50.646Z","modified_at":"2023-10-17T17:59:50.646Z","__v":0},{"_id":"652ecb965ec66ef03da26f75","default_value":[],"name":"Attribute Def 4","slug":"attribute4","description":"attribute4","application_id":"000000000000000000000001","type":"number_array","multi_value":false,"customer_editable":false,"encrypted":false,"pinned":false,"validations":[{"type":"max","value":10},{"type":"min","value":1}],"is_locked":false,"created_at":"2023-10-17T17:59:50.646Z","modified_at":"2023-10-17T17:59:50.646Z","__v":0},{"_id":"652ecb965ec66ef03da26f76","name":"Attribute Def 5","slug":"attribute5","description":"attribute5","application_id":"000000000000000000000001","type":"boolean","multi_value":false,"customer_editable":false,"encrypted":false,"pinned":false,"is_locked":false,"validations":[],"created_at":"2023-10-17T17:59:50.645Z","modified_at":"2023-10-17T17:59:50.645Z","__v":0}]},"page":{"type":"object","properties":{"type":{"type":"string","example":"number"},"current":{"type":"integer","example":1},"size":{"type":"integer","example":10},"item_total":{"type":"integer","example":6},"has_next":{"type":"boolean","example":false}}}}}}}},"4XX":{"$ref":"#/components/responses/AuthenticationApiError"},"5XX":{"$ref":"#/components/responses/AuthenticationApiError"}},"tags":["User"]}},"/service/platform/user/v1.0/company/{company_id}/application/{application_id}/user_attribute/definition/{attribute_def_id}":{"put":{"summary":"updateUserAttributeDefinition | Update User Attribute Definition","description":"Update an existing user attribute definition.","parameters":[{"in":"path","name":"attribute_def_id","required":true,"schema":{"type":"string"},"description":"The unique identifier of the attribute definition to update."},{"in":"path","name":"application_id","schema":{"type":"string"},"required":true,"description":"Application ID."},{"in":"path","name":"company_id","schema":{"type":"string"},"required":true,"description":"Company ID."}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUserAttributeDefinition"},"example":{"name":"Attribute 1","description":"description","type":"string","slug":"attribute-1","default_value":"abcd","customer_editable":false,"encrypted":false,"pinned":true,"pin_order":1,"validations":[{"type":"min","value":8},{"type":"max","value":16}]}}}},"responses":{"200":{"description":"Successful update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserAttributeDefinition"}}}},"4XX":{"$ref":"#/components/responses/AuthenticationApiError"},"5XX":{"$ref":"#/components/responses/AuthenticationApiError"}},"tags":["User"]},"delete":{"summary":"deleteUserAttributeDefinitionById | Delete User Attribute Definition","description":"Delete a user attribute definition by its unique identifier.","parameters":[{"in":"path","name":"attribute_def_id","required":true,"schema":{"type":"string"},"description":"The unique identifier of the attribute definition to delete."},{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform.","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Alphanumeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Deletion","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessMessageResponse"}}}},"4XX":{"$ref":"#/components/responses/AuthenticationApiError"},"5XX":{"$ref":"#/components/responses/AuthenticationApiError"}},"tags":["User"]},"get":{"summary":"getUserAttributeDefinitionById | Get User Attribute Definition","description":"Get a user attribute definition by its unique identifier.","parameters":[{"in":"path","name":"attribute_def_id","required":true,"schema":{"type":"string"},"description":"The unique identifier of the attribute definition to retrieve."},{"name":"company_id","in":"path","description":"Numeric ID allotted to a business account on Fynd Platform.","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"path","description":"Alphanumeric ID allotted to an application created within a business account.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Retrieval","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserAttributeDefinition"}}}}},"tags":["User"]}},"/service/platform/user/v1.0/company/{company_id}/application/{application_id}/user_attribute/definition/{attribute_def_id}/user/{user_id}":{"put":{"summary":"updateUserAttribute | Update Or Create User Attribute","description":"Update Or Create User Attribute","parameters":[{"in":"path","name":"attribute_def_id","required":true,"schema":{"type":"string"},"description":"The unique identifier of the attribute definition to update."},{"in":"path","name":"user_id","required":true,"schema":{"type":"string"},"description":"The unique identifier of the user to update."},{"in":"path","name":"application_id","schema":{"type":"string"},"required":true,"description":"Application ID."},{"in":"path","name":"company_id","schema":{"type":"string"},"required":true,"description":"Company ID."}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUserAttributeRequest"},"example":{"customer_overriden":true,"attribute":{"key":"abc","value":"abc"}}}}},"responses":{"200":{"description":"Successful update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserAttributeResponse"}}}},"4XX":{"$ref":"#/components/responses/AuthenticationApiError"},"5XX":{"$ref":"#/components/responses/AuthenticationApiError"}},"tags":["User"]},"get":{"summary":"getUserAttribute | get User Attribute","description":"get User Attribute","parameters":[{"in":"path","name":"attribute_def_id","required":true,"schema":{"type":"string"},"description":"The unique identifier of the attribute definition."},{"in":"path","name":"user_id","required":true,"schema":{"type":"string"},"description":"The unique identifier of the user."},{"in":"path","name":"application_id","schema":{"type":"string"},"required":true,"description":"Application ID."},{"in":"path","name":"company_id","schema":{"type":"string"},"required":true,"description":"Company ID."}],"responses":{"200":{"description":"Successful update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserAttributeResponse"}}}},"4XX":{"$ref":"#/components/responses/AuthenticationApiError"},"5XX":{"$ref":"#/components/responses/AuthenticationApiError"}},"tags":["User"]},"delete":{"summary":"deleteUserAttribute | delete User Attribute","description":"delete User Attribute","parameters":[{"in":"path","name":"attribute_def_id","required":true,"schema":{"type":"string"},"description":"The unique identifier of the attribute definition."},{"in":"path","name":"user_id","required":true,"schema":{"type":"string"},"description":"The unique identifier of the user."},{"in":"path","name":"application_id","schema":{"type":"string"},"required":true,"description":"Application ID."},{"in":"path","name":"company_id","schema":{"type":"string"},"required":true,"description":"Company ID."}],"responses":{"200":{"description":"Successful update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessMessageResponse"}}}},"4XX":{"$ref":"#/components/responses/AuthenticationApiError"},"5XX":{"$ref":"#/components/responses/AuthenticationApiError"}},"tags":["User"]}},"/service/platform/user/v1.0/company/{company_id}/application/{application_id}/user_attribute/user/{user_id}":{"get":{"summary":"getUserAttributesForUser | Get User Attributes for user","description":"Get all user attributes for user","parameters":[{"in":"path","name":"user_id","required":true,"schema":{"type":"string"},"description":"The unique identifier of the user to update."},{"in":"path","name":"application_id","schema":{"type":"string"},"required":true,"description":"Application ID."},{"in":"path","name":"company_id","schema":{"type":"string"},"required":true,"description":"Company ID."},{"name":"page_size","in":"query","description":"The number of items to retrieve in each page. Default value is 10.","required":false,"schema":{"type":"integer","default":10}},{"name":"page_no","in":"query","description":"The page number to navigate through the given set of results. Default value is 1. ","required":false,"schema":{"type":"integer","default":1}}],"responses":{"200":{"description":"Successful update","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/UserAttributeResponse"}},"page":{"type":"object","properties":{"type":{"type":"string","example":"number"},"current":{"type":"integer","example":1},"size":{"type":"integer","example":10},"item_total":{"type":"integer","example":6},"has_next":{"type":"boolean","example":false}}}}}}}},"4XX":{"$ref":"#/components/responses/AuthenticationApiError"},"5XX":{"$ref":"#/components/responses/AuthenticationApiError"}},"tags":["User"]}},"/service/platform/user/v1.0/company/{company_id}/application/{application_id}/user_attribute/attribute/{attribute_id}":{"get":{"summary":"getUserAttributeById | Get User Attribute","description":"Get User Attribute details by id","parameters":[{"in":"path","name":"attribute_id","required":true,"schema":{"type":"string"},"description":"The unique identifier of the attribute to get."},{"in":"path","name":"application_id","schema":{"type":"string"},"required":true,"description":"Application ID."},{"in":"path","name":"company_id","schema":{"type":"string"},"required":true,"description":"Company ID."}],"responses":{"200":{"description":"Successful update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserAttributeResponse"}}}},"4XX":{"$ref":"#/components/responses/AuthenticationApiError"},"5XX":{"$ref":"#/components/responses/AuthenticationApiError"}},"tags":["User"]}},"/service/platform/webhook/v1.0/company/{company_id}/retry":{"post":{"summary":"manualRetryOfFailedEvent | Initiate a manual retry for event processing.","description":"Initiates a manual retry for event processing for a specific company. This endpoint allows the user to specify the date range (start_date and end_date) within which the events should be retried.\n","x-accessScopes":["company/webhook/retry"],"tags":["Webhook"],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer"},"examples":{"success":{"value":1}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetryEventRequest"},"examples":{"success":{"value":{"end_date":"2023-10-06T07:19:44","start_date":"2023-10-05T07:19:44","event":[],"status":"FAILED"}}}}}},"responses":{"200":{"description":"Initiates a manual retry for event processing for a specific company. This endpoint allows the user to specify the date range (start_date and end_date) within which the events should be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrySuccessResponse"},"examples":{"success":{"value":{"message":"Manual Retry Processed Started Successfully"}}}}}}}}},"/service/platform/webhook/v1.0/company/{company_id}/retry/events/counts":{"post":{"summary":"getEventCounts | Get the count of failed events for a company within a specified date range.","description":"Retrieves the count of failed events for a specific company within the specified date range. The user can filter the count based on specific event types if provided.\n","x-accessScopes":["company/webhook/retry/count"],"tags":["Webhook"],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer"},"examples":{"success":{"value":1}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetryEventRequest"},"examples":{"success":{"value":{"end_date":"2023-10-06T07:19:44","start_date":"2023-10-05T07:19:44","event":[],"status":"FAILED"}}}}}},"responses":{"200":{"description":"Initiates a manual retry for event processing for a specific company. This endpoint allows the user to specify the date range (start_date and end_date) within which the events should be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetryCountResponse"},"examples":{"success":{"value":{"items":[{"status":"FAILED","count":10}]}}}}}}}}},"/service/platform/webhook/v1.0/company/{company_id}/retry/status":{"get":{"summary":"getManualRetryStatus | Get the retry status for a company's failed events.","description":"Retrieves the status of retry for a specific company's failed events. This endpoint returns the total number of events, the count of successfully retried events, the count of failed retry attempts, and the overall status of the retry process.\n","x-accessScopes":["company/webhook/retry/status"],"tags":["Webhook"],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer"},"examples":{"success":{"value":1}}}],"responses":{"200":{"description":"Successful response with the retry status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetryStatusResponse"},"examples":{"success":{"value":{"total_event":100,"success_count":60,"failure_count":40,"status":"in_progress"}}}}}}}}},"/service/platform/webhook/v1.0/company/{company_id}/retry/cancel":{"delete":{"summary":"manualRetryCancel | Cancel the active manual retry for a company's failed events.","description":"Cancels the active manual retry for a specific company's failed events. If a manual retry is currently in progress, it will be cancelled.\n","x-accessScopes":["company/webhook/retry/cancel"],"tags":["Webhook"],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer"},"examples":{"success":{"value":1}}}],"responses":{"200":{"description":"Manual retry cancelled successfully.","content":{"application/json":{"schema":{"type":"string","description":"The success message indicating the manual retry has been cancelled."},"examples":{"success":{"value":"Events cancelled successfully"}}}}}}}},"/service/platform/webhook/v1.0/company/{company_id}/reports/download":{"post":{"summary":"downloadDeliveryReport | Download processed events report for a company.","description":"Download reports for a specific company based on the provided filters.\n","x-accessScopes":["company/webhook/report"],"tags":["Webhook"],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer"},"examples":{"success":{"value":1}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventProcessRequest"},"examples":{"success":{"value":{"search_text":"silverbolt.9f309c0e-31cd-11ee-a480-da7d738d3c68","end_date":"2023-08-03T08:14:14","start_date":"2023-08-02T08:14:14","subscriber_ids":[48],"status":"FAILED","event":[{"event_name":"product-size","event_type":"update","event_category":"company","version":"2"}]}}}}}},"responses":{"200":{"description":"Successfully downloaded the report.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DownloadReportResponse"},"examples":{"success":{"value":{"file_name":"exportJMehD_1689675047609"}}}}}}}}},"/service/platform/webhook/v1.0/company/{company_id}/subscriber/ping":{"post":{"summary":"pingWebhook | Ping and validate webhook url.","description":"Ping and validate webhook url.\n","x-accessScopes":["company/webhook/subscriber"],"tags":["Webhook"],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer"},"examples":{"success":{"value":1}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PingWebhook"},"examples":{"success":{"value":{"webhook_url":"https://webhook.site/9eeedf84-bb87-42cd-af30-a7a388b188cf","auth_meta":{},"custom_headers":{}}}}}}},"responses":{"200":{"description":"Successfully received ping for the provided webhook url.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PingWebhookResponse"},"examples":{"success":{"value":{"status":"FAILED","message":"Request failed with status code 429","code":200}}}}}}}}},"/service/platform/webhook/v1.0/company/{company_id}/filters":{"post":{"summary":"getReportFilters | Get filters for a company.","description":"Retrieve filters for a specific company based on the provided subscriber IDs.\n","x-accessScopes":["company/webhook/report"],"tags":["Webhook"],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer"},"examples":{"success":{"value":1}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportFiltersPayload"},"examples":{"success":{"value":{"subscriber_ids":[2]}}}}}},"responses":{"200":{"description":"Successfully retrieved the filters.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ReportFilterResponse"}},"examples":{"success":{"value":[{"filter_name":"Event","values":[{"text":"article.create-v1 (company)","value":{"event_name":"article","event_type":"create","event_category":"company","version":"1"}}]}]}}}}}}}},"/service/platform/webhook/v1.0/company/{company_id}/reports/history":{"post":{"summary":"getHistoricalReports | Get report download history.","description":"Retrieve history reports for a specific company based on the provided filters.\n","x-accessScopes":["company/webhook/report"],"tags":["Webhook"],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer"},"examples":{"success":{"value":1}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HistoryPayload"},"examples":{"success":{"value":{"type":"platform","page_no":1,"page_size":10}}}}}},"responses":{"200":{"description":"It will give list of all the reports that was downloaded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HistoryResponse"},"examples":{"success":{"value":[{"id":25,"association":{"company_id":24},"filters":{"status":"FAILED","end_date":"2023-07-18T09:38:07.000Z","start_date":"2023-07-17T09:38:07.000Z","subscribers":[40]},"filename":"exportJMehD_1689675047609","status":"COMPLETED","upload_service_response":{"cdn":{"urls":[{"url":"https://storage.googleapis.com/fynd-data-platform-fynd-x0/fp-analytics-query-result/exportJMehD_1689675047609/000000000000.csv.gz?GoogleAccessId=dms-to-bq%40fynd-1088.iam.gserviceaccount.com&Expires=1692267060&Signature=aPhTRMOJswVhx5jTYF7JV42aPQKJ4Mkzv9vJr8zqrbpso00GytuhmBnpP1Gxt%2BoTnIINyWUWAuchlm6paS9yKFrjCXemsqSM0hqTA8T0MUjng3swZAtZuWK4dVK2jMyOv88l1Xn8tkrwOFo7ohG3scFwgjplrU%2FkMUNZqxw4fdgdUUXZ%2BJrnGC5jlGkz5PTooRtForUXtTkA8Kf9mJvX3F6f6p5I2VvhzmXHGMabavEjgZ56JUe2%2B0o5POs4jN0s%2F6fZGOz4hhLa9hMIyQpjoodbcGO%2BRCKukxRbY1s00%2F1WNGLLYYuU4bvqtME60rCnj0FHEmbte4Tr73SmOU4xwg%3D%3D","name":"000000000000.csv.gz"}]}},"created_on":"2023-07-18T10:10:49.189Z","updated_on":"2023-07-18T10:10:50.798Z","message":"Completed in less than 1 min"}]}}}}}}}},"/service/platform/webhook/v1.0/company/{company_id}/reports/cancel/file/{filename}":{"get":{"summary":"cancelJobByName | Cancel a report export.","description":"Cancel the export of a specific report for a company.\n","x-accessScopes":["company/webhook/report"],"tags":["Webhook"],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer"},"examples":{"success":{"value":1}}},{"name":"filename","in":"path","required":true,"schema":{"type":"string","description":"This is filename that will be used for export operation"},"examples":{"success":{"value":"test_file"}}}],"responses":{"200":{"description":"Report export canceled successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelResponse"},"examples":{"success":{"value":{"code":200}}}}}}}}},"/service/platform/webhook/v1.0/company/{company_id}/reports/event_processed":{"post":{"summary":"getDeliveryReports | Get processed events report for a company.","description":"Retrieve a list of processed events for a specific company based on the provided filters.\n","x-accessScopes":["company/webhook/report"],"tags":["Webhook"],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer"},"examples":{"success":{"value":1}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventProcessRequest"},"examples":{"success":{"value":{"search_text":"silverbolt.9f309c0e-31cd-11ee-a480-da7d738d3c68","end_date":"2023-08-03T08:14:14","start_date":"2023-08-02T08:14:14","subscriber_ids":[48],"status":"FAILED","event":[{"event_name":"product-size","event_type":"update","event_category":"company","version":"2"}]}}}}}},"responses":{"200":{"description":"Successfully retrieved the processed events report.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventProcessReports"},"examples":{"success":{"value":{"rows":[{"event_name":"article.create.v1.application","response_code":404,"response_message":"Not Found","data":"{}","attempt":3,"last_attempted_on":1696835661617,"status":"FAILED","name":"sub23","webhook_url":"https://webhook.site/512b843c-4a3b-4263-9acf-6fc9ad50c042","response_time":"20000,","message_id":"tYYGTlhqxW7byvmDEIqTXOMmGoF8O5zAZ87IT3TV8DA=","event_trace_id":"[\"wildrider.c6a8c2b0-659f-11ee-b7f8-ba52e867b4c8\"]"}]}}}}}}}}},"/service/platform/webhook/v1.0/company/{company_id}/events":{"get":{"summary":"fetchAllEventConfigurations | Get All Webhook Events.","description":"To fetch all webhook events.\n","x-accessScopes":["company/webhook/events"],"tags":["Webhook"],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer"},"examples":{"success":{"value":1}}}],"responses":{"200":{"description":"Successfully received ping for the provided webhook url.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventConfigResponse"},"examples":{"success":{"value":{"event_configs":[{"id":1,"event_name":"article","event_type":"create","event_category":"application","version":"1","display_name":"article","description":"This event gets triggered when an article is created","event_schema":null,"created_on":"2021-12-20T17:38:22.922Z","updated_on":"2023-07-26T12:30:30.930Z"}]}}}}}}}}},"/service/platform/webhook/v1.0/company/{company_id}/subscriber/":{"post":{"summary":"registerSubscriberToEvent | Register Subscriber.","description":"Register Subscriber.\n","x-accessScopes":["company/webhook/subscriber"],"tags":["Webhook"],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer"},"examples":{"success":{"value":1}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriberConfig"},"examples":{"success":{"value":{"name":"xyz webhook","webhook_url":"https://xyz.requestcatcher.com/test","association":{"company_id":1,"application_id":["63a0490757475baff6154585","63a42b512df5d4731c5eb601"]},"custom_headers":{},"status":"active","email_id":"axyz@gofynd.com","auth_meta":{},"event_id":[10,11,17]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriberConfigResponse"},"examples":{"success":{"value":{"name":"xyz webhook","webhook_url":"https://xyz.requestcatcher.com/test","association":{"company_id":1,"extension_id":"64affd97cbddb85348ca8f93","application_id":["63a0490757475baff6154585","63a42b512df5d4731c5eb601"]},"custom_headers":{},"status":"active","email_id":"axyz@gofynd.com","auth_meta":{},"event_id":[10,11,17]}}}}}}}},"get":{"summary":"getSubscribersByCompany | Get Subscribers By CompanyId.","description":"Get Subscribers By Company ID.\n","x-accessScopes":["company/webhook/subscriber"],"tags":["Webhook"],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer"},"examples":{"success":{"value":1}}},{"name":"page_no","in":"query","description":"Page Number","required":false,"schema":{"type":"integer"},"examples":{"success":{"value":1}}},{"name":"page_size","in":"query","description":"Page Size","required":false,"schema":{"type":"integer","format":"int32"},"examples":{"success":{"value":10}}},{"name":"extension_id","in":"query","description":"extension_id","required":false,"schema":{"type":"string"},"examples":{"success":{"value":"64affd97cbddb85348ca8f93"}}}],"responses":{"200":{"description":"Subscribers By Company ID.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriberConfigList"},"examples":{"success":{"value":{"items":[{"id":1,"name":"sub23","webhook_url":"https://webhook.site/512b843c-4a3b-4263-9acf-6fc9ad50c042","association":{"company_id":1,"application_id":["64aed377b1fd04565d0dff30","64c00b72c07acacc1357503b","64c0ff70eb99eb4a878a7f81","64c117dbeb99eb4a878a9621","000000000000000000000001","000000000000000000000004"],"criteria":"SPECIFIC-EVENTS"},"status":"inactive","custom_headers":{},"auth_meta":{"type":"hmac","secret":"test1234"},"email_id":"nikhil@gmail112.com","type":null,"created_on":"2023-07-26T12:30:30.235Z","updated_on":"2023-07-31T14:45:50.860Z","modified_by":"Shailendrapal Shekhawat","event_configs":[{"id":1,"event_name":"article","event_type":"create","event_category":"application","version":"1","display_name":"article","description":"This event gets triggered when an article is created","event_schema":{},"created_on":"2021-12-20T17:38:22.922Z","updated_on":"2023-07-26T12:30:30.930Z","subscriber_event_mapping":{"id":765,"event_id":1,"subscriber_id":1,"created_on":"2023-07-26T12:30:30.305Z"}}]}],"page":{"current":1,"has_next":false,"has_previous":false,"item_total":1,"size":10,"type":"number"}}}}}}}}},"put":{"description":"Update Subscriber","summary":"updateSubscriberConfig | Update Subscriber","x-accessScopes":["company/webhook/subscriber"],"tags":["Webhook"],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer"},"examples":{"success":{"value":1}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriberConfig"},"examples":{"success":{"value":{"id":1,"name":"xyz webhook","webhook_url":"https://xyz.requestcatcher.com/test","association":{"company_id":1,"extension_id":"64affd97cbddb85348ca8f93","application_id":["63a0490757475baff6154585","63a42b512df5d4731c5eb601"]},"custom_headers":{},"status":"active","email_id":"axyz@gofynd.com","auth_meta":{},"event_id":[10,11,17]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriberConfigResponse"},"examples":{"success":{"value":{"id":35,"name":"xyz webhook","webhook_url":"https://xyz.requestcatcher.com/test","association":{"company_id":2,"application_id":["63a0490757475baff6154585","63a42b512df5d4731c5eb601"]},"custom_headers":{},"status":"active","email_id":"axyz@gofynd.com","auth_meta":{},"event_id":[10,11,17]}}}}}}}}},"/service/platform/webhook/v1.0/company/{company_id}/subscriber/{subscriber_id}":{"get":{"description":"Get Subscriber By Subscriber ID","summary":"getSubscriberById | Get Subscriber By Subscriber ID","x-accessScopes":["company/webhook/subscriber"],"tags":["Webhook"],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer"},"examples":{"success":{"value":1}}},{"name":"subscriber_id","in":"path","description":"subscriber id","required":true,"schema":{"type":"integer"},"examples":{"success":{"value":1}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriberResponse"},"examples":{"success":{"value":{"id":1,"name":"praveen's webhook","webhook_url":"https://webhook.site/67493d35-6468-4c0a-8226-9a50954eb4c3","association":{"company_id":1,"application_id":[],"criteria":"EMPTY"},"status":"active","custom_headers":{},"auth_meta":{},"email_id":"abc@gofynd.com","type":null,"created_on":"2023-06-07T06:57:24.567Z","updated_on":"2023-06-07T06:57:24.567Z","modified_by":"praveen","event_configs":[{"id":10,"event_name":"article","event_type":"create","event_category":"company","version":"1","display_name":"article","description":"This event gets triggered when article is created","type":null,"event_schema":{},"created_on":"2021-07-05T11:16:18.175Z","updated_on":"2023-01-02T05:04:24.492Z","modified_by":"praveen","subscriber_event_mapping":{"id":77,"event_id":10,"subscriber_id":35,"created_on":"2023-06-07T06:57:24.592Z"}}]}}}}}}}}},"/service/platform/webhook/v1.0/company/{company_id}/extension/{extension_id}/subscriber/":{"get":{"description":"Get Subscribers By ExtensionID","summary":"getSubscribersByExtensionId | Get Subscribers By Extension ID","x-accessScopes":["company/webhook/subscriber"],"tags":["Webhook"],"parameters":[{"name":"page_no","in":"query","description":"Page Number","required":false,"schema":{"type":"integer"},"examples":{"success":{"value":1}}},{"name":"page_size","in":"query","description":"Page Size","required":false,"schema":{"type":"integer","format":"int32"},"examples":{"success":{"value":10}}},{"name":"company_id","in":"path","required":true,"schema":{"type":"integer"},"examples":{"success":{"value":1}}},{"name":"extension_id","in":"path","description":"extension_id","required":true,"schema":{"type":"string"},"examples":{"success":{"value":"64affd97cbddb85348ca8f93"}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriberConfigList"},"examples":{"success":{"value":{"items":[{"id":3,"name":"64b3dc661a1b16dea7fadc22","webhook_url":"https://reviews.extensions.fyndx1.de/ext/reviews-webhook","association":{"company_id":47,"extension_id":"64b3dc661a1b16dea7fadc22","application_id":[],"criteria":"ALL"},"status":"active","custom_headers":{},"auth_meta":{"type":"hmac","secret":"9gX_S6e28DY1mRP"},"email_id":"devas@gofynd.com","type":null,"created_on":"2023-07-26T12:30:41.525Z","updated_on":"2023-08-01T07:21:33.982Z","modified_by":"Sneha Mohite","event_configs":[{"id":84,"event_name":"shipment","event_type":"update","event_category":"application","version":"1","display_name":"shipment","description":"This event gets triggered when shipment is update","event_schema":{},"created_on":"2021-07-02T13:25:34.804Z","updated_on":"2021-07-02T13:25:34.804Z","subscriber_event_mapping":{"id":779,"event_id":84,"subscriber_id":3,"created_on":"2023-07-26T12:30:41.532Z"}}]}],"page":{"current":1,"has_next":false,"has_previous":false,"item_total":1,"size":10,"type":"number"}}}}}}}}}}},"components":{"schemas":{"RequestBodyAuditLog":{"required":["log_meta","log_payload"],"type":"object","properties":{"log_meta":{"$ref":"#/components/schemas/LogMetaObj"},"log_payload":{"type":"object"}}},"CreateLogResponse":{"properties":{"message":{"type":"string"},"internal_message":{"type":"string"}}},"LogMetaObj":{"type":"object","properties":{"modifier":{"type":"object"},"application":{"type":"string"},"entity":{"$ref":"#/components/schemas/EntityObject"},"device_info":{"type":"object"},"location":{"type":"object"}}},"EntityObject":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"action":{"type":"string"}}},"LogSchemaResponse":{"type":"object","properties":{"docs":{"type":"array","items":{"$ref":"#/components/schemas/LogDocs"}}}},"LogDocs":{"type":"object","properties":{"entity":{"$ref":"#/components/schemas/EntityObj"},"modifier":{"$ref":"#/components/schemas/Modifier"},"device_info":{"$ref":"#/components/schemas/DeviceInfo"},"location":{"$ref":"#/components/schemas/Location"},"_id":{"type":"string"},"company":{"type":"string"},"application":{"type":"string"},"sessions":{"type":"string"},"date":{"type":"string"},"logs":{"type":"object","default":{}}}},"EntityObj":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"action":{"type":"string"},"entity_details":{"type":"object"}}},"Modifier":{"type":"object","properties":{"user_id":{"type":"string"},"as_administrator":{"type":"boolean"},"user_details":{"type":"object","default":{}}}},"DeviceInfo":{"type":"object","properties":{"user_agent":{"type":"string"},"extra_meta":{"type":"object"}}},"Location":{"type":"object","properties":{"extra_meta":{"type":"object","default":{}}}},"BadRequest":{"type":"object","properties":{"message":{"description":"Failure message (in a string format)","type":"string"}}},"InternalServerError":{"type":"object","properties":{"message":{"description":"Internal server Server error","type":"string"},"code":{"description":"Error code","type":"string"}}},"EntityTypesResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/EntityTypeObj"}}}},"EntityTypeObj":{"type":"object","properties":{"entity_value":{"type":"string"},"display_name":{"type":"string"}}},"ResourceNotFound":{"type":"object","properties":{"message":{"description":"Resource not found with {id}","type":"string"}}},"CheckValidityResponse":{"type":"object","properties":{"is_valid":{"type":"boolean","example":true},"discount_amount":{"type":"number","example":250}}},"PlanRecurring":{"type":"object","properties":{"interval":{"type":"string","example":"month"},"interval_count":{"type":"number","example":3}}},"Plan":{"type":"object","properties":{"recurring":{"$ref":"#/components/schemas/PlanRecurring"},"is_trial_plan":{"type":"boolean","example":true},"plan_group":{"type":"string","example":"default"},"tag_lines":{"type":"array","items":{"type":"string","example":"This is 2020won trial plan"}},"currency":{"type":"string","example":"INR"},"is_active":{"type":"boolean","example":true},"is_visible":{"type":"boolean","example":false},"trial_period":{"type":"number","example":30},"addons":{"type":"array","items":{"type":"string"}},"tags":{"type":"array","items":{"type":"string"}},"type":{"type":"string","example":"public"},"country":{"type":"string","example":"IN"},"_id":{"type":"string","example":"5f0dcd866173cb003706098f"},"name":{"type":"string","example":"30 day Trial"},"description":{"type":"string","example":"30 day Trial"},"amount":{"type":"number","example":0},"product_suite_id":{"type":"string","example":"5f0dcd866173cb0037060975"},"created_at":{"type":"string","example":"2020-07-14T15:21:42.959Z"},"modified_at":{"type":"string","example":"2020-07-14T15:21:42.959Z"}}},"SubscriptionTrialPeriod":{"type":"object","properties":{"start_date":{"type":"string"},"end_date":{"type":"string"}}},"EntityChargePrice":{"type":"object","properties":{"amount":{"type":"number","minimum":1,"description":"Amount for price. Minimum value 1"},"currency_code":{"type":"string"}},"required":["amount","currency_code"]},"EntityChargeRecurring":{"type":"object","properties":{"interval":{"type":"string","enum":["month","year"]}},"required":["interval"]},"ChargeLineItem":{"type":"object","properties":{"name":{"type":"string"},"term":{"type":"string"},"pricing_type":{"type":"string","enum":["one_time","recurring","usage_base"]},"price":{"$ref":"#/components/schemas/EntityChargePrice"},"recurring":{"$ref":"#/components/schemas/EntityChargeRecurring"},"capped_amount":{"type":"number"},"trial_days":{"type":"integer","format":"int32"},"is_test":{"type":"boolean"},"metadata":{"type":"object"}},"required":["name","term","pricing_type","price"]},"CreateSubscriptionCharge":{"type":"object","properties":{"name":{"type":"string"},"trial_days":{"type":"integer","format":"int32"},"line_items":{"type":"array","items":{"$ref":"#/components/schemas/ChargeLineItem"}},"is_test":{"type":"boolean"},"return_url":{"type":"string"}},"required":["name","line_items","return_url"]},"OneTimeChargeItem":{"type":"object","properties":{"name":{"type":"string"},"term":{"type":"string"},"pricing_type":{"type":"string","enum":["one_time"]},"price":{"$ref":"#/components/schemas/EntityChargePrice"},"capped_amount":{"type":"number"},"is_test":{"type":"boolean"},"metadata":{"type":"object"}},"required":["name","pricing_type","price"]},"CreateOneTimeCharge":{"type":"object","properties":{"name":{"type":"string"},"charge":{"$ref":"#/components/schemas/OneTimeChargeItem"},"is_test":{"type":"boolean"},"return_url":{"type":"string"}},"required":["name","charge","return_url"]},"CurrentPeriod":{"type":"object","properties":{"start_date":{"type":"string"},"end_date":{"type":"string"}}},"SubscriptionCharge":{"type":"object","properties":{"_id":{"type":"string"},"name":{"type":"string"},"term":{"type":"string","description":"Brief description for a charge"},"pricing_type":{"type":"string","enum":["one_time","recurring","usage_base"]},"price":{"$ref":"#/components/schemas/EntityChargePrice"},"recurring":{"$ref":"#/components/schemas/EntityChargeRecurring"},"capped_amount":{"type":"number"},"activated_on":{"type":"string"},"cancelled_on":{"type":"string"},"billing_date":{"type":"string"},"current_period":{"$ref":"#/components/schemas/CurrentPeriod"},"status":{"type":"string","enum":["pending","active","cancelled","frozen","declined"]},"is_test":{"type":"boolean"},"metadata":{"type":"object"}}},"EntitySubscription":{"type":"object","properties":{"_id":{"type":"string"},"name":{"type":"string"},"status":{"type":"string","enum":["pending","active","cancelled","frozen","declined"]},"company_id":{"type":"integer","format":"int32"},"activated_on":{"type":"string"},"cancelled_on":{"type":"string"},"trial_days":{"type":"integer","format":"int32"},"trial_period":{"$ref":"#/components/schemas/SubscriptionTrialPeriod"},"metadata":{"type":"object"},"line_items":{"type":"array","items":{"$ref":"#/components/schemas/SubscriptionCharge"}}}},"OneTimeChargeEntity":{"type":"object","properties":{"_id":{"type":"string"},"name":{"type":"string"},"status":{"type":"string","enum":["pending","active","cancelled","frozen","declined","success","failed"]},"activated_on":{"type":"string"},"cancelled_on":{"type":"string"},"metadata":{"type":"object"},"return_url":{"type":"string"},"is_test":{"type":"boolean"},"pricing_type":{"type":"string"},"subscriber_id":{"type":"string"},"entity_type":{"type":"string"},"entity_id":{"type":"string"},"meta":{"type":"object"},"price":{"$ref":"#/components/schemas/EntityChargePrice"}}},"CreateOneTimeChargeResponse":{"type":"object","properties":{"charge":{"$ref":"#/components/schemas/OneTimeChargeEntity"},"confirm_url":{"type":"string"}}},"CreateSubscriptionResponse":{"type":"object","properties":{"subscription":{"$ref":"#/components/schemas/EntitySubscription"},"confirm_url":{"type":"string"}}},"InvoiceDetailsPeriod":{"type":"object","properties":{"start":{"type":"string","example":"2020-08-17T13:45:36.722Z"},"end":{"type":"string","example":"2020-09-17T13:45:36.722Z"}}},"InvoiceDetailsClient":{"type":"object","properties":{"address_lines":{"type":"array","items":{"type":"string","example":"TV TOWER Foot Over Bridge Khar"}},"name":{"type":"string","example":"RELIANCE RETAIL LTD"},"email":{"type":"string","example":"ZAK@GMAIL.COM"},"phone":{"type":"string","example":"91 9869821300"}}},"InvoiceDetailsStatusTrail":{"type":"object","properties":{"_id":{"type":"string","example":"5f7ad29bd562744eab216379"},"value":{"type":"string","example":"draft"},"timestamp":{"type":"string","example":"2020-10-05T08:00:27.753Z"}}},"InvoicePaymentMethod":{"type":"object","properties":{"pg_payment_method_id":{"type":"string","format":"nullable"}}},"InvoiceDetails":{"type":"object","nullable":true,"properties":{"updated_date":{"type":"string","nullable":true},"store_invoice_id":{"type":"string","nullable":true},"invoice_url":{"type":"string","nullable":true},"label_url":{"type":"string","nullable":true}}},"InvoiceItemsPlanRecurring":{"type":"object","properties":{"interval":{"type":"string","example":"month"},"interval_count":{"type":"integer","format":"int32","example":1}}},"InvoiceItemsPlan":{"type":"object","properties":{"recurring":{"$ref":"#/components/schemas/InvoiceItemsPlanRecurring"},"is_trial_plan":{"type":"boolean"},"plan_group":{"type":"string","example":"default"},"tag_lines":{"type":"array","items":{"type":"string","example":""}},"currency":{"type":"string","example":"INR"},"is_active":{"type":"boolean"},"is_visible":{"type":"boolean"},"trial_period":{"type":"integer","format":"int32","example":0},"addons":{"type":"array","items":{"type":"string"}},"tags":{"type":"array","items":{"type":"string"}},"type":{"type":"string","example":"public"},"country":{"type":"string","example":"IN"},"_id":{"type":"string","example":"5f3a8786c90d780037723a14"},"name":{"type":"string","example":"Professional"},"description":{"type":"string","example":"Professional"},"amount":{"type":"integer","format":"int32","example":1499},"product_suite_id":{"type":"string","example":"5f3a8786c90d7800377239f3"},"created_at":{"type":"string","example":"2020-08-17T13:35:02.802Z"},"modified_at":{"type":"string","example":"2020-08-17T13:35:02.802Z"}}},"InvoiceItemsPeriod":{"type":"object","properties":{"start":{"type":"string","example":"2020-08-17T13:45:36.722Z"},"end":{"type":"string","example":"2020-10-05T07:29:52.868Z"}}},"InvoiceItems":{"type":"object","properties":{"_id":{"type":"string","example":"5f7acb709e76da48b1b92cdd"},"currency":{"type":"string","example":"INR"},"plan":{"$ref":"#/components/schemas/InvoiceItemsPlan"},"name":{"type":"string","example":"Professional"},"quantity":{"type":"integer","format":"int32","example":1},"description":{"type":"string","example":"Professional"},"period":{"$ref":"#/components/schemas/InvoiceItemsPeriod"},"unit_amount":{"type":"number","example":2356.77},"amount":{"type":"number","example":2356.77},"type":{"type":"string","example":"subscription"},"invoice_id":{"type":"string","example":"5f7acb709e76da30e3b92cdb"},"created_at":{"type":"string","example":"2020-10-05T07:29:52.886Z"},"modified_at":{"type":"string","example":"2020-10-05T07:29:52.886Z"}}},"Invoice":{"type":"object","properties":{"invoice":{"$ref":"#/components/schemas/InvoiceDetails"},"invoice_items":{"type":"array","items":{"$ref":"#/components/schemas/InvoiceItems"}}}},"InvoicesDataClient":{"type":"object","properties":{"name":{"type":"string","example":"RELIANCE RETAIL LTD"},"email":{"type":"string","example":"ZAK@GMAIL.COM"},"phone":{"type":"string","example":"91 1234567890"},"address_lines":{"type":"array","items":{"type":"string","example":"TV TOWER Foot Over Bridge Khar"}}}},"InvoicesDataPeriod":{"type":"object","properties":{"start":{"type":"string","example":"2020-08-17T13:45:36.722Z"},"end":{"type":"string","example":"2020-09-17T13:45:36.722Z"}}},"InvoicesDataPaymentMethod":{"type":"object","properties":{"pg_payment_method_id":{"type":"string","format":"nullable"}}},"InvoicesData":{"type":"object","properties":{"_id":{"type":"string","example":"5f7acb709e76da30e3b92cdb"},"client":{"$ref":"#/components/schemas/InvoicesDataClient"},"auto_advance":{"type":"boolean"},"currency":{"type":"string","example":"INR"},"paid":{"type":"boolean"},"attemp":{"type":"integer","format":"int32","example":3},"collection_method":{"type":"string","example":"charge_automatically"},"subscriber_id":{"type":"string","example":"5ee773e1351e5e84289ed9cf"},"invoice_url":{"type":"string","example":"null"},"number":{"type":"string","example":"FP-1-72020-736"},"pg_data":{"type":"object","properties":{}},"period":{"$ref":"#/components/schemas/InvoicesDataPeriod"},"receipt_number":{"type":"string","example":"5fd9b08464dc6ac048a08988"},"statement_descriptor":{"type":"string","example":"RELIANCE RETAIL LTD"},"current_status":{"type":"string","example":"paid"},"status_trail":{"type":"array","items":{"$ref":"#/components/schemas/InvoiceDetailsStatusTrail"}},"subtotal":{"type":"number","example":15720.08},"total":{"type":"number","example":15720.08},"subscription":{"type":"string","example":"5f3a8a00668947663b7fbd38"},"next_action_time":{"type":"string","example":"2020-10-05T09:00:27.754Z"},"created_at":{"type":"string","example":"2020-10-05T07:29:52.876Z"},"modified_at":{"type":"string","example":"2020-12-16T07:00:22.980Z"},"hash_identifier":{"type":"string","example":"575999aca03e36f0fa54db5235bc7f25"},"payment_method":{"$ref":"#/components/schemas/InvoicesDataPaymentMethod"},"invoice_items":{"type":"array","items":{"$ref":"#/components/schemas/InvoiceItems"}}}},"Invoices":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/InvoicesData"}},"start":{"type":"integer","format":"int32","example":0},"end":{"type":"integer","format":"int32","example":10},"limit":{"type":"integer","format":"int32","example":10},"page":{"type":"integer","format":"int32","example":1},"total":{"type":"integer","format":"int32","example":1}}},"Phone":{"type":"object","properties":{"phone_number":{"type":"string","example":"1234567890"},"phone_country_code":{"type":"string","example":"91"}}},"SubscriptionBillingAddress":{"type":"object","properties":{"country":{"type":"string","example":"India"},"state":{"type":"string","example":"Maharastra"},"city":{"type":"string","example":"Mumbai"},"line1":{"type":"string","example":"test1"},"line2":{"type":"string","example":"test2"},"postal_code":{"type":"string","example":"400059"}}},"SubscriptionCustomer":{"type":"object","properties":{"phone":{"$ref":"#/components/schemas/Phone"},"billing_address":{"$ref":"#/components/schemas/SubscriptionBillingAddress"},"_id":{"type":"string","example":"5ee773e1351e5e84289ed9cf"},"unique_id":{"type":"string","example":"1"},"type":{"type":"string","example":"company"},"name":{"type":"string","example":"test retail"},"email":{"type":"string","example":"test@gmail.com"},"created_at":{"type":"string","example":"2020-06-15T13:13:05.267Z"},"modified_at":{"type":"string","example":"2021-02-04T00:58:45.356Z"},"data":{"type":"object"}}},"SubscriptionCustomerCreate":{"type":"object","properties":{"phone":{"$ref":"#/components/schemas/Phone"},"billing_address":{"$ref":"#/components/schemas/SubscriptionBillingAddress"},"unique_id":{"type":"string","example":"1"},"type":{"type":"string","example":"company"},"name":{"type":"string","example":"test retail"},"email":{"type":"string","example":"test@gmail.com"}}},"SubscriptionCurrentPeriod":{"type":"object","properties":{"start":{"type":"string","example":"2020-12-17T13:45:36.722Z"},"end":{"type":"string","example":"2021-01-17T13:45:36.722Z"}}},"SubscriptionPauseCollection":{"type":"object","properties":{"behavior":{"type":"string","example":"keep_as_draft"},"resume_at":{"type":"string","example":"2021-01-17T13:45:36.722Z"}}},"SubscriptionTrial":{"type":"object","properties":{"start":{"type":"string","example":"2021-01-01T13:45:36.722Z"},"end":{"type":"string","example":"2021-01-17T13:45:36.722Z"}}},"SubscriptionInvoiceSettings":{"type":"object","properties":{"generation":{"type":"boolean"},"charging":{"type":"boolean"}}},"Subscription":{"type":"object","properties":{"current_period":{"$ref":"#/components/schemas/SubscriptionCurrentPeriod"},"pause_collection":{"$ref":"#/components/schemas/SubscriptionPauseCollection"},"trial":{"$ref":"#/components/schemas/SubscriptionTrial"},"invoice_settings":{"$ref":"#/components/schemas/SubscriptionInvoiceSettings"},"is_active":{"type":"boolean"},"cancel_at_period_end":{"type":"boolean"},"_id":{"type":"string","example":"5f3a8a00668947663b7fbd38"},"subscriber_id":{"type":"string","example":"5ee773e1351e5e84289ed9cf"},"plan_id":{"type":"string","example":"5f3a8786c90d780037723a12"},"product_suite_id":{"type":"string","example":"5f3a8786c90d7800377239f3"},"plan_data":{"$ref":"#/components/schemas/Plan"},"current_status":{"type":"string","example":"active"},"collection_method":{"type":"string","example":"charge_automatically"},"created_at":{"type":"string","example":"2020-08-17T13:45:36.731Z"},"modified_at":{"type":"string","example":"2020-12-17T11:01:15.960Z"},"latest_invoice":{"type":"string","example":"5fdb3a7bfc849c2153b944d5"},"channel_type":{"type":"string","example":"ecomm"}}},"SubscriptionStatus":{"type":"object","properties":{"is_enabled":{"type":"boolean","example":true},"subscription":{"$ref":"#/components/schemas/Subscription"},"latest_invoice":{"$ref":"#/components/schemas/InvoicesData"},"next_plan":{"$ref":"#/components/schemas/Plan"},"current_subscriptions":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/Subscription"}]}},"mandate_amount":{"type":"string","example":"630000"}}},"SubscriptionLimitApplication":{"type":"object","properties":{"enabled":{"type":"boolean"},"hard_limit":{"type":"integer","format":"int32","example":25},"soft_limit":{"type":"integer","format":"int32","example":25}}},"SubscriptionLimitMarketplace":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"SubscriptionLimitOtherPlatform":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"SubscriptionLimitTeam":{"type":"object","properties":{"limit":{"type":"integer","format":"int32","example":-1}}},"SubscriptionLimitProducts":{"type":"object","properties":{"bulk":{"type":"boolean"},"limit":{"type":"integer","format":"int32","example":-1}}},"SubscriptionLimitExtensions":{"type":"object","properties":{"enabled":{"type":"boolean"},"limit":{"type":"integer","format":"int32","example":-1}}},"SubscriptionLimitIntegrations":{"type":"object","properties":{"enabled":{"type":"boolean"},"limit":{"type":"integer","format":"int32","example":-1}}},"SubscriptionLimit":{"type":"object","properties":{"application":{"$ref":"#/components/schemas/SubscriptionLimitApplication"},"marketplace":{"$ref":"#/components/schemas/SubscriptionLimitMarketplace"},"other_platform":{"$ref":"#/components/schemas/SubscriptionLimitOtherPlatform"},"team":{"$ref":"#/components/schemas/SubscriptionLimitTeam"},"products":{"$ref":"#/components/schemas/SubscriptionLimitProducts"},"extensions":{"$ref":"#/components/schemas/SubscriptionLimitExtensions"},"integrations":{"$ref":"#/components/schemas/SubscriptionLimitIntegrations"},"is_trial_plan":{"type":"boolean"}}},"SubscriptionActivateReq":{"type":"object","properties":{"unique_id":{"type":"string","example":"1"},"type":{"type":"string","example":"company"},"product_suite":{"type":"string","example":"fynd-platform"},"plan_id":{"type":"string","example":"5ef1a72db9c566b5a5aa5f84"},"payment_method":{"type":"string","example":"12"}}},"SubscriptionActivateRes":{"type":"object","properties":{"success":{"type":"boolean","example":true},"data":{"$ref":"#/components/schemas/Subscription"}}},"CancelSubscriptionReq":{"type":"object","properties":{"unique_id":{"type":"string","example":"1"},"type":{"type":"string","example":"company"},"product_suite":{"type":"string","example":"fynd-platform"},"subscription_id":{"type":"string","example":"5eea10b4dae8da14752c3058"}}},"CancelSubscriptionRes":{"type":"object","properties":{"success":{"type":"boolean","example":true},"data":{"$ref":"#/components/schemas/Subscription"}}},"PlanStatusUpdateReq":{"type":"object","properties":{"plan_id":{"type":"string","example":"64c4c6c430cb71a27650ae41"},"reason":{"type":"string","example":"wrong commercials"},"seller_status":{"type":"string","example":"rejected"}}},"SunscribePlan":{"type":"object","properties":{"entity_type":{"type":"string","example":"subscription"},"collection_type":{"type":"string","example":"online"},"plan_id":{"type":"string","example":"64e8c18e548ddf67f0c4cb1f"},"callback_url":{"type":"string","example":"https://platform.fyndx1.de/company/8029/billing/bills"},"meta":{"$ref":"#/components/schemas/Meta"}}},"Meta":{"type":"object","properties":{"kafka_emission_status":{"type":"integer","format":"int32"},"state_manager_used":{"type":"string"}}},"SubscribePlanRes":{"type":"object","properties":{"redirect_url":{"type":"string","example":"https://platform.fyndx1.de/company/8029/subscription/renew-plan?plan_id=64e8c18e548ddf67f0c4cb1f&transaction_id=64ec54e3202d2b0bd9fcd120&renew=true&callback_url=https://platform.fyndx1.de/company/8029/billing/bills&meta={\\\"subscribe\\\":true,\\\"is_custom_plan\\\":true,\\\"is_plan_upgrade\\\":false}"},"transaction_id":{"type":"string","example":"64ec54e3202d2b0bd9fcd120"},"current_status":{"type":"string","example":"initiated"},"meta":{"$ref":"#/components/schemas/Meta"}}},"Features":{"type":"object","properties":{"name":{"type":"string","example":"Shipping"},"slug":{"type":"string","example":"shipping"},"description":{"type":"string","example":"shipping"},"group":{"type":"string","example":"feature"},"enabled":{"type":"boolean","example":true},"display_text":{"type":"string","example":"card"}}},"FeeComponents":{"type":"object","properties":{"brand":{"type":"array","items":{"type":"string","example":""}},"location":{"type":"array","items":{"type":"string","example":""}},"channel":{"type":"array","items":{"type":"object","example":{}}},"business_lead":{"type":"string","example":"open-api"},"settlement_type":{"type":"string","example":"monthly"},"settle_cycle_period":{"type":"object","example":{}},"components":{"type":"array","items":{"type":"object","example":{}}}}},"Details":{"type":"object","properties":{"fee_components":{"type":"array","items":{"$ref":"#/components/schemas/FeeComponents"}},"features":{"type":"array","items":{"$ref":"#/components/schemas/Features"}}}},"EntityResponse":{"type":"object","properties":{"success":{"type":"boolean","example":true},"page":{"type":"integer","format":"int32","example":1},"page_size":{"type":"integer","format":"int32","example":1},"items":{"type":"array","items":{"$ref":"#/components/schemas/Details"}}}},"CouponDateMeta":{"type":"object","properties":{"modified_on":{"type":"string","format":"date-time","default":null,"nullable":true},"created_on":{"type":"string","format":"date-time","default":null,"nullable":true}}},"Ownership":{"type":"object","properties":{"payable_category":{"type":"string","enum":["fynd","seller"]},"payable_by":{"type":"string"}},"required":["payable_by","payable_category"]},"CouponAuthor":{"type":"object","properties":{"created_by":{"type":"string","default":null,"nullable":true},"modified_by":{"type":"string","default":null,"nullable":true}}},"State":{"type":"object","properties":{"is_archived":{"type":"boolean","default":false},"is_display":{"type":"boolean","default":true},"is_public":{"type":"boolean","default":true}}},"PaymentAllowValue":{"type":"object","properties":{"max":{"type":"integer","format":"int32"}}},"PaymentModes":{"type":"object","properties":{"codes":{"type":"array","items":{"type":"string"}},"iins":{"type":"array","items":{"type":"string"}},"types":{"type":"array","items":{"type":"string"}},"networks":{"type":"array","items":{"type":"string"}},"uses":{"$ref":"#/components/schemas/PaymentAllowValue"}}},"PriceRange":{"type":"object","properties":{"max":{"type":"integer","format":"int32","default":-1},"min":{"type":"integer","format":"int32","default":-1}}},"PostOrder":{"type":"object","properties":{"cancellation_allowed":{"type":"boolean","default":true},"return_allowed":{"type":"boolean","default":true}}},"BulkBundleRestriction":{"type":"object","properties":{"multi_store_allowed":{"type":"boolean"}},"required":["multi_store_allowed"]},"UsesRemaining":{"type":"object","properties":{"user":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int32"},"app":{"type":"integer","format":"int32"}}},"UsesRestriction":{"type":"object","properties":{"maximum":{"$ref":"#/components/schemas/UsesRemaining"},"remaining":{"$ref":"#/components/schemas/UsesRemaining"}}},"Restrictions":{"type":"object","properties":{"payments":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/PaymentModes"}},"user_type":{"type":"string"},"price_range":{"$ref":"#/components/schemas/PriceRange"},"platforms":{"type":"array","items":{"type":"string"}},"post_order":{"$ref":"#/components/schemas/PostOrder"},"bulk_bundle":{"$ref":"#/components/schemas/BulkBundleRestriction"},"user_groups":{"type":"array","items":{"type":"integer","format":"int32"}},"coupon_allowed":{"type":"boolean"},"uses":{"$ref":"#/components/schemas/UsesRestriction"},"ordering_stores":{"type":"array","items":{"type":"integer","format":"int32"}}}},"Validation":{"type":"object","properties":{"app_id":{"type":"array","default":[],"items":{"type":"string"}},"anonymous":{"type":"boolean"},"user_registered_after":{"type":"string","format":"date-time","default":null,"nullable":true}}},"CouponAction":{"type":"object","properties":{"action_date":{"type":"string","format":"date-time","default":null,"nullable":true},"txn_mode":{"type":"string","default":"coupon","enum":["fynd_cash","cash","coupon"]}}},"CouponSchedule":{"type":"object","properties":{"end":{"type":"string","format":"date-time","default":null,"nullable":true},"start":{"type":"string","format":"date-time"},"next_schedule":{"type":"array","items":{"type":"object"}},"cron":{"type":"string","default":null,"nullable":true},"duration":{"type":"integer","format":"int32","default":null,"nullable":true}}},"Rule":{"type":"object","properties":{"key":{"type":"number","format":"float"},"value":{"type":"number","format":"float"},"max":{"type":"number","format":"float"},"discount_qty":{"type":"number","format":"float"},"min":{"type":"number","format":"float"}}},"DisplayMetaDict":{"type":"object","properties":{"title":{"type":"string"},"subtitle":{"type":"string"}}},"DisplayMeta":{"type":"object","properties":{"title":{"type":"string"},"auto":{"$ref":"#/components/schemas/DisplayMetaDict"},"apply":{"$ref":"#/components/schemas/DisplayMetaDict"},"remove":{"$ref":"#/components/schemas/DisplayMetaDict"},"subtitle":{"type":"string"},"description":{"type":"string"}}},"Identifier":{"type":"object","properties":{"alu":{"type":"string","nullable":true},"ean":{"type":"string","nullable":true},"sku_code":{"type":"string","nullable":true},"upc":{"type":"string","nullable":true},"isbn":{"type":"string","nullable":true}}},"Validity":{"type":"object","properties":{"priority":{"type":"integer","format":"int32"}}},"RuleDefinition":{"type":"object","properties":{"currency_code":{"type":"string","default":"INR"},"auto_apply":{"type":"boolean"},"type":{"type":"string","enum":["absolute","percentage","bogo","bundle"]},"is_exact":{"type":"boolean","default":false},"applicable_on":{"type":"string","enum":["amount","quantity"]},"calculate_on":{"type":"string","enum":["mrp","esp","tp"]},"value_type":{"type":"string","enum":["absolute","percentage","quantity","flat_price"]},"scope":{"type":"array","items":{"type":"string","enum":["category_id","brand_id","company_id","store_id","collection_id","exclude_brand_id","email_domain"]}}},"required":["applicable_on","calculate_on","type","value_type"]},"CouponAdd":{"type":"object","properties":{"date_meta":{"$ref":"#/components/schemas/CouponDateMeta"},"ownership":{"$ref":"#/components/schemas/Ownership"},"author":{"$ref":"#/components/schemas/CouponAuthor"},"state":{"$ref":"#/components/schemas/State"},"restrictions":{"$ref":"#/components/schemas/Restrictions"},"validation":{"$ref":"#/components/schemas/Validation"},"action":{"$ref":"#/components/schemas/CouponAction"},"tags":{"type":"array","default":[],"items":{"type":"string"}},"_schedule":{"$ref":"#/components/schemas/CouponSchedule"},"rule":{"type":"array","items":{"$ref":"#/components/schemas/Rule"}},"display_meta":{"$ref":"#/components/schemas/DisplayMeta"},"code":{"type":"string"},"type_slug":{"type":"string"},"identifiers":{"$ref":"#/components/schemas/Identifier"},"validity":{"$ref":"#/components/schemas/Validity"},"rule_definition":{"$ref":"#/components/schemas/RuleDefinition"},"_id":{"type":"string","description":"Coupon id"}},"required":["code","display_meta","identifiers","ownership","rule","rule_definition","type_slug","validity"]},"Page":{"type":"object","properties":{"current":{"type":"number","description":"The current page number."},"has_next":{"type":"boolean","description":"Indicates if there is a next page."},"has_previous":{"type":"boolean","description":"Indicates if there is a previous page."},"total_page":{"type":"integer"},"item_total":{"type":"number","description":"The total number of items."},"size":{"type":"number","description":"The number of items per page."},"type":{"type":"string","description":"Type of the response (e.g., \"number\")."}}},"CouponsResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/CouponAdd"}},"page":{"$ref":"#/components/schemas/Page"}},"required":[]},"SuccessMessage":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}},"OperationErrorResponse":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}},"CouponUpdate":{"type":"object","properties":{"date_meta":{"$ref":"#/components/schemas/CouponDateMeta"},"ownership":{"$ref":"#/components/schemas/Ownership"},"author":{"$ref":"#/components/schemas/CouponAuthor"},"state":{"$ref":"#/components/schemas/State"},"restrictions":{"$ref":"#/components/schemas/Restrictions"},"validation":{"$ref":"#/components/schemas/Validation"},"action":{"$ref":"#/components/schemas/CouponAction"},"tags":{"type":"array","default":[],"items":{"type":"string"}},"_schedule":{"$ref":"#/components/schemas/CouponSchedule"},"rule":{"type":"array","items":{"$ref":"#/components/schemas/Rule"}},"display_meta":{"$ref":"#/components/schemas/DisplayMeta"},"code":{"type":"string"},"type_slug":{"type":"string"},"identifiers":{"$ref":"#/components/schemas/Identifier"},"validity":{"$ref":"#/components/schemas/Validity"},"rule_definition":{"$ref":"#/components/schemas/RuleDefinition"}},"required":["code","display_meta","identifiers","ownership","rule","rule_definition","type_slug","validity"]},"CouponPartialUpdate":{"type":"object","properties":{"archive":{"type":"boolean","description":"Send true to unpublish coupon"},"schedule":{"$ref":"#/components/schemas/CouponSchedule"}}},"DisplayMeta1":{"description":"Display related fields like name, offer label, offer text etc.","type":"object","properties":{"description":{"type":"string"},"offer_label":{"type":"string","default":""},"name":{"type":"string"},"offer_text":{"type":"string"}}},"Ownership1":{"description":"Promotion amount to be beared by","type":"object","properties":{"payable_category":{"type":"string","enum":["fynd","seller"]},"payable_by":{"type":"string"}},"required":["payable_by","payable_category"]},"CompareObject":{"type":"object","properties":{"equals":{"type":"number","format":"float"},"greater_than":{"type":"number","format":"float"},"less_than_equals":{"type":"number","format":"float"},"less_than":{"type":"number","format":"float"},"greater_than_equals":{"type":"number","format":"float"}}},"ItemCriteria":{"type":"object","properties":{"cart_quantity":{"$ref":"#/components/schemas/CompareObject"},"available_zones":{"type":"array","items":{"type":"string"}},"item_exclude_company":{"type":"array","items":{"type":"integer","format":"int32"}},"item_id":{"type":"array","items":{"type":"integer","format":"int32"}},"item_l1_category":{"type":"array","items":{"type":"integer","format":"int32"}},"cart_total":{"$ref":"#/components/schemas/CompareObject"},"cart_unique_item_quantity":{"$ref":"#/components/schemas/CompareObject"},"cart_unique_item_amount":{"$ref":"#/components/schemas/CompareObject"},"item_exclude_id":{"type":"array","items":{"type":"integer","format":"int32"}},"all_items":{"type":"boolean"},"item_exclude_l1_category":{"type":"array","items":{"type":"integer","format":"int32"}},"item_size":{"type":"array","items":{"type":"string"}},"item_store":{"type":"array","items":{"type":"integer","format":"int32"}},"item_exclude_sku":{"type":"array","items":{"type":"string"}},"item_department":{"type":"array","items":{"type":"integer","format":"int32"}},"item_exclude_store":{"type":"array","items":{"type":"integer","format":"int32"}},"item_brand":{"type":"array","items":{"type":"integer","format":"int32"}},"item_exclude_department":{"type":"array","items":{"type":"integer","format":"int32"}},"item_exclude_category":{"type":"array","items":{"type":"integer","format":"int32"}},"item_category":{"type":"array","items":{"type":"integer","format":"int32"}},"buy_rules":{"type":"array","items":{"type":"string"}},"item_exclude_brand":{"type":"array","items":{"type":"integer","format":"int32"}},"item_l2_category":{"type":"array","items":{"type":"integer","format":"int32"}},"item_company":{"type":"array","items":{"type":"integer","format":"int32"}},"item_tags":{"type":"array","items":{"type":"string"}},"item_exclude_l2_category":{"type":"array","items":{"type":"integer","format":"int32"}},"item_sku":{"type":"array","items":{"type":"string"}}}},"DiscountOffer":{"type":"object","properties":{"max_discount_amount":{"type":"number","format":"float"},"discount_price":{"type":"number","format":"float"},"apportion_discount":{"type":"boolean"},"partial_can_ret":{"type":"boolean"},"max_usage_per_transaction":{"type":"integer","format":"int32"},"min_offer_quantity":{"type":"integer","format":"int32"},"code":{"type":"string"},"discount_amount":{"type":"number","format":"float"},"discount_percentage":{"type":"number","format":"float"},"max_offer_quantity":{"type":"integer","format":"int32"}}},"DiscountRule":{"type":"object","properties":{"discount_type":{"type":"string","enum":["percentage","amount","fixed_price","fixed_unit_price","bogo","shipping_price","cashback","coupon_code","free_items","free_gift_items","free_non_sellable_items"]},"buy_condition":{"type":"string"},"item_criteria":{"$ref":"#/components/schemas/ItemCriteria"},"offer":{"$ref":"#/components/schemas/DiscountOffer"}},"required":["buy_condition","discount_type","item_criteria","offer"]},"PaymentAllowValue1":{"type":"object","properties":{"max":{"type":"integer","format":"int32"}}},"PromotionPaymentModes":{"type":"object","properties":{"type":{"type":"string"},"uses":{"$ref":"#/components/schemas/PaymentAllowValue1"},"codes":{"type":"array","items":{"type":"string"}}},"required":["type"]},"UserRegistered":{"type":"object","properties":{"end":{"type":"string","format":"date-time","nullable":true},"start":{"type":"string","format":"date-time","nullable":true}}},"PostOrder1":{"type":"object","properties":{"cancellation_allowed":{"type":"boolean","default":true},"return_allowed":{"type":"boolean","default":true}}},"UsesRemaining1":{"type":"object","properties":{"user":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int32"}}},"UsesRestriction1":{"type":"object","properties":{"maximum":{"$ref":"#/components/schemas/UsesRemaining1"},"remaining":{"$ref":"#/components/schemas/UsesRemaining1"}}},"Restrictions1":{"type":"object","description":"Sets restrictions for promotions to be applied for particular user set","properties":{"payments":{"type":"object","items":{"$ref":"#/components/schemas/PromotionPaymentModes"}},"user_registered":{"$ref":"#/components/schemas/UserRegistered"},"platforms":{"type":"array","items":{"type":"string"}},"post_order":{"$ref":"#/components/schemas/PostOrder1"},"user_groups":{"type":"array","items":{"type":"integer","format":"int32"}},"order_quantity":{"type":"integer","format":"int32"},"anonymous_users":{"type":"boolean"},"user_id":{"type":"array","items":{"type":"string"}},"uses":{"$ref":"#/components/schemas/UsesRestriction1"},"ordering_stores":{"type":"array","items":{"type":"integer","format":"int32"}}},"required":["uses"]},"PromotionSchedule":{"description":"Time range in which promotion stays active","type":"object","properties":{"end":{"type":"string","format":"date-time"},"start":{"type":"string","format":"date-time"},"published":{"type":"boolean"},"next_schedule":{"type":"array","items":{"type":"object"}},"cron":{"type":"string","nullable":true},"duration":{"type":"integer","format":"int32","nullable":true}},"required":["end","published","start"]},"PromotionAction":{"description":"Post order option for promotion like cancellation, return etc","type":"object","properties":{"action_date":{"type":"string","format":"date-time","nullable":true},"action_type":{"type":"string"}},"required":["action_date","action_type"]},"PromotionAuthor":{"type":"object","description":"Stating promotion created by or modified by","properties":{"created_by":{"type":"string","default":null,"nullable":true},"modified_by":{"type":"string","default":null,"nullable":true}}},"Visibility":{"description":"Promotion visiblility","type":"object","properties":{"coupon_list":{"type":"boolean"},"pdp":{"type":"boolean"}},"required":["coupon_list","pdp"]},"PromotionDateMeta":{"type":"object","description":"Contains promotion creation, modification date","properties":{"modified_on":{"type":"string","format":"date-time","default":null,"nullable":true},"created_on":{"type":"string","format":"date-time","default":null,"nullable":true}}},"PromotionListItem":{"type":"object","properties":{"stackable":{"type":"boolean","description":"Allows more than one promotion to get combined benefits"},"calculate_on":{"type":"string","enum":["mrp","esp"],"description":"Only available for Contract pricing and Ladder pricing promotion type"},"apply_exclusive":{"type":"string","description":"Doesn't allow other promotion after current promotion applied on cart or article","enum":["cart","article",null],"nullable":true},"promo_group":{"type":"string","description":"Group into which promotion fall","enum":["cart","product","contract","ladder_price","limited_timer"]},"mode":{"type":"string","description":"Promotion mode","enum":["promotion","coupon"]},"apply_all_discount":{"type":"boolean","description":"Prevents more than one promotion discounts"},"display_meta":{"$ref":"#/components/schemas/DisplayMeta1"},"ownership":{"$ref":"#/components/schemas/Ownership1"},"promotion_type":{"type":"string","description":"Type of the promotion","enum":["percentage","amount","fixed_price","bogo","contract_price","shipping_price","ladder_price","bundle_price_percentage","bundle_price_amount","bundle_amount_percentage","custom","free_gift_items","free_non_sellable_items"]},"discount_rules":{"type":"array","description":"Discount rules based on which promotion will be applied","items":{"$ref":"#/components/schemas/DiscountRule"}},"restrictions":{"$ref":"#/components/schemas/Restrictions1"},"currency":{"type":"string","description":"Currency used for promotion"},"code":{"type":"string","description":"Promotion code"},"_schedule":{"$ref":"#/components/schemas/PromotionSchedule"},"post_order_action":{"$ref":"#/components/schemas/PromotionAction"},"apply_priority":{"type":"integer","format":"int32","description":"Priority based on which promotion are applied on articles"},"author":{"$ref":"#/components/schemas/PromotionAuthor"},"visiblility":{"$ref":"#/components/schemas/Visibility"},"application_id":{"type":"string","description":"App id in which promotion will be used"},"buy_rules":{"type":"object","description":"Buy rules for the promotion","additionalProperties":{"$ref":"#/components/schemas/ItemCriteria"}},"_custom_json":{"type":"object","description":"custom data stored in promotion"},"date_meta":{"$ref":"#/components/schemas/PromotionDateMeta"},"_id":{"type":"string","description":"Promotion id"}},"required":["application_id","buy_rules","discount_rules","display_meta","mode","ownership","promo_group","promotion_type"]},"PromotionsResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PromotionListItem"}},"page":{"$ref":"#/components/schemas/Page"}},"required":[]},"PromotionAdd":{"type":"object","properties":{"stackable":{"type":"boolean"},"calculate_on":{"type":"string","enum":["mrp","esp"],"description":"Only available for Contract pricing and Ladder pricing promotion type"},"apply_exclusive":{"type":"string","enum":["cart","article",null],"nullable":true},"promo_group":{"type":"string","enum":["cart","product","contract","ladder_price","limited_timer"]},"mode":{"type":"string","enum":["promotion","coupon"]},"apply_all_discount":{"type":"boolean"},"display_meta":{"$ref":"#/components/schemas/DisplayMeta1"},"ownership":{"$ref":"#/components/schemas/Ownership1"},"promotion_type":{"type":"string","enum":["percentage","amount","fixed_price","bogo","contract_price","shipping_price","ladder_price","bundle_price_percentage","bundle_price_amount","bundle_amount_percentage","custom","free_gift_items","free_non_sellable_items"]},"discount_rules":{"type":"array","items":{"$ref":"#/components/schemas/DiscountRule"}},"restrictions":{"$ref":"#/components/schemas/Restrictions1"},"currency":{"type":"string"},"code":{"type":"string"},"_schedule":{"$ref":"#/components/schemas/PromotionSchedule"},"post_order_action":{"$ref":"#/components/schemas/PromotionAction"},"apply_priority":{"type":"integer","format":"int32"},"author":{"$ref":"#/components/schemas/PromotionAuthor"},"visiblility":{"$ref":"#/components/schemas/Visibility"},"application_id":{"type":"string"},"buy_rules":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ItemCriteria"}},"_custom_json":{"type":"object"},"date_meta":{"$ref":"#/components/schemas/PromotionDateMeta"}},"required":["application_id","buy_rules","discount_rules","display_meta","mode","ownership","promo_group","promotion_type"]},"PromotionUpdate":{"type":"object","properties":{"stackable":{"type":"boolean"},"calculate_on":{"type":"string","enum":["mrp","esp"],"description":"Only available for Contract pricing and Ladder pricing promotion type"},"apply_exclusive":{"type":"string","enum":["cart","article",null],"nullable":true},"promo_group":{"type":"string","enum":["cart","product","contract","ladder_price","limited_timer"]},"mode":{"type":"string","enum":["promotion","coupon"]},"apply_all_discount":{"type":"boolean"},"display_meta":{"$ref":"#/components/schemas/DisplayMeta1"},"ownership":{"$ref":"#/components/schemas/Ownership1"},"promotion_type":{"type":"string","enum":["percentage","amount","fixed_price","bogo","contract_price","shipping_price","ladder_price","bundle_price_percentage","bundle_price_amount","bundle_amount_percentage","custom","free_gift_items","free_non_sellable_items"]},"discount_rules":{"type":"array","items":{"$ref":"#/components/schemas/DiscountRule"}},"restrictions":{"$ref":"#/components/schemas/Restrictions1"},"currency":{"type":"string"},"code":{"type":"string"},"_schedule":{"$ref":"#/components/schemas/PromotionSchedule"},"post_order_action":{"$ref":"#/components/schemas/PromotionAction"},"apply_priority":{"type":"integer","format":"int32"},"author":{"$ref":"#/components/schemas/PromotionAuthor"},"visiblility":{"$ref":"#/components/schemas/Visibility"},"application_id":{"type":"string"},"buy_rules":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ItemCriteria"}},"_custom_json":{"type":"object"},"date_meta":{"$ref":"#/components/schemas/PromotionDateMeta"}},"required":["application_id","buy_rules","discount_rules","display_meta","mode","ownership","promo_group","promotion_type"]},"PromotionPartialUpdate":{"type":"object","properties":{"archive":{"type":"boolean","description":"Send true to unpublish promotion"},"schedule":{"$ref":"#/components/schemas/PromotionSchedule"}}},"ActivePromosResponse":{"type":"object","properties":{"entity_slug":{"type":"string"},"title":{"type":"string","description":"Name of the promotion"},"modified_on":{"type":"string","description":"Coupon modification date"},"example":{"type":"string","description":"Discount offers examples"},"entity_type":{"type":"string","description":"Type of entity to be selected from : ['coupon', 'promotion']"},"created_on":{"type":"string","description":"Coupon creation date"},"is_hidden":{"type":"boolean","description":"If the promo is active or not"},"type":{"type":"string","description":"Coupon type"},"subtitle":{"type":"string","description":"Small description of the current offer"},"description":{"type":"string","description":"The description of the offer in the form of an HTML"}}},"Charges":{"type":"object","properties":{"threshold":{"type":"number","format":"float","description":"The order value below which an extra delivery fee will be applicable"},"charges":{"type":"number","format":"float","description":"Delivery amount to be charged when order value is below the defined threshold value"}}},"DeliveryCharges":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Allow delivery charges"},"charges":{"type":"array","description":"Holds values for delivery charges.","items":{"$ref":"#/components/schemas/Charges"}}}},"CartMetaConfigUpdate":{"type":"object","properties":{"min_cart_value":{"type":"integer","format":"int32"},"bulk_coupons":{"type":"boolean"},"max_cart_items":{"type":"integer","format":"int32"},"gift_display_text":{"type":"string"},"delivery_charges":{"$ref":"#/components/schemas/DeliveryCharges"},"revenue_engine_coupon":{"type":"boolean"},"gift_pricing":{"type":"number","format":"float"},"enabled":{"type":"boolean"}}},"CartMetaConfigAdd":{"type":"object","properties":{"min_cart_value":{"type":"integer","format":"int32"},"bulk_coupons":{"type":"boolean"},"max_cart_items":{"type":"integer","format":"int32"},"gift_display_text":{"type":"string"},"delivery_charges":{"$ref":"#/components/schemas/DeliveryCharges"},"revenue_engine_coupon":{"type":"boolean"},"gift_pricing":{"type":"number","format":"float"},"enabled":{"type":"boolean"}}},"Article":{"type":"object","properties":{"child_details":{"type":"object","nullable":true},"seller_identifier":{"type":"string"},"uid":{"type":"string"},"a_set":{"type":"object","nullable":true},"dimensions":{"$ref":"#/components/schemas/Dimensions"},"currency":{"type":"object","nullable":true},"esp_modified":{"type":"boolean","nullable":true},"return_config":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/ReturnConfig"}]},"code":{"type":"string","nullable":true},"weight":{"$ref":"#/components/schemas/Weight"},"_id":{"type":"string"},"identifiers":{"type":"object"},"raw_meta":{"type":"string","nullable":true},"size":{"type":"string"},"is_set":{"type":"boolean","nullable":true}},"required":["_id","identifiers","seller_identifier","size","uid"]},"PriceAdjustmentRestrictions":{"type":"object","properties":{"post_order":{"type":"object","description":"This field holds the post-order restrictions, indicated by nested fields ['cancellation_allowed','return_allowed']"}}},"Collection":{"type":"object","properties":{"refund_by":{"type":"string"},"collected_by":{"type":"string"}},"required":["collected_by","refund_by"]},"PriceAdjustmentUpdate":{"type":"object","properties":{"modified_by":{"type":"string","description":"The entity that modified the field"},"value":{"type":"number","format":"float"},"message":{"type":"string","description":"The message associated with the price adjustment"},"apply_expiry":{"type":"string","format":"date-time","description":"The date and time when the expiry should be applied"},"restrictions":{"description":"restrictions applied to this particular item or product, including whether or not cancellation and return are allowed.","allOf":[{"$ref":"#/components/schemas/PriceAdjustmentRestrictions"}]},"article_level_distribution":{"type":"boolean","description":"Flag indicating whether the distribution should is done at the article level"},"collection":{"$ref":"#/components/schemas/Collection"},"type":{"type":"string","enum":["charge","discount","mop","selling_price","delivery_charge"],"description":"type of price adjusment"},"allowed_refund":{"type":"boolean","description":"Flag indicating whether refunds are allowed (default: False)"},"is_authenticated":{"type":"boolean","description":"Flag indicating whether the user is authenticated"},"article_ids":{"type":"array","description":"The list of article object in the price adjustment","items":{"$ref":"#/components/schemas/Article"}},"meta":{"type":"object"},"cart_id":{"type":"string","description":"The ID of the cart"}},"required":["article_ids","article_level_distribution","cart_id","collection","is_authenticated","message","type","value"]},"PriceAdjustment":{"type":"object","properties":{"value":{"type":"number","format":"float"},"message":{"type":"string","description":"The message associated with the price adjustment"},"apply_expiry":{"type":"string","format":"date-time","description":"The date and time when the expiry should be applied"},"restrictions":{"description":"This field accepts the restrictions applied to this particular item or service, including whether or not cancellation and return are allowed, etc","allOf":[{"$ref":"#/components/schemas/PriceAdjustmentRestrictions"}]},"article_level_distribution":{"type":"boolean","description":"Flag indicating whether the distribution should is done at the article level"},"id":{"type":"string","readOnly":true},"collection":{"$ref":"#/components/schemas/Collection"},"type":{"type":"string","enum":["charge","discount","mop","selling_price","delivery_charge"],"description":"type of price adjusment"},"allowed_refund":{"type":"boolean","description":"Flag indicating whether refunds are allowed (default: False)"},"is_authenticated":{"type":"boolean","description":"Flag indicating whether the user is authenticated"},"article_ids":{"type":"array","description":"The list of article object in the price adjustment","items":{"$ref":"#/components/schemas/Article"}},"meta":{"type":"object"},"cart_id":{"type":"string","description":"The ID of the cart"}},"required":["article_ids","article_level_distribution","cart_id","collection","is_authenticated","message","type","value"]},"PriceAdjustmentResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PriceAdjustment"}}},"PriceAdjustmentAdd":{"type":"object","properties":{"value":{"type":"number","format":"float"},"message":{"type":"string","description":"The message associated with the price adjustment"},"apply_expiry":{"type":"string","format":"date-time","description":"The date and time when the expiry should be applied"},"restrictions":{"description":"This field accepts the restrictions applied to this particular item or service, including whether or not cancellation and return are allowed, etc","allOf":[{"$ref":"#/components/schemas/PriceAdjustmentRestrictions"}]},"created_by":{"type":"string","description":"The entity that created the field"},"article_level_distribution":{"type":"boolean","description":"Flag indicating whether the distribution should is done at the article level"},"collection":{"$ref":"#/components/schemas/Collection"},"type":{"type":"string","enum":["charge","discount","mop","selling_price","delivery_charge"],"description":"type of price adjusment"},"allowed_refund":{"type":"boolean","description":"Flag indicating whether refunds are allowed (default: False)"},"is_authenticated":{"type":"boolean","description":"Flag indicating whether the user is authenticated"},"article_ids":{"type":"array","description":"The list of article object in the price adjustment","items":{"$ref":"#/components/schemas/Article"}},"meta":{"type":"object"},"cart_id":{"type":"string","description":"The ID of the cart"}},"required":["article_ids","article_level_distribution","cart_id","collection","is_authenticated","message","type","value"]},"CartItem":{"type":"object","properties":{"quantity":{"type":"integer","format":"int32"},"product_id":{"type":"string"},"size":{"type":"string"}},"required":["product_id","size"]},"OpenapiCartDetailsRequest":{"type":"object","properties":{"cart_items":{"type":"array","items":{"$ref":"#/components/schemas/CartItem"}}},"required":["cart_items"]},"CouponBreakup":{"type":"object","properties":{"title":{"type":"string","nullable":true},"max_discount_value":{"type":"number","format":"float"},"value":{"type":"number","format":"float"},"is_applied":{"type":"boolean"},"uid":{"type":"string"},"coupon_type":{"type":"string","nullable":true},"sub_title":{"type":"string","nullable":true},"coupon_value":{"type":"number","format":"float"},"code":{"type":"string"},"type":{"type":"string"},"minimum_cart_value":{"type":"number","format":"float"},"message":{"type":"string"},"description":{"type":"string","nullable":true}}},"DisplayBreakup":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"number","format":"float"},"currency_code":{"type":"string"},"currency_symbol":{"type":"string"},"display":{"type":"string"},"message":{"type":"array","items":{"type":"string"}}}},"LoyaltyPoints":{"type":"object","properties":{"is_applied":{"type":"boolean"},"total":{"type":"number","format":"float"},"applicable":{"type":"number","format":"float"},"description":{"type":"string"}}},"RawBreakup":{"type":"object","properties":{"coupon":{"type":"number","format":"float"},"gst_charges":{"type":"number","format":"float"},"mrp_total":{"type":"number","format":"float"},"fynd_cash":{"type":"number","format":"float"},"vog":{"type":"number","format":"float"},"gift_card":{"type":"number","format":"float"},"cod_charge":{"type":"number","format":"float"},"total":{"type":"number","format":"float"},"discount":{"type":"number","format":"float"},"delivery_charge":{"type":"number","format":"float"},"you_saved":{"type":"number","format":"float"},"subtotal":{"type":"number","format":"float"},"convenience_fee":{"type":"number","format":"float"}}},"CartBreakup":{"type":"object","properties":{"coupon":{"$ref":"#/components/schemas/CouponBreakup"},"display":{"type":"array","items":{"$ref":"#/components/schemas/DisplayBreakup"}},"loyalty_points":{"$ref":"#/components/schemas/LoyaltyPoints"},"raw":{"$ref":"#/components/schemas/RawBreakup"}}},"ProductImage":{"type":"object","properties":{"secure_url":{"type":"string"},"url":{"type":"string"},"aspect_ratio":{"type":"string"}}},"Tags":{"type":"object","properties":{"tags":{"type":"object"}}},"BaseInfo":{"type":"object","properties":{"uid":{"type":"integer","format":"int32"},"name":{"type":"string"}}},"ActionQuery":{"type":"object","properties":{"product_slug":{"type":"array","description":"Contains list of product slug","items":{"type":"string"}}}},"ProductAction":{"type":"object","properties":{"type":{"type":"string"},"url":{"type":"string"},"query":{"$ref":"#/components/schemas/ActionQuery"}}},"CategoryInfo":{"type":"object","properties":{"uid":{"type":"integer","format":"int32","description":"Product Category Id"},"name":{"type":"string"}}},"CartProduct":{"type":"object","properties":{"slug":{"type":"string","description":"Unique product url name generated via product name and other meta data"},"images":{"type":"array","items":{"$ref":"#/components/schemas/ProductImage"}},"teaser_tag":{"$ref":"#/components/schemas/Tags"},"brand":{"$ref":"#/components/schemas/BaseInfo"},"action":{"$ref":"#/components/schemas/ProductAction"},"uid":{"type":"integer","format":"int32"},"tags":{"type":"array","items":{"type":"string"}},"_custom_json":{"type":"object"},"type":{"type":"string"},"name":{"type":"string"},"item_code":{"type":"string","nullable":true},"categories":{"type":"array","items":{"$ref":"#/components/schemas/CategoryInfo"}},"attributes":{"type":"object"}}},"BasePrice":{"type":"object","properties":{"effective":{"type":"number","format":"float"},"currency_code":{"type":"string"},"currency_symbol":{"type":"string"},"marked":{"type":"number","format":"float"}}},"ArticlePriceInfo":{"type":"object","properties":{"converted":{"$ref":"#/components/schemas/BasePrice"},"base":{"$ref":"#/components/schemas/BasePrice"}}},"StoreInfo":{"type":"object","properties":{"uid":{"type":"integer","format":"int32"},"name":{"type":"string"},"store_code":{"type":"string"}}},"ProductArticle":{"type":"object","properties":{"seller_identifier":{"type":"string"},"quantity":{"type":"integer","format":"int32"},"seller":{"$ref":"#/components/schemas/BaseInfo"},"cart_item_meta":{"type":"object"},"parent_item_identifiers":{"type":"object"},"is_gift_visible":{"type":"boolean"},"uid":{"type":"string"},"gift_card":{"type":"object"},"product_group_tags":{"type":"array","items":{"type":"string"}},"identifier":{"type":"object"},"mto_quantity":{"type":"integer","format":"int32"},"extra_meta":{"type":"object"},"type":{"type":"string"},"_custom_json":{"type":"object"},"price":{"$ref":"#/components/schemas/ArticlePriceInfo"},"meta":{"type":"object"},"size":{"type":"string"},"store":{"$ref":"#/components/schemas/StoreInfo"},"tags":{"type":"array","items":{"type":"string"},"description":"a list of article tags"}}},"Ownership2":{"type":"object","properties":{"payable_category":{"type":"string","description":"promo amount payable category"},"payable_by":{"type":"string","description":"promo amount bearable party"}}},"DiscountRulesApp":{"type":"object","properties":{"offer":{"type":"object","description":"offer for promotion"},"raw_offer":{"type":"object","description":"raw offer details for promotion"},"item_criteria":{"type":"object","description":"Item criteria of promotion"},"matched_buy_rules":{"type":"array","description":"Matched buy rules for promotion","items":{"type":"string"}}}},"FreeGiftItem":{"type":"object","properties":{"item_name":{"type":"string","description":"Item name"},"item_price_details":{"type":"object","description":"item price details"},"item_brand_name":{"type":"string","description":"item brand name"},"item_images_url":{"type":"array","description":"item images URL","items":{"type":"string"}},"item_id":{"type":"integer","format":"int32","description":"Item id"},"item_slug":{"type":"string","description":"item slug"}}},"AppliedFreeArticles":{"type":"object","properties":{"parent_item_identifier":{"type":"string","description":"Parent item identifier for free article"},"quantity":{"type":"integer","format":"int32","description":"Free article quantity"},"article_id":{"type":"string","description":"free article id"},"free_gift_item_details":{"description":"Free gift items details","allOf":[{"$ref":"#/components/schemas/FreeGiftItem"}]}}},"BuyRules":{"type":"object","properties":{"item_criteria":{"$ref":"#/components/schemas/ItemCriterias"},"cart_conditions":{"type":"object","nullable":true}}},"AppliedPromotion":{"type":"object","properties":{"article_quantity":{"type":"integer","format":"int32","description":"Quantity of article on which promotion is applicable"},"ownership":{"description":"Ownership of promotion","allOf":[{"$ref":"#/components/schemas/Ownership2"}]},"currency":{"$ref":"#/components/schemas/CartCurrency"},"discount_rules":{"description":"Discount rules for promotions","type":"array","items":{"$ref":"#/components/schemas/DiscountRulesApp"}},"applied_free_articles":{"description":"Applied free article for free gift item promotions","type":"array","items":{"$ref":"#/components/schemas/AppliedFreeArticles"}},"promotion_name":{"type":"string","description":"Promotion name of current promotion"},"buy_rules":{"description":"Buy rules for promotions","type":"array","items":{"$ref":"#/components/schemas/BuyRules"}},"offer_text":{"type":"string","description":"Offer text of current promotion"},"amount":{"type":"number","format":"float","description":"Per unit discount amount applied with current promotion"},"promotion_type":{"type":"string","description":"Promotion type of current promotion"},"mrp_promotion":{"type":"boolean","description":"If applied promotion is applied on product MRP or ESP"},"promotion_group":{"type":"string","description":"Promotion group for the promotion"},"promo_id":{"type":"string","description":"Promotion id"},"meta":{"type":"object","description":"Meta object for extra data"},"code":{"type":"string","description":"Promotion code","nullable":true}}},"PromiseFormatted":{"type":"object","properties":{"max":{"type":"string"},"min":{"type":"string"}}},"PromiseISOFormat":{"type":"object","description":"Promise in ISO format.","properties":{"max":{"type":"string","description":"Max promise in ISO format."},"min":{"type":"string","description":"Min Promise in ISO format."}}},"PromiseTimestamp":{"type":"object","properties":{"max":{"type":"number","format":"float"},"min":{"type":"number","format":"float"}}},"ShipmentPromise":{"type":"object","properties":{"formatted":{"$ref":"#/components/schemas/PromiseFormatted"},"timestamp":{"$ref":"#/components/schemas/PromiseTimestamp"},"iso":{"$ref":"#/components/schemas/PromiseISOFormat"}}},"CouponDetails":{"type":"object","properties":{"discount_total_quantity":{"type":"number","format":"float"},"discount_single_quantity":{"type":"number","format":"float"},"code":{"type":"string"}}},"ProductPrice":{"type":"object","properties":{"marked":{"type":"number","format":"float"},"add_on":{"type":"number","format":"float"},"currency_code":{"type":"string"},"currency_symbol":{"type":"string"},"effective":{"type":"number","format":"float"},"selling":{"type":"number","format":"float"}}},"ProductPriceInfo":{"type":"object","properties":{"converted":{"$ref":"#/components/schemas/ProductPrice"},"base":{"$ref":"#/components/schemas/ProductPrice"}}},"CartProductIdentifer":{"type":"object","properties":{"identifier":{"type":"string","description":"Article idenfier generated by cart"}}},"ProductAvailabilitySize":{"type":"object","properties":{"display":{"type":"string"},"value":{"type":"string"},"is_available":{"type":"boolean"}}},"ProductAvailability":{"type":"object","properties":{"is_valid":{"type":"boolean"},"other_store_quantity":{"type":"integer","format":"int32"},"deliverable":{"type":"boolean"},"available_sizes":{"type":"array","items":{"$ref":"#/components/schemas/ProductAvailabilitySize"}},"out_of_stock":{"type":"boolean"},"sizes":{"type":"array","items":{"type":"string"}}}},"PromoMeta":{"type":"object","properties":{"message":{"type":"string"}}},"CartProductInfo":{"type":"object","properties":{"quantity":{"type":"integer","format":"int32"},"product":{"$ref":"#/components/schemas/CartProduct"},"product_ean_id":{"type":"string"},"parent_item_identifiers":{"type":"object"},"is_set":{"type":"boolean"},"article":{"$ref":"#/components/schemas/ProductArticle"},"promotions_applied":{"type":"array","items":{"$ref":"#/components/schemas/AppliedPromotion"}},"delivery_promise":{"$ref":"#/components/schemas/ShipmentPromise"},"key":{"type":"string"},"coupon":{"$ref":"#/components/schemas/CouponDetails"},"bulk_offer":{"type":"object"},"price":{"$ref":"#/components/schemas/ProductPriceInfo"},"coupon_message":{"type":"string"},"identifiers":{"$ref":"#/components/schemas/CartProductIdentifer"},"message":{"type":"string"},"discount":{"type":"string"},"availability":{"$ref":"#/components/schemas/ProductAvailability"},"moq":{"type":"object"},"price_per_unit":{"$ref":"#/components/schemas/ProductPriceInfo"},"promo_meta":{"$ref":"#/components/schemas/PromoMeta"},"custom_order":{"type":"object"}},"required":["identifiers"]},"OpenapiCartDetailsResponse":{"type":"object","properties":{"is_valid":{"type":"boolean"},"message":{"type":"string"},"breakup_values":{"$ref":"#/components/schemas/CartBreakup"},"items":{"type":"array","items":{"$ref":"#/components/schemas/CartProductInfo"}}}},"OpenApiErrorResponse":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"},"errors":{"type":"object","description":"Contains field name which has error as key and error message as value"}}},"ShippingAddress":{"type":"object","properties":{"country":{"type":"string","nullable":true},"state":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"phone":{"type":"integer","format":"int32"},"area_code":{"type":"string","minLength":1},"country_iso_code":{"type":"string"},"country_phone_code":{"type":"string"},"meta":{"type":"object"},"address_type":{"type":"string"},"area":{"type":"string"},"area_code_slug":{"type":"string","default":"pincode"},"name":{"type":"string"},"landmark":{"type":"string"},"email":{"type":"string"},"country_code":{"type":"string","default":"IND"},"pincode":{"type":"integer","format":"int32"},"address":{"type":"string"}},"required":["area_code"]},"OpenApiCartServiceabilityRequest":{"type":"object","properties":{"cart_items":{"type":"array","items":{"$ref":"#/components/schemas/CartItem"}},"shipping_address":{"$ref":"#/components/schemas/ShippingAddress"}},"required":["cart_items","shipping_address"]},"OpenApiCartServiceabilityResponse":{"type":"object","properties":{"is_valid":{"type":"boolean"},"items":{"type":"array","items":{"$ref":"#/components/schemas/CartProductInfo"}},"delivery_promise":{"$ref":"#/components/schemas/ShipmentPromise"},"message":{"type":"string"},"breakup_values":{"$ref":"#/components/schemas/CartBreakup"}}},"OpenApiFiles":{"type":"object","properties":{"key":{"type":"string"},"values":{"type":"array","items":{"type":"string"}}},"required":["key","values"]},"CartItemMeta":{"type":"object","properties":{"primary_item":{"type":"boolean"},"group_id":{"type":"string"}}},"MultiTenderPaymentMeta":{"type":"object","properties":{"extra_meta":{"type":"object","nullable":true},"order_id":{"type":"string"},"payment_id":{"type":"string"},"current_status":{"type":"string"},"payment_gateway":{"type":"string"}}},"MultiTenderPaymentMethod":{"type":"object","properties":{"name":{"type":"string","description":"Payment mode name"},"meta":{"$ref":"#/components/schemas/MultiTenderPaymentMeta"},"amount":{"type":"number","format":"float","description":"Payment amount"},"mode":{"type":"string"}},"required":["amount","mode"]},"OpenApiOrderItem":{"type":"object","properties":{"cashback_applied":{"type":"number","format":"float"},"quantity":{"type":"integer","format":"int32","default":1},"size":{"type":"string"},"coupon_effective_discount":{"type":"number","format":"float"},"amount_paid":{"type":"number","format":"float"},"delivery_charges":{"type":"number","format":"float"},"price_marked":{"type":"number","format":"float","minimum":0},"files":{"type":"array","items":{"$ref":"#/components/schemas/OpenApiFiles"}},"meta":{"$ref":"#/components/schemas/CartItemMeta"},"extra_meta":{"type":"object"},"product_id":{"type":"integer","format":"int32"},"loyalty_discount":{"type":"number","format":"float","default":0},"discount":{"type":"number","format":"float"},"price_effective":{"type":"number","format":"float","minimum":0},"payment_methods":{"type":"array","items":{"$ref":"#/components/schemas/MultiTenderPaymentMethod"}},"employee_discount":{"type":"number","format":"float","default":0},"cod_charges":{"type":"number","format":"float"}},"required":["amount_paid","cashback_applied","cod_charges","coupon_effective_discount","delivery_charges","discount","payment_methods","price_effective","price_marked","product_id","size"]},"OpenApiPlatformCheckoutReq":{"type":"object","properties":{"payment_mode":{"type":"string"},"cart_value":{"type":"number","format":"float"},"cart_items":{"type":"array","items":{"$ref":"#/components/schemas/OpenApiOrderItem"}},"shipping_address":{"$ref":"#/components/schemas/ShippingAddress"},"loyalty_discount":{"type":"number","format":"float"},"comment":{"type":"string","nullable":true},"payment_methods":{"type":"array","items":{"$ref":"#/components/schemas/MultiTenderPaymentMethod"}},"employee_discount":{"type":"object"},"coupon":{"type":"string"},"cashback_applied":{"type":"number","format":"float"},"gstin":{"type":"string","nullable":true},"billing_address":{"$ref":"#/components/schemas/ShippingAddress"},"coupon_code":{"type":"string"},"coupon_value":{"type":"number","format":"float"},"delivery_charges":{"type":"number","format":"float"},"affiliate_order_id":{"type":"string"},"currency_code":{"type":"string"},"order_id":{"type":"string"},"files":{"type":"array","items":{"$ref":"#/components/schemas/OpenApiFiles"}},"cod_charges":{"type":"number","format":"float"}},"required":["billing_address","cart_items","cart_value","cashback_applied","cod_charges","coupon_code","coupon_value","delivery_charges","payment_methods"]},"OpenApiCheckoutResponse":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"},"order_ref_id":{"type":"string","description":"Order id sent in request"},"order_id":{"type":"string","description":"Fynd order id"}},"required":["order_id"]},"AbandonedCart":{"type":"object","properties":{"expire_at":{"type":"string","format":"date-time"},"promotion":{"type":"object"},"is_default":{"type":"boolean"},"comment":{"type":"string","nullable":true},"articles":{"type":"array","items":{"type":"object"}},"coupon":{"type":"object","nullable":true},"bulk_coupon_discount":{"type":"number","format":"float","nullable":true},"_id":{"type":"string"},"fynd_credits":{"type":"object"},"fc_index_map":{"type":"array","items":{"type":"integer","format":"int32"}},"order_id":{"type":"string"},"discount":{"type":"number","format":"float"},"cod_charges":{"type":"object"},"payments":{"type":"object","nullable":true},"payment_mode":{"type":"string","nullable":true},"shipments":{"type":"array","items":{"type":"object"}},"pick_up_customer_details":{"type":"object","nullable":true},"uid":{"type":"integer","format":"int32"},"checkout_mode":{"type":"string"},"cart_value":{"type":"number","format":"float"},"is_archive":{"type":"boolean"},"created_on":{"type":"string","format":"date-time"},"last_modified":{"type":"string","format":"date-time"},"meta":{"type":"object","nullable":true},"buy_now":{"type":"boolean"},"is_active":{"type":"boolean"},"cashback":{"type":"object"},"payment_methods":{"type":"array","items":{"type":"object"}},"gstin":{"type":"string","nullable":true},"delivery_charges":{"type":"object"},"merge_qty":{"type":"boolean","nullable":true},"user_id":{"type":"string"},"app_id":{"type":"string"}},"required":["_id","articles","cashback","created_on","expire_at","is_default","last_modified","uid","user_id"]},"AbandonedCartResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/AbandonedCart"}},"result":{"type":"object"},"page":{"$ref":"#/components/schemas/Page"},"success":{"type":"boolean","description":"the request success is defined"},"message":{"type":"string","description":"message of the response"}},"required":[]},"PaymentSelectionLock":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Shows whether payment mode is restricted to a specific option, e.g. 'HDFC Netbanking'"},"default_options":{"type":"string","description":"Shows default payment method, e.g. COD"},"payment_identifier":{"type":"string","description":"Payment method chosen from default options, e.g. COD"}}},"CartCurrency":{"type":"object","properties":{"code":{"type":"string","description":"Currency code defined by ISO 4217:2015"},"symbol":{"type":"string"}}},"CartDetailCoupon":{"type":"object","properties":{"cashback_amount":{"type":"number","format":"float"},"cashback_message_primary":{"type":"string"},"cashback_message_secondary":{"type":"string"},"coupon_code":{"type":"string"},"coupon_description":{"type":"string"},"coupon_id":{"type":"string"},"coupon_subtitle":{"type":"string"},"coupon_title":{"type":"string"},"coupon_type":{"type":"string"},"coupon_value":{"type":"number","format":"float"},"discount":{"type":"number","format":"float"},"is_applied":{"type":"boolean"},"is_valid":{"type":"boolean"},"maximum_discount_value":{"type":"number","format":"float"},"message":{"type":"string"},"minimum_cart_value":{"type":"number","format":"float"}}},"ChargesThreshold":{"type":"object","properties":{"charges":{"type":"number","format":"float"},"threshold":{"type":"number","format":"float"}}},"DeliveryChargesConfig":{"type":"object","properties":{"enabled":{"type":"boolean"},"charges":{"type":"array","items":{"$ref":"#/components/schemas/ChargesThreshold"}}}},"CartCommonConfig":{"type":"object","properties":{"delivery_charges_config":{"$ref":"#/components/schemas/DeliveryChargesConfig"}}},"CartDetailResponse":{"type":"object","properties":{"cart_id":{"type":"integer","format":"int32"},"uid":{"type":"string"},"coupon_text":{"type":"string"},"id":{"type":"string"},"pan_config":{"type":"object"},"delivery_promise":{"$ref":"#/components/schemas/ShipmentPromise"},"comment":{"type":"string"},"items":{"type":"array","items":{"$ref":"#/components/schemas/CartProductInfo"}},"payment_selection_lock":{"$ref":"#/components/schemas/PaymentSelectionLock"},"delivery_charge_info":{"type":"string"},"common_config":{"$ref":"#/components/schemas/CartCommonConfig"},"coupon":{"$ref":"#/components/schemas/CartDetailCoupon"},"restrict_checkout":{"type":"boolean"},"message":{"type":"string"},"notification":{"type":"object"},"staff_user_id":{"type":"string"},"success":{"type":"boolean"},"breakup_values":{"$ref":"#/components/schemas/CartBreakup"},"is_valid":{"type":"boolean"},"currency":{"$ref":"#/components/schemas/CartCurrency"},"checkout_mode":{"type":"string"},"last_modified":{"type":"string","format":"date"},"buy_now":{"type":"boolean"},"gstin":{"type":"string"},"applied_promo_details":{"type":"array","items":{"$ref":"#/components/schemas/AppliedPromotion"}},"pan_no":{"type":"string"}}},"AddProductCart":{"type":"object","properties":{"quantity":{"type":"integer","format":"int32"},"item_size":{"type":"string"},"seller_id":{"type":"integer","format":"int32"},"parent_item_identifiers":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"}}},"product_group_tags":{"type":"array","items":{"type":"string","nullable":true}},"article_id":{"type":"string"},"article_assignment":{"type":"object"},"store_id":{"type":"integer","format":"int32"},"display":{"type":"string"},"item_id":{"type":"integer","format":"int32"},"extra_meta":{"type":"object"},"_custom_json":{"type":"object"},"meta":{"type":"object"},"pos":{"type":"boolean"},"seller_identifier":{"type":"string","description":"Add items using seller identifier for store os"}}},"AddCartRequest":{"type":"object","properties":{"new_cart":{"type":"boolean"},"items":{"type":"array","items":{"$ref":"#/components/schemas/AddProductCart"}}}},"AddCartDetailResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"True if all items are added successfully. False if partially added or not added."},"cart":{"$ref":"#/components/schemas/CartDetailResponse"},"partial":{"type":"boolean","description":"When adding multiple items check if all added. True if only few are added."},"message":{"type":"string"}}},"UpdateProductCart":{"type":"object","properties":{"quantity":{"type":"integer","format":"int32"},"item_size":{"type":"string"},"parent_item_identifiers":{"type":"object"},"meta":{"type":"object"},"extra_meta":{"type":"object"},"_custom_json":{"type":"object"},"item_id":{"type":"integer","format":"int32"},"item_index":{"type":"integer","format":"int32"},"identifiers":{"$ref":"#/components/schemas/CartProductIdentifer"},"article_id":{"type":"string"}},"required":["identifiers"]},"UpdateCartRequest":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/UpdateProductCart"}},"operation":{"type":"string","enum":["update_item","remove_item"]}},"required":["operation"]},"UpdateCartDetailResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"True if all items are added successfully. False if partially added or not added."},"cart":{"$ref":"#/components/schemas/CartDetailResponse"},"message":{"type":"string"}}},"OverrideCartItemPromo":{"type":"object","properties":{"promo_id":{"type":"string"},"promo_amount":{"type":"string"},"promo_desc":{"type":"string"},"rwrd_tndr":{"type":"string"},"item_list":{"type":"array","items":{"type":"object","nullable":true}},"parent_promo_id":{"type":"string"}},"required":["promo_amount","promo_id"]},"OverrideCartItem":{"type":"object","properties":{"seller_identifier":{"type":"string"},"quantity":{"type":"integer","format":"int32","default":1},"size":{"type":"string"},"price_marked":{"type":"number","format":"float","minimum":0.01},"amount_paid":{"type":"number","format":"float","minimum":0.01},"promo_list":{"type":"array","items":{"$ref":"#/components/schemas/OverrideCartItemPromo"}},"extra_meta":{"type":"object"},"item_id":{"type":"integer","format":"int32"},"discount":{"type":"number","format":"float"},"price_effective":{"type":"number","format":"float","minimum":0.01}},"required":["amount_paid","discount","item_id","price_effective","price_marked","size"]},"OverrideCheckoutReq":{"type":"object","properties":{"cart_id":{"type":"string"},"payment_mode":{"type":"string"},"billing_address":{"type":"object"},"merchant_code":{"type":"string"},"payment_identifier":{"type":"string","nullable":true},"currency_code":{"type":"string"},"aggregator":{"type":"string"},"order_type":{"type":"string"},"cart_items":{"type":"array","items":{"$ref":"#/components/schemas/OverrideCartItem"}},"ordering_store":{"type":"integer","format":"int32","default":null,"nullable":true},"shipping_address":{"type":"object"}},"required":["aggregator","cart_id","cart_items","currency_code","merchant_code","order_type","payment_identifier","payment_mode"]},"OverrideCheckoutResponse":{"type":"object","properties":{"data":{"type":"object"},"cart":{"type":"object"},"success":{"type":"string"},"order_id":{"type":"string"},"message":{"type":"string"}},"required":["cart","data","message","order_id","success"]},"GetShareCartLinkRequest":{"type":"object","properties":{"id":{"type":"string","description":"Cart uid for generating sharing"},"meta":{"type":"object","description":"Staff, Ordering store or any other data. This data will be used to generate link as well as sent as shared details."}}},"GetShareCartLinkResponse":{"type":"object","properties":{"token":{"type":"string","description":"Short url unique id"},"share_url":{"type":"string","description":"Short shareable final url"}}},"SharedCartDetails":{"type":"object","properties":{"source":{"type":"object","description":"Share link device and other source information"},"user":{"type":"object","description":"User details of who generated share link"},"token":{"type":"string","description":"Short link id"},"created_on":{"type":"string","format":"date-time"},"meta":{"type":"object","description":"Meta data sent while generating share cart link"}}},"SharedCart":{"type":"object","properties":{"coupon_text":{"type":"string"},"id":{"type":"string"},"delivery_promise":{"$ref":"#/components/schemas/ShipmentPromise"},"comment":{"type":"string"},"items":{"type":"array","items":{"$ref":"#/components/schemas/CartProductInfo"}},"shared_cart_details":{"$ref":"#/components/schemas/SharedCartDetails"},"payment_selection_lock":{"$ref":"#/components/schemas/PaymentSelectionLock"},"delivery_charge_info":{"type":"string"},"restrict_checkout":{"type":"boolean"},"message":{"type":"string"},"breakup_values":{"$ref":"#/components/schemas/CartBreakup"},"is_valid":{"type":"boolean"},"uid":{"type":"string"},"checkout_mode":{"type":"string"},"currency":{"$ref":"#/components/schemas/CartCurrency"},"last_modified":{"type":"string","format":"date"},"buy_now":{"type":"boolean"},"cart_id":{"type":"integer","format":"int32"},"gstin":{"type":"string"}}},"SharedCartResponse":{"type":"object","properties":{"cart":{"$ref":"#/components/schemas/SharedCart"},"error":{"type":"string"}}},"CartList":{"type":"object","properties":{"cart_id":{"type":"string","readOnly":true},"pick_up_customer_details":{"type":"object","readOnly":true},"cart_value":{"type":"number","readOnly":true,"format":"float"},"created_on":{"type":"string","readOnly":true},"user_id":{"type":"string","readOnly":true},"currency_code":{"type":"string","readOnly":true},"item_counts":{"type":"integer","readOnly":true}}},"MultiCartResponse":{"type":"object","properties":{"success":{"type":"boolean"},"data":{"type":"array","items":{"$ref":"#/components/schemas/CartList"}}}},"UpdateUserCartMapping":{"type":"object","properties":{"user_id":{"type":"string"}},"required":["user_id"]},"UserInfo":{"type":"object","properties":{"user_id":{"type":"string"},"user_type":{"type":"string"},"primary_email":{"type":"string"},"gender":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"primary_mobile_number":{"type":"string"}},"required":["first_name","primary_email","primary_mobile_number"]},"UserCartMappingResponse":{"type":"object","properties":{"coupon_text":{"type":"string"},"user":{"$ref":"#/components/schemas/UserInfo"},"id":{"type":"string"},"pan_config":{"type":"object"},"delivery_promise":{"$ref":"#/components/schemas/ShipmentPromise"},"comment":{"type":"string"},"items":{"type":"array","items":{"$ref":"#/components/schemas/CartProductInfo"}},"payment_selection_lock":{"$ref":"#/components/schemas/PaymentSelectionLock"},"delivery_charge_info":{"type":"string"},"restrict_checkout":{"type":"boolean"},"message":{"type":"string"},"breakup_values":{"$ref":"#/components/schemas/CartBreakup"},"is_valid":{"type":"boolean"},"currency":{"$ref":"#/components/schemas/CartCurrency"},"checkout_mode":{"type":"string"},"last_modified":{"type":"string","format":"date"},"buy_now":{"type":"boolean"},"gstin":{"type":"string"},"applied_promo_details":{"type":"array","items":{"$ref":"#/components/schemas/AppliedPromotion"}},"pan_no":{"type":"string"}}},"PlatformAddCartRequest":{"type":"object","properties":{"user_id":{"type":"string"},"new_cart":{"type":"boolean"},"items":{"type":"array","items":{"$ref":"#/components/schemas/AddProductCart"}}}},"PlatformUpdateCartRequest":{"type":"object","properties":{"user_id":{"type":"string"},"items":{"type":"array","items":{"$ref":"#/components/schemas/UpdateProductCart"}},"operation":{"type":"string","enum":["update_item","remove_item"]}},"required":["operation"]},"DeleteCartRequest":{"type":"object","properties":{"cart_id_list":{"type":"array","items":{"type":"string"}}}},"DeleteCartDetailResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"True if cart is archived successfully. False if not archived."},"message":{"type":"string"}}},"CartItemCountResponse":{"type":"object","properties":{"user_cart_items_count":{"type":"integer","format":"int32","description":"Item count present in cart"}}},"Coupon":{"type":"object","properties":{"title":{"type":"string"},"max_discount_value":{"type":"number","format":"float"},"coupon_code":{"type":"string"},"is_applied":{"type":"boolean"},"coupon_type":{"type":"string","nullable":true},"expires_on":{"type":"string"},"coupon_value":{"type":"number","format":"float"},"sub_title":{"type":"string"},"minimum_cart_value":{"type":"number","format":"float"},"is_applicable":{"type":"boolean"},"message":{"type":"string"},"description":{"type":"string","nullable":true},"start_date":{"type":"string","nullable":true},"end_date":{"type":"string","nullable":true},"coupon_applicable_message":{"type":"string"}}},"PageCoupon":{"type":"object","properties":{"has_next":{"type":"boolean"},"current":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int32"},"total_item_count":{"type":"integer","format":"int32"},"has_previous":{"type":"boolean"}}},"GetCouponResponse":{"type":"object","properties":{"available_coupon_list":{"type":"array","items":{"$ref":"#/components/schemas/Coupon"}},"page":{"$ref":"#/components/schemas/PageCoupon"}}},"ApplyCouponRequest":{"type":"object","properties":{"coupon_code":{"type":"string","description":"Coupon code to be applied"}},"required":["coupon_code"]},"GeoLocation":{"type":"object","properties":{"longitude":{"type":"number","format":"float","default":0},"latitude":{"type":"number","format":"float","default":0}}},"PlatformAddress":{"type":"object","properties":{"phone":{"type":"string"},"id":{"type":"string"},"area_code_slug":{"type":"string"},"country_code":{"type":"string"},"geo_location":{"$ref":"#/components/schemas/GeoLocation"},"country":{"type":"string"},"state":{"type":"string"},"is_default_address":{"type":"boolean"},"tags":{"type":"array","items":{"type":"string"}},"created_by_user_id":{"type":"string"},"landmark":{"type":"string"},"email":{"type":"string"},"area_code":{"type":"string"},"checkout_mode":{"type":"string"},"meta":{"type":"object"},"is_active":{"type":"boolean"},"name":{"type":"string"},"google_map_point":{"type":"object"},"cart_id":{"type":"string"},"city":{"type":"string"},"sector":{"type":"string"},"state_code":{"type":"string","description":"State code for international address"},"area":{"type":"string"},"user_id":{"type":"string"},"address_type":{"type":"string"},"address":{"type":"string"},"country_phone_code":{"type":"string"},"country_iso_code":{"type":"string"},"_custom_json":{"type":"object"}}},"PlatformGetAddressesResponse":{"type":"object","properties":{"address":{"type":"array","items":{"$ref":"#/components/schemas/PlatformAddress"}}}},"SaveAddressResponse":{"type":"object","properties":{"id":{"type":"string"},"success":{"type":"boolean"},"is_default_address":{"type":"boolean"}}},"UpdateAddressResponse":{"type":"object","properties":{"id":{"type":"string"},"is_default_address":{"type":"boolean"},"success":{"type":"boolean"},"is_updated":{"type":"boolean"}}},"DeleteAddressResponse":{"type":"object","properties":{"id":{"type":"string"},"is_deleted":{"type":"boolean"}}},"PlatformSelectCartAddressRequest":{"type":"object","properties":{"cart_id":{"type":"string"},"billing_address_id":{"type":"string"},"checkout_mode":{"type":"string"},"id":{"type":"string"},"user_id":{"type":"string"}}},"ShipmentArticle":{"type":"object","properties":{"meta":{"type":"string"},"quantity":{"type":"string"},"article_id":{"type":"string"}}},"PlatformShipmentResponse":{"type":"object","properties":{"shipments":{"type":"integer","format":"int32","default":1},"fulfillment_id":{"type":"integer","format":"int32"},"items":{"type":"array","items":{"$ref":"#/components/schemas/CartProductInfo"}},"dp_options":{"type":"object","default":null,"nullable":true},"shipment_type":{"type":"string"},"order_type":{"type":"string"},"box_type":{"type":"string","default":null,"nullable":true},"promise":{"$ref":"#/components/schemas/ShipmentPromise"},"dp_id":{"type":"string","default":null,"nullable":true},"fulfillment_type":{"type":"string"},"articles":{"type":"array","items":{"$ref":"#/components/schemas/ShipmentArticle"}}}},"PlatformCartShipmentsResponse":{"type":"object","properties":{"coupon_text":{"type":"string"},"id":{"type":"string"},"pan_config":{"type":"object"},"delivery_promise":{"$ref":"#/components/schemas/ShipmentPromise"},"comment":{"type":"string"},"items":{"type":"array","items":{"$ref":"#/components/schemas/CartProductInfo"}},"payment_selection_lock":{"$ref":"#/components/schemas/PaymentSelectionLock"},"delivery_charge_info":{"type":"string"},"restrict_checkout":{"type":"boolean"},"message":{"type":"string"},"breakup_values":{"$ref":"#/components/schemas/CartBreakup"},"staff_user_id":{"type":"string","nullable":true},"is_valid":{"type":"boolean"},"shipments":{"type":"array","items":{"$ref":"#/components/schemas/PlatformShipmentResponse"}},"currency":{"$ref":"#/components/schemas/CartCurrency"},"checkout_mode":{"type":"string"},"last_modified":{"type":"string","format":"date"},"buy_now":{"type":"boolean"},"gstin":{"type":"string"},"applied_promo_details":{"type":"array","items":{"$ref":"#/components/schemas/AppliedPromotion"}},"error":{"type":"boolean"},"pan_no":{"type":"string"}}},"UpdateCartShipmentItem":{"type":"object","properties":{"quantity":{"type":"integer","format":"int32","description":"Quantity of product in shipment"},"shipment_type":{"type":"string","description":"Shipment delivery type"},"article_uid":{"type":"string","description":"Article mongo id"}},"required":["article_uid","shipment_type"]},"UpdateCartShipmentRequest":{"type":"object","properties":{"shipments":{"type":"array","items":{"$ref":"#/components/schemas/UpdateCartShipmentItem"}}},"required":["shipments"]},"PlatformCartMetaRequest":{"type":"object","properties":{"gstin":{"type":"string"},"pick_up_customer_details":{"type":"object","description":"Customer contact details for customer pickup at store"},"checkout_mode":{"type":"string"},"gift_details":{"type":"object","nullable":true},"pan_no":{"type":"string"},"comment":{"type":"string"},"staff_user_id":{"type":"string","nullable":true,"description":"staff user id"}}},"CartMetaResponse":{"type":"object","properties":{"is_valid":{"type":"boolean"},"message":{"type":"string"}}},"CartMetaMissingResponse":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}},"StaffCheckout":{"type":"object","properties":{"employee_code":{"type":"string"},"_id":{"type":"string"},"user":{"type":"string"},"last_name":{"type":"string"},"first_name":{"type":"string"}},"required":["_id","first_name","last_name","user"]},"CustomerDetails":{"type":"object","properties":{"name":{"type":"string"},"email":{"type":"string","nullable":true},"mobile":{"type":"string"}},"required":["mobile"]},"Files":{"type":"object","properties":{"key":{"type":"string"},"values":{"type":"array","items":{"type":"string"}}},"required":["key","values"]},"CartCheckoutCustomMeta":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"]},"PlatformCartCheckoutDetailRequest":{"type":"object","properties":{"custom_meta":{"type":"array","items":{"$ref":"#/components/schemas/CartCheckoutCustomMeta"}},"address_id":{"type":"string"},"payment_identifier":{"type":"string","nullable":true},"payment_params":{"type":"object","nullable":true},"payment_auto_confirm":{"type":"boolean"},"id":{"type":"string"},"pos":{"type":"boolean"},"billing_address_id":{"type":"string"},"merchant_code":{"type":"string"},"aggregator":{"type":"string"},"pick_at_store_uid":{"type":"integer","format":"int32","default":null,"nullable":true},"device_id":{"type":"string","nullable":true},"delivery_address":{"type":"object"},"payment_mode":{"type":"string"},"checkout_mode":{"type":"string"},"customer_details":{"type":"object","nullable":true,"description":"Customer details","allOf":[{"$ref":"#/components/schemas/CustomerDetails"}]},"meta":{"type":"object"},"staff":{"$ref":"#/components/schemas/StaffCheckout"},"employee_code":{"type":"string","nullable":true},"billing_address":{"type":"object"},"callback_url":{"type":"string","default":null,"nullable":true},"user_id":{"type":"string","nullable":true},"extra_meta":{"type":"object"},"order_type":{"type":"string"},"files":{"type":"array","description":"List of file url","items":{"$ref":"#/components/schemas/Files"}},"ordering_store":{"type":"integer","format":"int32","nullable":true},"payment_extra_identifiers":{"type":"object"}},"required":["id","order_type","payment_mode","user_id"]},"CheckCart":{"type":"object","properties":{"coupon_text":{"type":"string"},"cod_message":{"type":"string"},"id":{"type":"string"},"store_code":{"type":"string"},"delivery_promise":{"$ref":"#/components/schemas/ShipmentPromise"},"comment":{"type":"string"},"user_type":{"type":"string"},"items":{"type":"array","items":{"$ref":"#/components/schemas/CartProductInfo"}},"error_message":{"type":"string"},"success":{"type":"boolean"},"payment_selection_lock":{"$ref":"#/components/schemas/PaymentSelectionLock"},"delivery_charge_info":{"type":"string"},"restrict_checkout":{"type":"boolean"},"order_id":{"type":"string"},"message":{"type":"string"},"breakup_values":{"$ref":"#/components/schemas/CartBreakup"},"cod_charges":{"type":"number","format":"float"},"is_valid":{"type":"boolean"},"uid":{"type":"string"},"checkout_mode":{"type":"string"},"currency":{"$ref":"#/components/schemas/CartCurrency"},"last_modified":{"type":"string","format":"date"},"buy_now":{"type":"boolean"},"delivery_charge_order_value":{"type":"integer","format":"int32"},"cart_id":{"type":"integer","format":"int32"},"store_emps":{"type":"array","items":{"type":"object"}},"gstin":{"type":"string"},"cod_available":{"type":"boolean"},"delivery_charges":{"type":"number","format":"float"}}},"CartCheckoutResponse":{"type":"object","properties":{"app_intercept_url":{"type":"string"},"data":{"type":"object"},"cart":{"$ref":"#/components/schemas/CheckCart"},"success":{"type":"boolean"},"callback_url":{"type":"string"},"payment_confirm_url":{"type":"string"},"order_id":{"type":"string"},"message":{"type":"string"}}},"CartDeliveryModesResponse":{"type":"object","properties":{"pickup_stores":{"type":"array","description":"Store pick up available store uids","items":{"type":"integer","format":"int32"}},"available_modes":{"type":"array","description":"Available delivery modes","items":{"type":"string"}}}},"PickupStoreDetail":{"type":"object","properties":{"country":{"type":"string"},"state":{"type":"string"},"city":{"type":"string"},"phone":{"type":"string"},"area_code":{"type":"string"},"uid":{"type":"integer","format":"int32"},"area_code_slug":{"type":"string"},"address_type":{"type":"string"},"area":{"type":"string"},"id":{"type":"integer","format":"int32"},"store_manager_name":{"type":"string"},"name":{"type":"string"},"store_code":{"type":"string"},"landmark":{"type":"string"},"email":{"type":"string"},"pincode":{"type":"integer","format":"int32"},"address":{"type":"string"}}},"StoreDetailsResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PickupStoreDetail"}}}},"UpdateCartPaymentRequest":{"type":"object","properties":{"address_id":{"type":"string"},"payment_mode":{"type":"string"},"aggregator_name":{"type":"string"},"merchant_code":{"type":"string"},"payment_identifier":{"type":"string","nullable":true},"id":{"type":"string"}}},"CouponValidity":{"type":"object","properties":{"title":{"type":"string"},"next_validation_required":{"type":"boolean","nullable":true},"valid":{"type":"boolean"},"display_message_en":{"type":"string","nullable":true},"code":{"type":"string","nullable":true},"discount":{"type":"number","format":"float"}}},"PaymentCouponValidate":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"},"coupon_validity":{"$ref":"#/components/schemas/CouponValidity"}},"required":["success"]},"PaymentMeta":{"type":"object","properties":{"payment_gateway":{"type":"string"},"type":{"type":"string"},"payment_identifier":{"type":"string","nullable":true},"merchant_code":{"type":"string"}}},"PaymentMethod":{"type":"object","properties":{"collect_by":{"type":"string"},"mode":{"type":"string"},"refund_by":{"type":"string"},"name":{"type":"string"},"amount":{"type":"number","format":"float"},"meta":{"type":"object","default":{}},"transaction_data":{"type":"object","default":{}}},"required":["amount","collect_by","mode","name","refund_by"]},"PlatformCartCheckoutDetailV2Request":{"type":"object","properties":{"address_id":{"type":"string"},"payment_identifier":{"type":"string","nullable":true},"payment_params":{"type":"object","nullable":true},"custom_meta":{"type":"object"},"payment_auto_confirm":{"type":"boolean"},"id":{"type":"string"},"pos":{"type":"boolean"},"billing_address_id":{"type":"string"},"merchant_code":{"type":"string"},"aggregator":{"type":"string"},"pick_at_store_uid":{"type":"integer","format":"int32","default":null,"nullable":true},"device_id":{"type":"string","nullable":true},"delivery_address":{"type":"object"},"payment_mode":{"type":"string"},"checkout_mode":{"type":"string"},"customer_details":{"type":"object","nullable":true,"description":"Customer details","allOf":[{"$ref":"#/components/schemas/CustomerDetails"}]},"meta":{"type":"object"},"payment_methods":{"type":"array","items":{"$ref":"#/components/schemas/PaymentMethod"}},"staff":{"$ref":"#/components/schemas/StaffCheckout"},"employee_code":{"type":"string","nullable":true},"billing_address":{"type":"object"},"callback_url":{"type":"string","default":null,"nullable":true},"user_id":{"type":"string","nullable":true},"extra_meta":{"type":"object"},"order_type":{"type":"string"},"files":{"type":"array","description":"List of file url","items":{"$ref":"#/components/schemas/Files"}},"ordering_store":{"type":"integer","format":"int32","nullable":true}},"required":["id","order_type","payment_methods","user_id"]},"UpdateCartPaymentRequestV2":{"type":"object","properties":{"address_id":{"type":"string"},"payment_mode":{"type":"string"},"aggregator_name":{"type":"string"},"merchant_code":{"type":"string"},"payment_identifier":{"type":"string","nullable":true},"id":{"type":"string"},"payment_methods":{"type":"array","items":{"$ref":"#/components/schemas/PaymentMethod"}}}},"Action":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/ActionPage"},"popup":{"$ref":"#/components/schemas/ActionPage"},"type":{"type":"string"}}},"ActionPage":{"type":"object","properties":{"params":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"query":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"url":{"type":"string"},"type":{"type":"string"}}},"AllSizes":{"properties":{"identifiers":{"items":{"$ref":"#/components/schemas/ValidateIdentifier"},"type":"array"},"item_dimensions_unit_of_measure":{"type":"string"},"item_height":{"type":"number"},"item_length":{"type":"number"},"item_weight":{"type":"number"},"item_weight_unit_of_measure":{"type":"string"},"item_width":{"type":"number"},"size":{"type":"string"}},"required":["item_dimensions_unit_of_measure","item_height","item_length","item_weight","item_weight_unit_of_measure","item_width","size"],"type":"object"},"AllowSingleRequest":{"properties":{"allow_single":{"type":"boolean"}},"required":["allow_single"],"type":"object"},"AppCatalogConfiguration":{"properties":{"app_id":{"type":"string"},"config_id":{"type":"string"},"config_type":{"type":"string"},"created_by":{"type":"object"},"created_on":{"format":"date-time","type":"string"},"id":{"type":"string"},"listing":{"$ref":"#/components/schemas/ConfigurationListing"},"modified_by":{"type":"object"},"modified_on":{"format":"date-time","type":"string"},"product":{"$ref":"#/components/schemas/ConfigurationProduct"},"type":{"type":"string"}},"required":["app_id","config_type"],"type":"object"},"AppCategoryReturnConfig":{"properties":{"category_id":{"description":"Unique identifier for L3 category","type":"integer"},"return_config":{"allOf":[{"$ref":"#/components/schemas/ProductReturnConfigBaseSerializer"}],"description":"Return configuration details"}},"required":["category_id","return_config"],"type":"object"},"AppCategoryReturnConfigResponse":{"properties":{"app_id":{"description":"Channel identifier","type":"string"},"category_id":{"description":"Unique identifer of L3 category","type":"integer"},"logo":{"type":"string"},"name":{"description":"Name of L3 category","type":"string"},"return_config":{"$ref":"#/components/schemas/ProductReturnConfigBaseSerializer"}},"type":"object"},"AppConfiguration":{"properties":{"app_id":{"type":"string"},"config_id":{"type":"string"},"config_type":{"type":"string"},"created_by":{"type":"object"},"created_on":{"format":"date-time","type":"string"},"listing":{"$ref":"#/components/schemas/ConfigurationListing"},"modified_by":{"type":"object"},"modified_on":{"format":"date-time","type":"string"},"product":{"$ref":"#/components/schemas/ConfigurationProduct"},"type":{"type":"string"}},"required":["app_id","config_type"],"type":"object"},"AppConfigurationDetail":{"properties":{"app_id":{"type":"string"},"attributes":{"items":{"$ref":"#/components/schemas/AttributeDetailsGroup"},"minItems":1,"type":"array"},"is_active":{"type":"boolean"},"is_default":{"type":"boolean"},"logo":{"format":"url","type":"string"},"name":{"type":"string"},"priority":{"minimum":1,"type":"integer"},"slug":{"type":"string"},"template_slugs":{"items":{"type":"string"},"type":"array"}},"required":["app_id","is_active","is_default","priority","slug"],"type":"object"},"AppConfigurationsSort":{"properties":{"app_id":{"type":"string"},"default_key":{"type":"string"},"is_active":{"type":"boolean"},"is_default":{"type":"boolean"},"key":{"type":"string"},"logo":{"format":"url","type":"string"},"name":{"type":"string"},"priority":{"minimum":1,"type":"integer"}},"required":["app_id","default_key","is_active","is_default","key","priority"],"type":"object"},"ApplicationBrandJson":{"properties":{"_custom_json":{"type":"object"}},"required":["_custom_json"],"type":"object"},"ApplicationCategoryJson":{"properties":{"_custom_json":{"type":"object"}},"required":["_custom_json"],"type":"object"},"ApplicationDepartment":{"properties":{"_custom_json":{"type":"object"},"app_id":{"type":"string"},"is_active":{"type":"boolean"},"logo":{"type":"string"},"name":{"type":"string"},"uid":{"type":"integer"}},"required":["app_id","uid"],"type":"object"},"ApplicationDepartmentJson":{"properties":{"_custom_json":{"type":"object"}},"required":["_custom_json"],"type":"object"},"ApplicationDepartmentListingResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/ApplicationDepartment"},"type":"array"},"page":{"$ref":"#/components/schemas/Page"}},"required":["page"],"type":"object"},"ApplicationItemMOQ":{"properties":{"increment_unit":{"default":1,"description":"The minimum quantity increment in which the item can be purchased.","minimum":1,"type":"integer"},"maximum":{"description":"The maximum quantity allowed for purchase.","type":"integer"},"minimum":{"default":1,"description":"The minimum quantity required for purchase.","minimum":1,"type":"integer"}},"type":"object"},"ApplicationItemMeta":{"properties":{"_custom_json":{"description":"Custom JSON data for the item","type":"object"},"_custom_meta":{"description":"Custom meta fields for the item","items":{"$ref":"#/components/schemas/MetaFields"},"type":"array"},"alt_text":{"description":"Alternative text for the item's images","type":"object"},"is_cod":{"description":"Whether the item is available for Cash on Delivery (COD) or not","type":"boolean"},"is_gift":{"description":"Whether the item is a gift or not","type":"boolean"},"moq":{"allOf":[{"$ref":"#/components/schemas/ApplicationItemMOQ"}],"description":"Minimum Order Quantity information for the item"},"seo":{"allOf":[{"$ref":"#/components/schemas/ApplicationItemSEO"}],"description":"Search Engine Optimization information for the item"},"size_promotion_threshold":{"allOf":[{"$ref":"#/components/schemas/SizePromotionThreshold"}],"description":"Size level promotion limitation information for item"}},"type":"object"},"ApplicationItemSEO":{"properties":{"description":{"description":"The SEO description of the item","type":"string"},"title":{"description":"The SEO title of the item","type":"string"}},"type":"object"},"ApplicationProductListingResponse":{"properties":{"filters":{"items":{"$ref":"#/components/schemas/ProductFilters"},"type":"array"},"items":{"items":{"$ref":"#/components/schemas/ProductListingDetail"},"type":"array"},"operators":{"type":"object"},"page":{"$ref":"#/components/schemas/Page"},"sort_on":{"items":{"$ref":"#/components/schemas/ProductSortOn"},"type":"array"}},"required":["page"],"type":"object"},"ApplicationStoreJson":{"properties":{"_custom_json":{"type":"object"}},"required":["_custom_json"],"type":"object"},"AppReturnConfigResponse":{"properties":{"app_id":{"description":"Channel identifier","type":"string"},"category_count":{"description":"Count of L3 category return config set for application","type":"integer"},"company_id":{"description":"Unique identifer of company","type":"integer"},"created_by":{"description":"User details","type":"object"},"modified_by":{"description":"User details","type":"object"},"modified_on":{"description":"Modification date","format":"date-time","type":"string"},"return_config_level":{"description":"configuration level of return window category|product|no-return","type":"string"}},"type":"object"},"ArticleAssignment":{"properties":{"level":{"type":"string"},"strategy":{"type":"string"}},"type":"object"},"ArticleAssignment1":{"properties":{"level":{"type":"string"},"strategy":{"type":"string"}},"type":"object"},"ArticleQuery":{"properties":{"ignored_stores":{"items":{"type":"integer"},"type":"array"},"item_id":{"type":"integer"},"size":{"type":"string"}},"required":["item_id","size"],"type":"object"},"ArticleStoreResponse":{"properties":{"name":{"type":"string"},"store_code":{"type":"string"},"store_type":{"type":"string"},"uid":{"type":"integer"}},"type":"object"},"AssignStore":{"properties":{"app_id":{"type":"string"},"articles":{"items":{"$ref":"#/components/schemas/AssignStoreArticle"},"type":"array"},"channel_identifier":{"type":"string"},"channel_type":{"type":"string"},"company_id":{"type":"integer"},"pincode":{"type":"string"},"store_ids":{"items":{"type":"integer"},"type":"array"}},"required":["app_id","articles","pincode"],"type":"object"},"AssignStoreArticle":{"properties":{"article_assignment":{"$ref":"#/components/schemas/ArticleAssignment"},"group_id":{"type":"string"},"meta":{"type":"object"},"quantity":{"default":1,"type":"integer"},"query":{"$ref":"#/components/schemas/ArticleQuery"}},"type":"object"},"AttributeDetailsGroup":{"properties":{"display_type":{"type":"string"},"is_active":{"type":"boolean"},"key":{"type":"string"},"logo":{"format":"url","type":"string"},"name":{"type":"string"},"priority":{"minimum":1,"type":"integer"},"slug":{"type":"string"},"unit":{"type":"string"}},"required":["display_type","is_active","name","priority"],"type":"object"},"AttributeMaster":{"properties":{"allowed_values":{"items":{"type":"string"},"type":"array"},"format":{"type":"string"},"mandatory":{"type":"boolean"},"multi":{"type":"boolean"},"range":{"$ref":"#/components/schemas/AttributeSchemaRange"},"type":{"enum":["str","int","bool","float"],"type":"string"}},"required":["type"],"type":"object"},"AttributeMasterDetails":{"properties":{"display_type":{"type":"string"}},"required":["display_type"],"type":"object"},"AttributeMasterFilter":{"properties":{"depends_on":{"items":{"type":"string"},"type":"array"},"indexing":{"type":"boolean"},"priority":{"type":"integer"}},"required":["indexing"],"type":"object"},"AttributeMasterMandatoryDetails":{"properties":{"l3_keys":{"items":{"type":"string"},"type":"array"}},"type":"object"},"AttributeMasterMeta":{"properties":{"enriched":{"type":"boolean"},"mandatory_details":{"$ref":"#/components/schemas/AttributeMasterMandatoryDetails"}},"required":["mandatory_details"],"type":"object"},"AttributeMasterSerializer":{"properties":{"created_by":{"type":"object"},"created_on":{"format":"date-time","type":"string"},"departments":{"items":{"type":"string"},"minItems":1,"type":"array"},"description":{"type":"string"},"details":{"$ref":"#/components/schemas/AttributeMasterDetails"},"enabled_for_end_consumer":{"type":"boolean"},"filters":{"$ref":"#/components/schemas/AttributeMasterFilter"},"is_nested":{"type":"boolean"},"logo":{"type":"string"},"modified_by":{"type":"object"},"modified_on":{"format":"date-time","type":"string"},"name":{"type":"string"},"raw_key":{"type":"string"},"schema":{"$ref":"#/components/schemas/AttributeMaster"},"slug":{"type":"string"},"suggestion":{"type":"string"},"synonyms":{"type":"object"},"tags":{"items":{"type":"string"},"type":"array"},"unit":{"type":"string"},"variant":{"default":false,"type":"boolean"}},"required":["departments","details","filters","schema","slug"],"type":"object"},"AttributeSchemaRange":{"properties":{"max":{"type":"integer"},"min":{"type":"integer"}},"type":"object"},"AutoCompleteMedia":{"properties":{"aspect_ratio":{"type":"string"},"type":{"type":"string"},"url":{"format":"url","type":"string"}},"type":"object"},"AutocompleteAction":{"properties":{"page":{"$ref":"#/components/schemas/AutocompletePageAction"},"type":{"type":"string"}},"type":"object"},"AutocompletePageAction":{"properties":{"params":{"type":"object"},"query":{"type":"object"},"type":{"type":"string"},"url":{"type":"string"}},"type":"object"},"AutocompleteResult":{"properties":{"_custom_json":{"default":{},"type":"object"},"action":{"$ref":"#/components/schemas/AutocompleteAction"},"display":{"type":"string"},"logo":{"$ref":"#/components/schemas/AutoCompleteMedia"}},"type":"object"},"BannerImage":{"properties":{"aspect_ratio":{"type":"string"},"type":{"type":"string"},"url":{"format":"url","type":"string"}},"type":"object"},"BaseAppCategoryReturnConfig":{"properties":{"app_id":{"description":"Channel identifier","type":"string"},"company_id":{"description":"Unique identifer of company","type":"integer"},"data":{"description":"Category level return config details","items":{"$ref":"#/components/schemas/AppCategoryReturnConfig"},"maxItems":50,"type":"array"}},"required":["app_id","company_id","data"],"type":"object"},"BaseAppCategoryReturnConfigResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/AppCategoryReturnConfigResponse"},"type":"array"},"page":{"$ref":"#/components/schemas/PageResponse"}},"type":"object"},"Brand":{"type":"object","properties":{"credit_note_expiry_days":{"type":"integer","nullable":true},"logo":{"type":"string","nullable":true},"invoice_prefix":{"type":"string","nullable":true},"credit_note_allowed":{"type":"boolean","nullable":true},"start_date":{"type":"string","nullable":true},"company":{"type":"string","nullable":true},"is_virtual_invoice":{"type":"boolean","nullable":true},"script_last_ran":{"type":"string","nullable":true},"pickup_location":{"type":"string","nullable":true},"created_on":{"type":"string","nullable":true},"brand_name":{"type":"string"},"brand_id":{"type":"integer"},"modified_on":{"type":"integer","nullable":true},"id":{"type":"integer","nullable":true}},"required":["brand_name"]},"BrandItem":{"properties":{"action":{"$ref":"#/components/schemas/Action"},"banners":{"$ref":"#/components/schemas/ImageUrls"},"departments":{"items":{"type":"string"},"type":"array"},"discount":{"type":"string"},"logo":{"$ref":"#/components/schemas/Media2"},"name":{"type":"string"},"slug":{"type":"string"},"uid":{"type":"integer"}},"type":"object"},"BrandListingResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/BrandItem"},"type":"array"},"page":{"$ref":"#/components/schemas/Page"}},"required":["page"],"type":"object"},"BrandMeta":{"properties":{"id":{"type":"integer"},"name":{"type":"string"}},"required":["id","name"],"type":"object"},"BrandMeta1":{"properties":{"id":{"type":"integer"},"name":{"type":"string"}},"type":"object"},"BulkAssetResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/Items"},"type":"array"},"page":{"$ref":"#/components/schemas/Page"}},"type":"object"},"BulkHsnResponse":{"properties":{"success":{"description":"Flag indicating the success status of the bulk HSN operation.","example":true,"type":"boolean"}},"type":"object"},"BulkHsnUpsert":{"properties":{"data":{"items":{"$ref":"#/components/schemas/HsnUpsert"},"maxItems":50,"minItems":1,"type":"array"}},"required":["data"],"type":"object"},"BulkInventoryGet":{"properties":{"items":{"items":{"$ref":"#/components/schemas/BulkInventoryGetItems"},"type":"array"},"page":{"$ref":"#/components/schemas/Page"}},"type":"object"},"BulkInventoryGetItems":{"properties":{"cancelled":{"type":"integer"},"cancelled_records":{"items":{"type":"string"},"type":"array"},"company_id":{"type":"integer"},"created_by":{"type":"object"},"created_on":{"type":"string"},"failed":{"type":"integer"},"failed_records":{"items":{"type":"string"},"type":"array"},"file_path":{"type":"string"},"id":{"type":"string"},"is_active":{"type":"boolean"},"modified_by":{"type":"object"},"modified_on":{"type":"string"},"stage":{"type":"string"},"succeed":{"type":"integer"},"total":{"type":"integer"}},"type":"object"},"BulkJob":{"properties":{"cancelled":{"default":0,"type":"integer"},"cancelled_records":{"default":[],"items":{"type":"object"},"type":"array"},"company_id":{"type":"integer"},"created_by":{"allOf":[{"$ref":"#/components/schemas/UserInfo1"}],"description":"The user who created the item."},"created_on":{"description":"The date and time when the item was created.","format":"date-time","type":"string"},"custom_template_tag":{"type":"string"},"failed":{"default":0,"type":"integer"},"failed_records":{"default":[],"items":{"type":"object"},"type":"array"},"file_path":{"type":"string"},"is_active":{"default":true,"description":"Whether the item is active or not.","type":"boolean"},"modified_by":{"allOf":[{"$ref":"#/components/schemas/UserInfo1"}],"description":"The user who last modified the item.","nullable":true,"type":"string"},"modified_on":{"default":"2023-08-16T12:07:13.817348","description":"The date and time when the item was last modified.","format":"date-time","type":"string"},"stage":{"default":"pending","enum":["pending","completed","terminated","cancelled","failed","partial","running"],"type":"string"},"succeed":{"default":0,"type":"integer"},"template_tag":{"type":"string"},"total":{"default":0,"type":"integer"},"tracking_url":{"format":"url","type":"string"}},"required":["company_id","created_on"],"type":"object"},"BulkProductRequest":{"properties":{"batch_id":{"type":"string"},"company_id":{"type":"integer"},"data":{"items":{"type":"object"},"type":"array"},"template_tag":{"type":"string"}},"required":["batch_id","company_id","data","template_tag"],"type":"object"},"BulkResponse":{"properties":{"batch_id":{"type":"string"},"created_by":{"allOf":[{"$ref":"#/components/schemas/UserInfo1"}],"description":"The user who created the item."},"created_on":{"description":"The date and time when the item was created.","format":"date-time","type":"string"},"is_active":{"default":true,"description":"Whether the item is active or not.","type":"boolean"},"modified_by":{"allOf":[{"$ref":"#/components/schemas/UserInfo1"}],"description":"The user who last modified the item.","nullable":true,"type":"string"},"modified_on":{"default":"2023-08-16T12:07:13.817348","description":"The date and time when the item was last modified.","format":"date-time","type":"string"}},"required":["batch_id","created_on"],"type":"object"},"CatalogInsightBrand":{"properties":{"article_freshness":{"type":"integer"},"available_articles":{"type":"integer"},"available_sizes":{"type":"integer"},"name":{"type":"string"},"total_articles":{"type":"integer"},"total_sizes":{"type":"integer"}},"type":"object"},"CatalogInsightItem":{"properties":{"count":{"type":"integer"},"out_of_stock_count":{"type":"integer"},"sellable_count":{"type":"integer"}},"type":"object"},"CatalogInsightResponse":{"properties":{"brand_distribution":{"$ref":"#/components/schemas/CatalogInsightBrand"},"item":{"$ref":"#/components/schemas/CatalogInsightItem"}},"type":"object"},"CategoriesResponse":{"properties":{"name":{"type":"string"},"slug":{"type":"string"},"slug_key":{"type":"string"},"template_slug":{"type":"string"},"uid":{"type":"integer"}},"type":"object"},"Category":{"properties":{"created_by":{"description":"It is the details of the user who created the category.","example":{"name":"John","user_id":123},"type":"object"},"created_on":{"description":"It is Date and time when the category was created.","example":"2023-06-08 10:00:00","format":"date-time","type":"string"},"departments":{"description":"It is the list of unique department the category belongs to.","example":[1,2,3],"items":{"type":"integer"},"type":"array"},"hierarchy":{"description":"It is the list of category hierarchies for each department of an L3 category.","items":{"$ref":"#/components/schemas/Hierarchy"},"type":"array"},"id":{"description":"It is the unique identifier of the category.","example":"6268e07eddc74533e1db7e6d","type":"string"},"is_active":{"description":"It is the flag indicating if the category is active.","example":true,"type":"boolean"},"level":{"description":"It is the level of category","example":1,"type":"integer"},"marketplaces":{"allOf":[{"$ref":"#/components/schemas/CategoryMapping"}],"description":"It is the mapping of the category in different marketplaces.","example":{"google":{"catalog_id":123,"name":"Shoes"}}},"media":{"allOf":[{"$ref":"#/components/schemas/Media1"}],"description":"It is the details of the media such as banner and logo..","example":{"landscape":"http://example.com/image.jpg","logo":"http://example.com/image.jpg","portrait":"http://example.com/image.jpg"}},"modified_by":{"description":"It is the details of the user who last modified the category.","example":{"name":"Jane","user_id":456},"type":"object"},"modified_on":{"description":"It is the date and time when the category was last modified.","example":"2023-06-08 11:30:00","format":"date-time","type":"string"},"name":{"description":"It is the name of the category","example":"Men's Shoes","type":"string"},"priority":{"description":"It is the priority of the category.","example":1,"type":"integer"},"slug":{"description":"It is the slug of the category.","example":"mens-shoes","type":"string"},"synonyms":{"description":"It is the list of synonyms.","example":["footwear","shoes"],"items":{"type":"string"},"type":"array"},"tryouts":{"description":"It is the list of tryouts.","example":["option1","option2"],"items":{"type":"string"},"type":"array"},"uid":{"description":"It is the unique identifier of the category.","example":1,"type":"integer"}},"required":["departments","is_active","level","name"],"type":"object"},"CategoryCreateResponse":{"properties":{"message":{"description":"It is the message of the response from the category.","example":"Category created successfully.","type":"string"},"uid":{"description":"It is the unique identifier of the category.","example":1,"type":"integer"}},"type":"object"},"CategoryItems":{"properties":{"action":{"$ref":"#/components/schemas/Action"},"banners":{"$ref":"#/components/schemas/ImageUrls"},"childs":{"items":{"$ref":"#/components/schemas/Child"},"type":"array"},"name":{"type":"string"},"slug":{"type":"string"},"uid":{"type":"integer"}},"type":"object"},"CategoryListingResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/DepartmentCategoryTree"},"type":"array"},"departments":{"items":{"$ref":"#/components/schemas/DepartmentIdentifier"},"type":"array"}},"type":"object"},"CategoryMapping":{"properties":{"ajio":{"allOf":[{"$ref":"#/components/schemas/CategoryMappingValues"}],"description":"It is the category id mapping for ajio platform."},"facebook":{"allOf":[{"$ref":"#/components/schemas/CategoryMappingValues"}],"description":"It is the category id mapping for facebook platform."},"google":{"allOf":[{"$ref":"#/components/schemas/CategoryMappingValues"}],"description":"It is the category id mapping for google platform."}},"type":"object"},"CategoryMappingValues":{"properties":{"catalog_id":{"description":"It is the category id mapping of the respective platform with Fynd Platform.","example":23987,"type":"integer"},"name":{"description":"It is the name of the Category in the respective platform.","example":"","type":"string"}},"required":["name"],"type":"object"},"CategoryRequestBody":{"properties":{"departments":{"description":"It is the list of unique department the category belongs to.","example":[1,2,3],"items":{"type":"integer"},"type":"array"},"hierarchy":{"description":"It is the list of category hierarchies for each department of an L3 category.","items":{"$ref":"#/components/schemas/Hierarchy"},"type":"array"},"is_active":{"description":"It is the flag indicating if the category is active.","example":true,"type":"boolean"},"level":{"description":"It is the level of category","example":1,"type":"integer"},"marketplaces":{"allOf":[{"$ref":"#/components/schemas/CategoryMapping"}],"description":"It is the mapping of the category in different marketplaces.","example":{"google":{"catalog_id":123,"name":"Shoes"}}},"media":{"allOf":[{"$ref":"#/components/schemas/Media1"}],"description":"It is the details of the media such as banner and logo..","example":{"landscape":"http://example.com/image.jpg","logo":"http://example.com/image.jpg","portrait":"http://example.com/image.jpg"}},"name":{"description":"It is the name of the category","example":"Men's Shoes","type":"string"},"priority":{"description":"It is the priority of the category.","example":1,"type":"integer"},"slug":{"description":"It is the slug of the category.","example":"mens-shoes","type":"string"},"synonyms":{"description":"It is the list of synonyms.","example":["footwear","shoes"],"items":{"type":"string"},"type":"array"},"tryouts":{"description":"It is the list of tryouts.","example":["option1","option2"],"items":{"type":"string"},"type":"array"}},"required":["departments","is_active","level","name"],"type":"object"},"CategoryResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/Category"},"type":"array"},"page":{"$ref":"#/components/schemas/Page"}},"type":"object"},"CategoryUpdateResponse":{"properties":{"message":{"description":"It is the message of the response from the category.","example":"Category created successfully.","type":"string"},"success":{"description":"It is the flag indication the success response.","example":true,"type":"boolean"}},"type":"object"},"Child":{"properties":{"_custom_json":{"type":"object"},"action":{"$ref":"#/components/schemas/Action"},"banners":{"$ref":"#/components/schemas/ImageUrls"},"childs":{"items":{"$ref":"#/components/schemas/SecondLevelChild"},"type":"array"},"name":{"type":"string"},"slug":{"type":"string"},"uid":{"type":"integer"}},"type":"object"},"CollectionBadge":{"properties":{"color":{"type":"string"},"text":{"type":"string"}},"type":"object"},"CollectionBanner":{"properties":{"landscape":{"$ref":"#/components/schemas/CollectionImage"},"portrait":{"$ref":"#/components/schemas/CollectionImage"}},"required":["landscape","portrait"],"type":"object"},"CollectionCreateResponse":{"properties":{"uid":{"type":"string"},"_schedule":{"type":"object"},"allow_facets":{"type":"boolean"},"allow_sort":{"type":"boolean"},"app_id":{"type":"string"},"badge":{"type":"object"},"banners":{"$ref":"#/components/schemas/ImageUrls"},"cron":{"type":"object"},"description":{"type":"string"},"is_active":{"type":"boolean"},"logo":{"$ref":"#/components/schemas/BannerImage"},"meta":{"type":"object"},"name":{"type":"string"},"priority":{"type":"integer"},"query":{"items":{"$ref":"#/components/schemas/CollectionQuery"},"type":"array"},"slug":{"type":"string"},"sort_on":{"type":"string"},"tag":{"items":{"type":"string"},"type":"array"},"type":{"type":"string"},"visible_facets_keys":{"items":{"type":"string"},"type":"array"}},"type":"object"},"CollectionDetailResponse":{"properties":{"_schedule":{"type":"object"},"allow_facets":{"type":"boolean"},"allow_sort":{"type":"boolean"},"app_id":{"type":"string"},"badge":{"type":"object"},"banners":{"$ref":"#/components/schemas/ImageUrls"},"cron":{"type":"object"},"description":{"type":"string"},"is_active":{"type":"boolean"},"logo":{"$ref":"#/components/schemas/Media"},"meta":{"type":"object"},"name":{"type":"string"},"priority":{"type":"integer"},"query":{"items":{"$ref":"#/components/schemas/CollectionQuery"},"type":"array"},"slug":{"type":"string"},"tag":{"items":{"type":"string"},"type":"array"},"type":{"type":"string"},"uid":{"type":"string"},"visible_facets_keys":{"items":{"type":"string"},"type":"array"}},"type":"object"},"CollectionImage":{"properties":{"aspect_ratio":{"type":"string"},"url":{"type":"string"}},"required":["aspect_ratio","url"],"type":"object"},"CollectionItem":{"properties":{"action":{"enum":["add","remove"],"type":"string"},"item_id":{"type":"integer"},"priority":{"type":"integer"}},"required":["action","item_id"],"type":"object"},"CollectionItemUpdate":{"properties":{"allow_facets":{"type":"boolean"},"allow_sort":{"type":"boolean"},"items":{"items":{"$ref":"#/components/schemas/CollectionItem"},"type":"array"},"query":{"items":{"$ref":"#/components/schemas/CollectionQuery"},"type":"array"},"type":{"type":"string"},"visible_facets_keys":{"items":{"type":"string"},"type":"array"}},"type":"object"},"CollectionListingFilter":{"properties":{"tags":{"items":{"$ref":"#/components/schemas/CollectionListingFilterTag"},"type":"array"},"type":{"items":{"$ref":"#/components/schemas/CollectionListingFilterType"},"type":"array"}},"type":"object"},"CollectionListingFilterTag":{"properties":{"display":{"type":"string"},"is_selected":{"type":"boolean"},"name":{"type":"string"}},"type":"object"},"CollectionListingFilterType":{"properties":{"display":{"type":"string"},"is_selected":{"type":"boolean"},"name":{"type":"string"}},"type":"object"},"CollectionQuery":{"properties":{"attribute":{"description":"The attribute of the collection query","type":"string"},"op":{"description":"The operation to be performed on the attribute of the collection query","enum":["in","nin","gt","gte","lt","lte","btw"],"type":"string"},"value":{"description":"The value of the attribute of the collection query","items":{},"type":"array"}},"required":["attribute","op","value"],"type":"object"},"CollectionSchedule":{"properties":{"cron":{"nullable":true,"type":"string"},"duration":{"nullable":true,"type":"integer"},"end":{"format":"date-time","nullable":true,"type":"string"},"next_schedule":{"items":{"$ref":"#/components/schemas/NextSchedule"},"type":"array"},"start":{"format":"date-time","type":"string"}},"type":"object"},"CompanyBrandDetail":{"properties":{"brand_id":{"type":"integer"},"brand_name":{"type":"string"},"company_id":{"type":"integer"},"total_article":{"type":"integer"}},"type":"object"},"CompanyMeta":{"properties":{"id":{"type":"integer"}},"required":["id"],"type":"object"},"CompanyMeta1":{"properties":{"id":{"type":"integer"}},"type":"object"},"CompanyOptIn":{"properties":{"brand_ids":{"items":{"type":"integer"},"type":"array"},"company_id":{"type":"integer"},"created_by":{"type":"object"},"created_on":{"type":"integer"},"enabled":{"type":"boolean"},"modified_by":{"type":"object"},"modified_on":{"type":"integer"},"opt_level":{"type":"string"},"platform":{"type":"string"},"store_ids":{"items":{"type":"integer"},"type":"array"}},"required":["brand_ids","company_id","created_on","enabled","modified_on","opt_level","platform","store_ids"],"type":"object"},"ConfigErrorResponse":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"ConfigSuccessResponse":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"ConfigurationBucketPoints":{"properties":{"display":{"type":"string"},"end":{"type":"number"},"start":{"type":"number"}},"type":"object"},"ConfigurationListing":{"properties":{"filter":{"$ref":"#/components/schemas/ConfigurationListingFilter"},"sort":{"$ref":"#/components/schemas/ConfigurationListingSort"}},"required":["filter","sort"],"type":"object"},"ConfigurationListingFilter":{"properties":{"allow_single":{"type":"boolean"},"attribute_config":{"items":{"$ref":"#/components/schemas/ConfigurationListingFilterConfig"},"type":"array"}},"required":["allow_single"],"type":"object"},"ConfigurationListingFilterConfig":{"properties":{"display_name":{"type":"string"},"is_active":{"type":"boolean"},"key":{"type":"string"},"logo":{"format":"url","type":"string"},"name":{"type":"string"},"priority":{"minimum":1,"type":"integer"},"type":{"enum":["range","intervals","multivalued","singlevalued"],"type":"string"},"value_config":{"$ref":"#/components/schemas/ConfigurationListingFilterValue"}},"required":["is_active","key","priority","type"],"type":"object"},"ConfigurationListingFilterValue":{"properties":{"bucket_points":{"items":{"$ref":"#/components/schemas/ConfigurationBucketPoints"},"type":"array"},"condition":{"default":"OR","type":"string"},"map":{"type":"object"},"map_values":{"items":{"type":"object"},"type":"array"},"priority":{"items":{"type":"string"},"type":"array"},"sort":{"default":"count","type":"string"},"value":{"type":"string"}},"type":"object"},"ConfigurationListingSort":{"properties":{"config":{"items":{"$ref":"#/components/schemas/ConfigurationListingSortConfig"},"type":"array"},"default_key":{"type":"string"}},"required":["default_key"],"type":"object"},"ConfigurationListingSortConfig":{"properties":{"is_active":{"type":"boolean"},"key":{"type":"string"},"logo":{"format":"url","type":"string"},"name":{"type":"string"},"priority":{"minimum":1,"type":"integer"}},"required":["is_active","key","priority"],"type":"object"},"ConfigurationProduct":{"properties":{"similar":{"$ref":"#/components/schemas/ConfigurationProductSimilar"},"variant":{"$ref":"#/components/schemas/ConfigurationProductVariant"}},"required":["similar","variant"],"type":"object"},"ConfigurationProductConfig":{"properties":{"is_active":{"type":"boolean"},"key":{"type":"string"},"logo":{"format":"url","type":"string"},"priority":{"minimum":1,"type":"integer"},"size":{"$ref":"#/components/schemas/ProductSize"},"subtitle":{"type":"string"},"title":{"type":"string"}},"required":["is_active","key","priority"],"type":"object"},"ConfigurationProductSimilar":{"properties":{"config":{"items":{"$ref":"#/components/schemas/ConfigurationProductConfig"},"type":"array"}},"type":"object"},"ConfigurationProductVariant":{"properties":{"config":{"items":{"$ref":"#/components/schemas/ConfigurationProductVariantConfig"},"type":"array"}},"type":"object"},"ConfigurationProductVariantConfig":{"properties":{"display_type":{"type":"string"},"is_active":{"type":"boolean"},"key":{"type":"string"},"logo":{"format":"url","type":"string"},"name":{"type":"string"},"priority":{"minimum":1,"type":"integer"},"size":{"$ref":"#/components/schemas/ProductSize"}},"required":["display_type","is_active","key","name","priority","size"],"type":"object"},"CreateAutocompleteKeyword":{"properties":{"_custom_json":{"default":{},"type":"object"},"app_id":{"type":"string"},"is_active":{"default":true,"type":"boolean"},"results":{"items":{"$ref":"#/components/schemas/AutocompleteResult"},"type":"array"},"words":{"items":{"type":"string"},"minItems":1,"type":"array"}},"type":"object"},"CreateAutocompleteWordsResponse":{"properties":{"_custom_json":{"type":"object"},"app_id":{"type":"string"},"results":{"items":{"type":"object"},"type":"array"},"words":{"items":{"type":"string"},"type":"array"}},"type":"object"},"CreateCollection":{"properties":{"_custom_json":{"default":{},"type":"object"},"_locale_language":{"default":{},"type":"object"},"_schedule":{"$ref":"#/components/schemas/CollectionSchedule"},"allow_facets":{"default":true,"type":"boolean"},"allow_sort":{"default":true,"type":"boolean"},"app_id":{"type":"string"},"badge":{"$ref":"#/components/schemas/CollectionBadge"},"banners":{"$ref":"#/components/schemas/CollectionBanner"},"created_by":{"allOf":[{"$ref":"#/components/schemas/UserInfo"}],"nullable":true},"description":{"type":"string"},"is_active":{"default":true,"type":"boolean"},"is_visible":{"default":true,"type":"boolean"},"logo":{"$ref":"#/components/schemas/CollectionImage"},"meta":{"default":{},"type":"object"},"modified_by":{"allOf":[{"$ref":"#/components/schemas/UserInfo"}],"nullable":true},"name":{"type":"string"},"priority":{"default":99999,"type":"integer"},"published":{"default":true,"type":"boolean"},"query":{"default":[],"items":{"$ref":"#/components/schemas/CollectionQuery"},"type":"array"},"seo":{"$ref":"#/components/schemas/SeoDetail"},"slug":{"type":"string"},"sort_on":{"default":"popular","type":"string"},"tags":{"items":{"type":"string"},"type":"array"},"type":{"enum":["items","query"],"type":"string"},"visible_facets_keys":{"default":[],"items":{"type":"string"},"type":"array"}},"required":["app_id","banners","logo","name","slug","type"],"type":"object"},"CreateSearchConfigurationRequest":{"properties":{"application_id":{"description":"The application id where custom search configuration is set","type":"string"},"company_id":{"description":"The company id where custom search configuration is set","type":"integer"},"created_by":{"allOf":[{"$ref":"#/components/schemas/UserSerializer"}],"description":"The user who created the search configuration."},"created_on":{"description":"The date and time when the search configuration was created.","example":"2022-03-15T14:56:22.123Z","format":"date-time","type":"string"},"is_proximity_enabled":{"default":false,"description":"Flag indicating if proximity search is enabled for this attribute.","type":"boolean"},"modified_by":{"allOf":[{"$ref":"#/components/schemas/UserSerializer"}],"description":"The user who modified the search configuration."},"modified_on":{"description":"The date and time when the search configuration was last modified.","example":"2022-03-16T09:12:33.456Z","format":"date-time","type":"string"},"proximity":{"default":1,"description":"Proximity distance configuration","type":"integer"},"searchable_attributes":{"description":"The searchable attributes defined on the application.","items":{"$ref":"#/components/schemas/SearchableAttribute"},"type":"array"}},"required":["application_id","company_id"],"type":"object"},"CreateSearchConfigurationResponse":{"properties":{"success":{"type":"boolean"}},"type":"object"},"CreateSearchKeyword":{"properties":{"_custom_json":{"default":{},"type":"object"},"app_id":{"type":"string"},"is_active":{"default":true,"type":"boolean"},"result":{"$ref":"#/components/schemas/SearchKeywordResult"},"words":{"items":{"type":"string"},"minItems":1,"type":"array"}},"required":["result"],"type":"object"},"CreateUpdateAppReturnConfig":{"properties":{"app_id":{"description":"Channel identifier","type":"string"},"company_id":{"description":"Unique identifer of company","type":"integer"},"return_config_level":{"description":"Return configurtion Level category|product|no-return","enum":["product","category","no-return"],"type":"string"}},"required":["app_id","company_id","return_config_level"],"type":"object"},"CrossSellingData":{"properties":{"articles":{"type":"integer"},"products":{"type":"integer"}},"type":"object"},"CrossSellingResponse":{"properties":{"brand_distribution":{"$ref":"#/components/schemas/CatalogInsightBrand"},"data":{"$ref":"#/components/schemas/CrossSellingData"}},"type":"object"},"CustomOrder":{"properties":{"is_custom_order":{"default":false,"type":"boolean"},"manufacturing_time":{"default":0,"minimum":0,"type":"integer"},"manufacturing_time_unit":{"enum":["days","hours"],"type":"string"}},"type":"object"},"DateMeta":{"type":"object","properties":{"created_on":{"type":"string"},"modified_on":{"type":"string"}}},"DefaultKeyRequest":{"properties":{"default_key":{"type":"string"}},"required":["default_key"],"type":"object"},"DeleteAppCategoryReturnConfig":{"properties":{"app_id":{"description":"Channel identifier","type":"string"},"category_ids":{"description":"List of category_ids to be deleted.","items":{"type":"integer"},"maxItems":50,"type":"array"},"company_id":{"description":"Unique identifer of company","type":"integer"}},"required":["app_id","category_ids","company_id"],"type":"object"},"DeleteResponse":{"properties":{"message":{"type":"string"}},"type":"object"},"DeleteSearchConfigurationResponse":{"properties":{"success":{"type":"boolean"}},"type":"object"},"Department":{"properties":{"logo":{"$ref":"#/components/schemas/Media2"},"name":{"type":"string"},"priority_order":{"type":"integer"},"slug":{"type":"string"},"uid":{"type":"integer"}},"type":"object"},"DepartmentCategoryTree":{"properties":{"department":{"type":"string"},"items":{"items":{"$ref":"#/components/schemas/CategoryItems"},"type":"array"}},"type":"object"},"DepartmentCreateErrorResponse":{"properties":{"error":{"type":"string"}},"type":"object"},"DepartmentCreateResponse":{"properties":{"message":{"type":"string"},"uid":{"type":"integer"}},"required":["message","uid"],"type":"object"},"DepartmentCreateUpdate":{"properties":{"_cls":{"type":"string"},"_custom_json":{"type":"object"},"is_active":{"type":"boolean"},"logo":{"type":"string"},"name":{"type":"string"},"platforms":{"type":"object"},"priority_order":{"type":"integer"},"slug":{"type":"string"},"synonyms":{"items":{"type":"string"},"type":"array"},"tags":{"items":{"type":"string"},"type":"array"},"uid":{"type":"integer"}},"required":["logo","name","priority_order"],"type":"object"},"DepartmentErrorResponse":{"properties":{"code":{"type":"string"},"errors":{"type":"object"},"message":{"type":"string"},"meta":{"type":"object"},"status":{"type":"integer"}},"type":"object"},"DepartmentIdentifier":{"properties":{"slug":{"type":"string"},"uid":{"type":"integer"}},"type":"object"},"DepartmentModel":{"properties":{"_cls":{"type":"string"},"_custom_json":{"type":"object"},"_id":{"type":"string"},"created_by":{"allOf":[{"$ref":"#/components/schemas/UserDetail"}],"description":"User details of the creator of the document","example":{"email":"johndoe@example.com","name":"John Doe","user_id":"abc123"}},"created_on":{"description":"Timestamp of the creation of the document","example":"2022-05-03T10:00:00","format":"date-time","type":"string"},"is_active":{"description":"Whether the department is currently active","type":"boolean"},"logo":{"description":"The URL of the department's logo","type":"string"},"modified_by":{"allOf":[{"$ref":"#/components/schemas/UserDetail"}],"description":"User details of the last modifier of the document","example":{"email":"janedoe@example.com","name":"Jane Doe","user_id":"def456"}},"modified_on":{"description":"Timestamp of the last modification of the document","example":"2022-05-05T16:30:00","format":"date-time","type":"string"},"name":{"description":"The name of the department","type":"string"},"priority_order":{"description":"The priority order of the department","type":"integer"},"slug":{"description":"The unique slug identifier for the department","type":"string"},"synonyms":{"description":"A list of synonyms for the department name","items":{"type":"string"},"type":"array"},"uid":{"description":"The unique ID for the department","type":"integer"},"verified_by":{"allOf":[{"$ref":"#/components/schemas/UserDetail"}],"description":"User details of the verifier of the document, if applicable","example":{"email":"bobsmith@example.com","name":"Bob Smith","user_id":"ghi789"}},"verified_on":{"description":"Timestamp of when the document was verified, if applicable","example":"2022-05-06T09:45:00","format":"date-time","type":"string"}},"required":["created_on","logo","modified_on","name","priority_order","slug","uid"],"type":"object"},"DepartmentResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/Department"},"type":"array"}},"type":"object"},"DepartmentsResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/GetDepartment"},"type":"array"},"page":{"$ref":"#/components/schemas/Page"}},"type":"object"},"DimensionResponse":{"properties":{"height":{"description":"The height dimension.","example":15,"type":"number"},"is_default":{"description":"Indicates if it is the default dimension.","example":true,"type":"boolean"},"length":{"description":"The length dimension.","example":10.5,"type":"number"},"unit":{"description":"The unit of dimension.","example":"cm","type":"string"},"width":{"description":"The width dimension.","example":5.2,"type":"number"}},"required":["height","is_default","length","unit","width"],"type":"object"},"DimensionResponse1":{"properties":{"height":{"type":"number"},"length":{"type":"number"},"unit":{"type":"string"},"width":{"type":"number"}},"type":"object"},"Document":{"type":"object","properties":{"value":{"type":"string"},"ds_type":{"type":"string"},"verified":{"type":"boolean"},"legal_name":{"type":"string"},"url":{"type":"string","nullable":true}},"required":["ds_type","legal_name","value","verified"]},"EntityConfiguration":{"additionalProperties":true,"properties":{"app_id":{"type":"string"},"config_id":{"type":"string"},"config_type":{"type":"string"},"id":{"type":"string"},"listing":{"$ref":"#/components/schemas/GetCatalogConfigurationDetailsSchemaListing"},"product":{"$ref":"#/components/schemas/GetCatalogConfigurationDetailsProduct"}},"required":["app_id","config_type"],"type":"object"},"ErrorResponse":{"type":"object","properties":{"status_code":{"type":"integer","format":"int32","description":"HTTP status code"},"error":{"$ref":"#/components/schemas/ErrorDescription"},"message":{"type":"string","description":"Message"},"success":{"type":"boolean","description":"Successful or failure"}},"required":["message","status_code","success"]},"FilerList":{"properties":{"display":{"type":"string"},"value":{"type":"string"}},"type":"object"},"RawProduct":{"properties":{"_custom_json":{"type":"object"},"all_company_ids":{"items":{"type":"integer"},"type":"array"},"all_identifiers":{"items":{"type":"string"},"type":"array"},"all_sizes":{"items":{"type":"object"},"type":"array"},"attributes":{"type":"object"},"brand":{"$ref":"#/components/schemas/Brand"},"brand_uid":{"type":"integer"},"category":{"type":"object"},"category_slug":{"type":"string"},"category_uid":{"type":"integer"},"color":{"type":"string"},"company_id":{"type":"integer"},"country_of_origin":{"type":"string"},"created_by":{"type":"object"},"created_on":{"format":"date-time","type":"string"},"currency":{"type":"string"},"custom_order":{"type":"object"},"departments":{"items":{"type":"integer"},"type":"array"},"description":{"type":"string"},"highlights":{"items":{"type":"string"},"type":"array"},"hsn_code":{"type":"string"},"id":{"type":"string"},"image_nature":{"type":"string"},"images":{"items":{"type":"string"},"type":"array"},"is_active":{"type":"boolean"},"is_dependent":{"type":"boolean"},"is_expirable":{"type":"boolean"},"is_image_less_product":{"type":"boolean"},"is_physical":{"type":"boolean"},"is_set":{"type":"boolean"},"item_code":{"type":"string"},"item_type":{"type":"string"},"l3_mapping":{"items":{"type":"string"},"type":"array"},"media":{"items":{"$ref":"#/components/schemas/Media"},"type":"array"},"modified_by":{"type":"object"},"modified_on":{"format":"date-time","type":"string"},"moq":{"type":"object"},"multi_size":{"type":"boolean"},"name":{"type":"string"},"net_quantity":{"$ref":"#/components/schemas/NetQuantityResponse"},"no_of_boxes":{"type":"integer"},"pending":{"type":"string"},"primary_color":{"type":"string"},"product_group_tag":{"items":{"type":"string"},"type":"array"},"product_publish":{"$ref":"#/components/schemas/ProductPublished"},"return_config":{"$ref":"#/components/schemas/ReturnConfigResponse"},"short_description":{"type":"string"},"size_guide":{"type":"string"},"sizes":{"items":{"type":"object"},"type":"array"},"slug":{"type":"string"},"stage":{"type":"string"},"tags":{"items":{"type":"string"},"type":"array"},"tax_identifier":{"type":"object"},"teaser_tag":{"type":"object"},"template_tag":{"type":"string"},"trader":{"items":{"$ref":"#/components/schemas/Trader"},"type":"array"},"uid":{"type":"integer"},"variant_group":{"type":"object"},"variant_media":{"type":"object"},"variants":{"type":"object"},"verified_by":{"$ref":"#/components/schemas/VerifiedBy"},"verified_on":{"type":"string"}},"type":"object"},"RawProductListingResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/RawProduct"},"type":"array"},"page":{"$ref":"#/components/schemas/Page"}},"type":"object"},"GTIN":{"properties":{"gtin_type":{"enum":["ean","alu","upc","sku_code","isbn"],"type":"string"},"gtin_value":{"pattern":"^[A-Za-z0-9-_@,#\\(\\)\\.\\+\\/ ]+$","type":"string"},"primary":{"default":false,"type":"boolean"}},"required":["gtin_type","gtin_value"],"type":"object"},"GenderDetail":{"properties":{"departments":{"items":{"type":"string"},"type":"array"},"description":{"type":"string"},"details":{"$ref":"#/components/schemas/AttributeMasterDetails"},"enabled_for_end_consumer":{"type":"boolean"},"filters":{"$ref":"#/components/schemas/AttributeMasterFilter"},"id":{"type":"string"},"is_nested":{"type":"boolean"},"logo":{"format":"url","type":"string"},"meta":{"$ref":"#/components/schemas/AttributeMasterMeta"},"name":{"type":"string"},"schema":{"$ref":"#/components/schemas/AttributeMaster"},"slug":{"type":"string"}},"type":"object"},"GetAddressSerializer":{"type":"object","properties":{"landmark":{"type":"string"},"country_code":{"type":"string"},"pincode":{"type":"integer"},"address_type":{"type":"string"},"longitude":{"type":"number","minimum":-180,"maximum":180},"country":{"type":"string"},"address2":{"type":"string"},"state":{"type":"string"},"state_code":{"type":"string"},"sector":{"type":"string"},"address1":{"type":"string"},"city":{"type":"string"},"latitude":{"type":"number","minimum":-90,"maximum":90}},"required":["latitude","longitude"]},"GetAllSizes":{"properties":{"all_sizes":{"items":{"$ref":"#/components/schemas/AllSizes"},"type":"array"}},"type":"object"},"GetAppCatalogConfiguration":{"properties":{"data":{"$ref":"#/components/schemas/AppCatalogConfiguration"},"is_default":{"type":"boolean"}},"type":"object"},"GetAppCatalogEntityConfiguration":{"properties":{"data":{"$ref":"#/components/schemas/EntityConfiguration"},"is_default":{"type":"boolean"}},"type":"object"},"GetAutocompleteWordsData":{"properties":{"_custom_json":{"type":"object"},"app_id":{"type":"string"},"results":{"items":{"type":"object"},"type":"array"},"uid":{"type":"string"},"words":{"items":{"type":"string"},"type":"array"}},"type":"object"},"GetAutocompleteWordsResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/GetAutocompleteWordsData"},"type":"array"},"page":{"$ref":"#/components/schemas/Page"}},"type":"object"},"GetCatalogConfigurationDetailsProduct":{"properties":{"compare":{"type":"object"},"detail":{"type":"object"},"similar":{"type":"object"},"variant":{"type":"object"}},"type":"object"},"GetCatalogConfigurationDetailsSchemaListing":{"additionalProperties":true,"properties":{"filter":{"type":"object"},"sort":{"type":"object"}},"type":"object"},"GetCatalogConfigurationMetaData":{"properties":{"listing":{"$ref":"#/components/schemas/MetaDataListingResponse"},"product":{"$ref":"#/components/schemas/GetCatalogConfigurationDetailsProduct"}},"type":"object"},"GetCollectionDetailNest":{"additionalProperties":true,"properties":{"_schedule":{"type":"object"},"action":{"$ref":"#/components/schemas/Action"},"allow_facets":{"type":"boolean"},"allow_sort":{"type":"boolean"},"app_id":{"type":"string"},"badge":{"type":"object"},"banners":{"$ref":"#/components/schemas/ImageUrls"},"cron":{"type":"object"},"description":{"type":"string"},"is_active":{"type":"boolean"},"logo":{"$ref":"#/components/schemas/Media"},"meta":{"type":"object"},"name":{"type":"string"},"priority":{"type":"integer"},"query":{"items":{"$ref":"#/components/schemas/CollectionQuery"},"type":"array"},"slug":{"type":"string"},"tag":{"items":{"type":"string"},"type":"array"},"type":{"type":"string"},"uid":{"type":"string"},"visible_facets_keys":{"items":{"type":"string"},"type":"array"}},"type":"object"},"GetCollectionItemsResponse":{"properties":{"filters":{"items":{"$ref":"#/components/schemas/ProductFilters"},"type":"array"},"items":{"items":{"$ref":"#/components/schemas/ProductListingDetail"},"type":"array"},"page":{"$ref":"#/components/schemas/Page"},"sort_on":{"items":{"$ref":"#/components/schemas/ProductSortOn"},"type":"array"}},"type":"object"},"GetCollectionListingResponse":{"properties":{"filters":{"$ref":"#/components/schemas/CollectionListingFilter"},"items":{"items":{"$ref":"#/components/schemas/GetCollectionDetailNest"},"type":"array"},"page":{"$ref":"#/components/schemas/Page"}},"type":"object"},"GetCollectionQueryOptionResponse":{"properties":{"filters":{"items":{"$ref":"#/components/schemas/ProductFilters"},"type":"array"},"operators":{"additionalProperties":{"type":"string"},"type":"object"},"sort_on":{"items":{"$ref":"#/components/schemas/ProductSortOn"},"type":"array"}},"required":["operators"],"type":"object"},"GetCompanySerializer":{"type":"object","properties":{"stage":{"type":"string"},"verified_on":{"type":"string","format":"date-time"},"verified_by":{"$ref":"#/components/schemas/UserSerializer"},"created_on":{"type":"string","format":"date-time"},"created_by":{"$ref":"#/components/schemas/UserSerializer"},"company_type":{"type":"string"},"modified_on":{"type":"string","format":"date-time"},"business_type":{"type":"string"},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/GetAddressSerializer"}},"uid":{"type":"integer"},"reject_reason":{"type":"string"},"name":{"type":"string"},"modified_by":{"$ref":"#/components/schemas/UserSerializer"}}},"GetConfigMetadataResponse":{"properties":{"condition":{"items":{"type":"object"},"type":"array"},"data":{"items":{"type":"object"},"type":"array"},"page":{"$ref":"#/components/schemas/Page"},"values":{"items":{"type":"object"},"type":"array"}},"required":["data"],"type":"object"},"GetConfigResponse":{"properties":{"data":{"items":{"type":"object"},"type":"array"},"page":{"$ref":"#/components/schemas/PageResponseType"}},"required":["data","page"],"type":"object"},"GetDepartment":{"properties":{"created_by":{"$ref":"#/components/schemas/UserSerializer1"},"created_on":{"format":"date-time","type":"string"},"is_active":{"type":"boolean"},"item_type":{"type":"string"},"logo":{"format":"url","type":"string"},"modified_by":{"$ref":"#/components/schemas/UserSerializer1"},"modified_on":{"format":"date-time","type":"string"},"name":{"type":"string"},"page_no":{"default":1,"type":"integer"},"page_size":{"default":20,"type":"integer"},"priority_order":{"type":"integer"},"search":{"type":"string"},"slug":{"type":"string"},"synonyms":{"items":{"type":"string"},"type":"array"},"uid":{"type":"integer"}},"type":"object"},"GetInventories":{"properties":{"brand":{"$ref":"#/components/schemas/BrandMeta1"},"company":{"$ref":"#/components/schemas/CompanyMeta1"},"country_of_origin":{"type":"string"},"created_by":{"$ref":"#/components/schemas/UserSerializer1"},"date_meta":{"$ref":"#/components/schemas/DateMeta"},"dimension":{"$ref":"#/components/schemas/DimensionResponse1"},"expiration_date":{"format":"date-time","type":"string"},"id":{"type":"string"},"identifier":{"type":"object"},"inventory_updated_on":{"format":"date-time","type":"string"},"is_set":{"type":"boolean"},"item_id":{"type":"integer"},"manufacturer":{"$ref":"#/components/schemas/ManufacturerResponse1"},"modified_by":{"$ref":"#/components/schemas/UserSerializer1"},"platforms":{"type":"object"},"price":{"$ref":"#/components/schemas/PriceArticle"},"quantities":{"$ref":"#/components/schemas/QuantitiesArticle"},"return_config":{"$ref":"#/components/schemas/ReturnConfig2"},"seller_identifier":{"type":"string"},"size":{"type":"string"},"stage":{"type":"string"},"store":{"$ref":"#/components/schemas/ArticleStoreResponse"},"tags":{"items":{"type":"string"},"type":"array"},"tax_identifier":{"type":"object"},"total_quantity":{"minimum":0,"type":"integer"},"trace_id":{"type":"string"},"track_inventory":{"type":"boolean"},"trader":{"items":{"$ref":"#/components/schemas/Trader2"},"type":"array"},"uid":{"type":"string"},"weight":{"$ref":"#/components/schemas/WeightResponse1"}},"type":"object"},"GetInventoriesResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/GetInventories"},"type":"array"},"page":{"$ref":"#/components/schemas/Page"}},"type":"object"},"GetLocationSerializer":{"type":"object","properties":{"code":{"type":"string"},"phone_number":{"type":"string"},"contact_numbers":{"type":"array","items":{"$ref":"#/components/schemas/SellerPhoneNumber"}},"gst_credentials":{"$ref":"#/components/schemas/InvoiceDetailsSerializer"},"name":{"type":"string"},"_custom_json":{"type":"object"},"verified_on":{"type":"string","format":"date-time"},"created_by":{"$ref":"#/components/schemas/UserSerializer"},"created_on":{"type":"string","format":"date-time"},"company":{"$ref":"#/components/schemas/GetCompanySerializer"},"address":{"$ref":"#/components/schemas/GetAddressSerializer"},"warnings":{"type":"object"},"store_type":{"type":"string"},"manager":{"$ref":"#/components/schemas/LocationManagerSerializer"},"auto_invoice":{"type":"boolean"},"modified_on":{"type":"string","format":"date-time"},"uid":{"type":"integer"},"timing":{"type":"array","items":{"$ref":"#/components/schemas/LocationDayWiseSerializer"}},"stage":{"type":"string"},"documents":{"type":"array","items":{"$ref":"#/components/schemas/Document"}},"credit_note":{"type":"boolean"},"holiday":{"type":"array","items":{"$ref":"#/components/schemas/HolidaySchemaSerializer"}},"display_name":{"type":"string"},"product_return_config":{"$ref":"#/components/schemas/ProductReturnConfigSerializer"},"verified_by":{"$ref":"#/components/schemas/UserSerializer"},"notification_emails":{"type":"array","items":{"type":"string"}},"modified_by":{"$ref":"#/components/schemas/UserSerializer"},"tags":{"type":"array","items":{"type":"string"}},"default_order_acceptance_timing":{"type":"boolean"},"order_acceptance_timing":{"type":"array","items":{"$ref":"#/components/schemas/LocationDayWiseSerializer"}},"avg_order_processing_time":{"$ref":"#/components/schemas/AverageOrderProcessingTime"},"bulk_shipment":{"type":"boolean"},"auto_assign_courier_partner":{"type":"boolean"}},"required":["address","code","display_name","name"]},"GetOptInPlatform":{"properties":{"items":{"items":{"$ref":"#/components/schemas/CompanyOptIn"},"type":"array"},"page":{"$ref":"#/components/schemas/Page"}},"required":["items","page"],"type":"object"},"GetProductBundleCreateResponse":{"properties":{"choice":{"type":"string"},"company_id":{"type":"integer"},"created_by":{"type":"object"},"created_on":{"format":"date-time","type":"string"},"id":{"type":"string"},"is_active":{"type":"boolean"},"logo":{"nullable":true,"type":"string"},"meta":{"type":"object"},"modified_by":{"type":"object"},"modified_on":{"format":"date-time","type":"string"},"name":{"type":"string"},"page_visibility":{"items":{"enum":["pdp"],"type":"string"},"type":"array"},"products":{"items":{"$ref":"#/components/schemas/ProductBundleItem"},"maxItems":10,"type":"array"},"same_store_assignment":{"default":true,"type":"boolean"},"slug":{"type":"string"}},"required":["choice","is_active","name","products","slug"],"type":"object"},"GetProductBundleListingResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/GetProductBundleCreateResponse"},"type":"array"},"page":{"$ref":"#/components/schemas/Page"}},"type":"object"},"GetProductBundleResponse":{"properties":{"choice":{"type":"string"},"company_id":{"type":"integer"},"is_active":{"type":"boolean"},"logo":{"type":"string"},"meta":{"type":"object"},"name":{"type":"string"},"page_visibility":{"items":{"type":"string"},"type":"array"},"products":{"items":{"$ref":"#/components/schemas/GetProducts"},"type":"array"},"same_store_assignment":{"type":"boolean"},"slug":{"type":"string"}},"type":"object"},"GetProducts":{"properties":{"allow_remove":{"type":"boolean"},"auto_add_to_cart":{"type":"boolean"},"auto_select":{"type":"boolean"},"max_quantity":{"type":"integer"},"min_quantity":{"type":"integer"},"price":{"$ref":"#/components/schemas/Price"},"product_details":{"$ref":"#/components/schemas/LimitedProductData"},"product_uid":{"type":"integer"},"sizes":{"items":{"$ref":"#/components/schemas/Size"},"type":"array"}},"type":"object"},"GetCollectionDetailResponse":{"additionalProperties":true,"properties":{"_custom_json":{"type":"object"},"_locale_language":{"type":"object"},"_schedule":{"$ref":"#/components/schemas/CollectionSchedule"},"action":{"type":"object"},"allow_facets":{"type":"boolean"},"allow_sort":{"type":"boolean"},"app_id":{"type":"string"},"badge":{"$ref":"#/components/schemas/CollectionBadge"},"banners":{"$ref":"#/components/schemas/ImageUrls"},"description":{"type":"string"},"is_active":{"type":"boolean"},"is_visible":{"type":"boolean"},"logo":{"$ref":"#/components/schemas/Media"},"meta":{"type":"object"},"name":{"type":"string"},"priority":{"type":"integer"},"published":{"type":"boolean"},"query":{"items":{"$ref":"#/components/schemas/CollectionQuery"},"type":"array"},"seo":{"$ref":"#/components/schemas/SeoDetail"},"slug":{"type":"string"},"sort_on":{"type":"string"},"tags":{"items":{"type":"string"},"type":"array"},"type":{"type":"string"},"uid":{"type":"string"},"visible_facets_keys":{"items":{"type":"string"},"type":"array"}},"type":"object"},"CommonResponseSchemaCollection":{"properties":{"message":{"type":"string"}},"type":"object"},"GetQueryFiltersResponse":{"properties":{"filters":{"items":{"$ref":"#/components/schemas/ProductFilters"},"type":"array"},"operators":{"additionalProperties":{"type":"string"},"type":"object"},"sort_on":{"items":{"$ref":"#/components/schemas/ProductSortOn"},"type":"array"}},"required":["operators"],"type":"object"},"GetCollectionItemsResponseSchemaV2":{"properties":{"items":{"items":{"$ref":"#/components/schemas/ProductDetailV2"},"type":"array"},"page":{"$ref":"#/components/schemas/Page1"}},"type":"object"},"Page1":{"properties":{"ca":{"type":"boolean"},"department":{"type":"string"},"page_no":{"default":1,"type":"integer"},"page_size":{"default":12,"minimum":1,"type":"integer"},"q":{"type":"string"},"sort":{"type":"string"},"sort_on":{"type":"string"},"type":{"type":"string"},"variant":{"type":"string"}},"type":"object"},"CollectionItemSchemaV2":{"properties":{"action":{"enum":["add","remove"],"type":"string"},"item_id":{"type":"integer"},"priority":{"type":"integer"}},"required":["action","item_id"],"type":"object"},"CollectionItemUpdateSchemaV2":{"properties":{"allow_facets":{"type":"boolean"},"allow_sort":{"type":"boolean"},"items":{"items":{"$ref":"#/components/schemas/CollectionItemSchemaV2"},"type":"array"},"query":{"items":{"$ref":"#/components/schemas/CollectionQuerySchemaV2"},"type":"array"},"type":{"type":"string"},"visible_facets_keys":{"items":{"type":"string"},"type":"array"}},"required":["type"],"type":"object"},"CollectionQuerySchemaV2":{"properties":{"attribute":{"description":"The attribute of the collection query","type":"string"},"op":{"description":"The operation to be performed on the attribute of the collection query","enum":["in","nin","gt","gte","lt","lte","btw"],"type":"string"},"value":{"description":"The value of the attribute of the collection query","items":{},"type":"array"}},"required":["attribute","op","value"],"type":"object"},"ProductDetailV2":{"properties":{"brand":{"$ref":"#/components/schemas/ProductBrand"},"is_excluded":{"type":"boolean"},"is_pinned":{"type":"boolean"},"item_code":{"type":"string"},"item_type":{"type":"string"},"medias":{"items":{"$ref":"#/components/schemas/Media"},"type":"array"},"name":{"type":"string"},"priority":{"type":"integer"},"short_description":{"type":"string"},"slug":{"type":"string"},"uid":{"type":"integer"}},"required":["slug"],"type":"object"},"GetSearchConfigurationResponse":{"properties":{"application_id":{"description":"The application id where custom search configuration is set","type":"string"},"company_id":{"description":"The company id where custom search configuration is set","type":"integer"},"created_by":{"allOf":[{"$ref":"#/components/schemas/UserSerializer"}],"description":"The user who created the search configuration."},"created_on":{"description":"The date and time when the search configuration was created.","example":"2022-03-15T14:56:22.123Z","format":"date-time","type":"string"},"is_proximity_enabled":{"default":false,"description":"Flag indicating if proximity search is enabled for this attribute.","type":"boolean"},"modified_by":{"allOf":[{"$ref":"#/components/schemas/UserSerializer"}],"description":"The user who modified the search configuration."},"modified_on":{"description":"The date and time when the search configuration was last modified.","example":"2022-03-16T09:12:33.456Z","format":"date-time","type":"string"},"proximity":{"default":1,"description":"Proximity distance configuration","type":"integer"},"searchable_attributes":{"description":"The searchable attributes defined on the application.","items":{"$ref":"#/components/schemas/SearchableAttribute"},"type":"array"}},"required":["application_id","company_id"],"type":"object"},"GetSearchWordsData":{"properties":{"_custom_json":{"type":"object"},"app_id":{"type":"string"},"is_active":{"type":"boolean"},"result":{"type":"object"},"uid":{"type":"string"},"words":{"items":{"type":"string"},"type":"array"}},"type":"object"},"GetSearchWordsDetailResponse":{"properties":{"items":{"$ref":"#/components/schemas/GetSearchWordsData"},"page":{"$ref":"#/components/schemas/Page"}},"type":"object"},"GetSearchWordsResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/GetSearchWordsData"},"type":"array"},"page":{"$ref":"#/components/schemas/Page"}},"type":"object"},"GlobalValidation":{"properties":{"definitions":{"type":"object"},"description":{"type":"string"},"properties":{"$ref":"#/components/schemas/Properties"},"required":{"items":{"type":"string"},"type":"array"},"title":{"type":"string"},"type":{"type":"string"}},"type":"object"},"Guide":{"properties":{"meta":{"$ref":"#/components/schemas/Meta"}},"type":"object"},"HSNCodesResponse":{"properties":{"data":{"$ref":"#/components/schemas/HSNData"},"message":{"type":"string"}},"type":"object"},"HSNData":{"properties":{"country_of_origin":{"items":{"type":"string"},"type":"array"},"hsn_code":{"items":{"type":"string"},"type":"array"}},"type":"object"},"HSNDataInsertV2":{"properties":{"country_code":{"description":"Country code.","type":"string"},"created_by":{"description":"Details of the user who created the HSN data.","example":{"name":"John","user_id":1},"type":"object"},"created_on":{"description":"Date and time when the HSN data was created.","example":"2023-06-08 10:00:00","format":"date-time","type":"string"},"description":{"description":"Description of the HSN data.","type":"string"},"hsn_code":{"description":"HSN code.","maxLength":11,"minLength":4,"type":"string"},"hsn_code_id":{"description":"Unique identifier of the HSN code.","example":"hsn123","type":"string"},"modified_by":{"description":"Details of the user who last modified the HSN data.","example":{"name":"Jane","user_id":2},"type":"object"},"modified_on":{"description":"Date and time when the HSN data was last modified.","example":"2023-06-08 11:30:00","format":"date-time","type":"string"},"reporting_hsn":{"description":"HSN code.","example":"12345678","type":"string"},"taxes":{"description":"List of tax slabs.","items":{"$ref":"#/components/schemas/TaxSlab"},"type":"array"},"type":{"description":"Type of HSN data (goods or services).","enum":["goods","services"],"type":"string"}},"required":["country_code","description","hsn_code","reporting_hsn","taxes","type"],"type":"object"},"Hierarchy":{"properties":{"department":{"description":"It is the unique identifier of the department the category is mapped to.","example":1,"type":"integer"},"l1":{"description":"It is the unique id of the L1 category mapped to the L3 category.","example":1,"type":"integer"},"l2":{"description":"It is the unique id of the L2 category mapped to the L3 category.","example":2,"type":"integer"}},"required":["department","l1","l2"],"type":"object"},"HsnCode":{"properties":{"data":{"allOf":[{"$ref":"#/components/schemas/HsnCodesObject"}],"description":"The HSN code data."}},"type":"object"},"HsnCodesListingResponseSchemaV2":{"properties":{"items":{"items":{"$ref":"#/components/schemas/HSNDataInsertV2"},"type":"array"},"page":{"$ref":"#/components/schemas/PageResponse"}},"type":"object"},"HsnCodesObject":{"properties":{"company_id":{"description":"The ID of the company.","example":123,"type":"integer"},"hs2_code":{"description":"The HS2 code.","example":"12","type":"string"},"hsn_code":{"description":"The HSN code.","example":"12345678","type":"string"},"id":{"description":"The identifier of the HSN code.","example":"hsn123","type":"string"},"modified_on":{"description":"The date and time when the HSN code was last modified.","example":"2023-06-08 11:30:00","type":"string"},"tax1":{"description":"The first tax rate.","example":18,"type":"number"},"tax2":{"description":"The second tax rate.","example":12,"type":"number"},"tax_on_esp":{"description":"Flag indicating whether tax is applicable on ESP.","example":false,"type":"boolean"},"tax_on_mrp":{"description":"Flag indicating whether tax is applicable on MRP.","example":true,"type":"boolean"},"threshold1":{"description":"The threshold for the first tax rate.","example":100000,"type":"number"},"threshold2":{"description":"The threshold for the second tax rate.","example":50000,"type":"number"}},"type":"object"},"HsnUpsert":{"properties":{"company_id":{"description":"The ID of the company.","example":123,"type":"integer"},"hs2_code":{"description":"The HS2 code.","example":"12","nullable":true,"type":"string"},"hsn_code":{"description":"The HSN code.","example":"12345678","type":"string"},"is_active":{"description":"Flag indicating whether the entry is active.","example":true,"type":"boolean"},"tax1":{"description":"The first tax rate.","enum":[0,0.25,1.5,2.5,3,5,10,12,15,18,28],"example":18,"type":"number"},"tax2":{"default":0,"description":"The second tax rate.","enum":[0,0.25,1.5,2.5,3,5,10,12,15,18,28],"example":12,"type":"number"},"tax_on_esp":{"default":false,"description":"Flag indicating whether tax is applicable on ESP.","example":false,"type":"boolean"},"tax_on_mrp":{"description":"Flag indicating whether tax is applicable on MRP.","example":true,"type":"boolean"},"threshold1":{"description":"The threshold for the first tax rate.","example":100000,"maximum":999999,"type":"number"},"threshold2":{"description":"The threshold for the second tax rate.","example":50000,"maximum":999999,"type":"number"},"uid":{"description":"The unique identifier.","example":1,"type":"integer"}},"required":["company_id","hs2_code","hsn_code","tax1","tax_on_mrp","threshold1"],"type":"object"},"Image":{"type":"object","properties":{"sales_channel_logo":{"type":"string"}}},"ImageUrls":{"properties":{"landscape":{"$ref":"#/components/schemas/BannerImage"},"portrait":{"$ref":"#/components/schemas/BannerImage"}},"type":"object"},"InvSize":{"properties":{"currency":{"description":"The currency used for the item price.","example":"INR","type":"string"},"expiration_date":{"format":"date-time","type":"string"},"identifiers":{"items":{"$ref":"#/components/schemas/GTIN"},"type":"array"},"is_set":{"type":"boolean"},"item_dimensions_unit_of_measure":{"description":"The unit of measure for the item dimensions.","example":"cm","nullable":true,"type":"string"},"item_height":{"description":"The height of the item.","example":10.5,"minimum":0.1,"nullable":true,"type":"number"},"item_length":{"description":"The length of the item.","example":15.7,"minimum":0.1,"nullable":true,"type":"number"},"item_weight":{"description":"The weight of the item.","example":0.5,"minimum":0.1,"nullable":true,"type":"number"},"item_weight_unit_of_measure":{"description":"The unit of measure for the item weight.","example":"kg","nullable":true,"type":"string"},"item_width":{"description":"The width of the item.","example":5.2,"minimum":0.1,"nullable":true,"type":"number"},"price":{"minimum":0,"type":"number"},"price_effective":{"minimum":0,"type":"number"},"price_transfer":{"nullable":true,"type":"number"},"quantity":{"minimum":0,"type":"integer"},"set":{"$ref":"#/components/schemas/InventorySet"},"size":{"type":"string"},"store_code":{"type":"string"}},"required":["currency","identifiers","price_effective","quantity","size","store_code"],"type":"object"},"InventoryBulkRequest":{"properties":{"batch_id":{"type":"string"},"company_id":{"type":"integer"},"sizes":{"items":{"$ref":"#/components/schemas/InventoryJobPayload"},"type":"array"},"user":{"type":"object"}},"required":["batch_id","company_id","sizes"],"type":"object"},"InventoryConfig":{"type":"object","properties":{"brand":{"$ref":"#/components/schemas/InventoryBrandRule"},"store":{"$ref":"#/components/schemas/InventoryStoreRule"},"image":{"type":"array","items":{"type":"string","description":"Control to allow imageless products on the website.","enum":["standard","substandard","default"]}},"franchise_enabled":{"type":"boolean","description":"Allow other businesses (companies) to consume the current sales channel's inventory and sell products"},"out_of_stock":{"type":"boolean","description":"Indicates whether out of stock products are allowed to show up on the website."},"only_verified_products":{"type":"boolean","description":"Show only verified products (the ones whose data have been verified by the admin)"}}},"InventoryCreateRequest":{"properties":{"data":{"default":[],"description":"The list of attributes that you want to extract in the export job.","items":{"type":"string"},"type":"array"},"filters":{"allOf":[{"$ref":"#/components/schemas/InventoryExportFilter"}],"description":"This filters that are applied for the export of the inventory."},"notification_emails":{"description":"The list of the emails to be notified after the completion of the job.","items":{"format":"email","type":"string"},"type":"array"},"type":{"default":"csv","description":"The type of file that needs to be exported.","enum":["csv","excel"],"nullable":true,"type":"string"}},"required":["filters"],"type":"object"},"InventoryExportAdvanceOption":{"properties":{"brand_ids":{"items":{"type":"integer"},"type":"array"},"from_date":{"format":"date-time","nullable":true,"type":"string"},"quantity":{"$ref":"#/components/schemas/InventoryExportQuantityFilter"},"store_ids":{"items":{"type":"integer"},"type":"array"},"to_date":{"format":"date-time","nullable":true,"type":"string"}},"type":"object"},"InventoryExportFilter":{"properties":{"brand_ids":{"description":"The list of the brand ids that needs to be exported.","items":{"type":"integer"},"type":"array"},"from_date":{"description":"The modified on date from which the data needs to be exported.","format":"date-time","type":"string"},"quantity":{"allOf":[{"$ref":"#/components/schemas/InventoryExportQuantityFilter"}],"description":"The quantity range that needs to be exported."},"store_ids":{"description":"The list of the store ids that needs to be exported.","items":{"type":"integer"},"type":"array"},"to_date":{"description":"The modified on date till when the data needs to be exported.","format":"date-time","type":"string"}},"required":["store_ids"],"type":"object"},"InventoryExportJob":{"properties":{"completed_on":{"description":"Completion datetime of the job.","format":"date-time","type":"string"},"filters":{"allOf":[{"$ref":"#/components/schemas/InventoryExportAdvanceOption"}],"description":"The filters that needs to be exported."},"notification_emails":{"description":"The notification emails for the job.","items":{"format":"email","type":"string"},"type":"array"},"seller_id":{"description":"The seller id that needs to be exported.","type":"integer"},"status":{"description":"The status of the job.","enum":["pending","running","success"],"type":"string"},"task_id":{"description":"The task id of the job.","type":"string"},"type":{"description":"The type of file that needs to be exported.","type":"string"},"url":{"description":"URL odf the exported file.","format":"url","type":"string"}},"required":["seller_id","task_id","type"],"type":"object"},"InventoryExportJobListResponse":{"properties":{"items":{"allOf":[{"$ref":"#/components/schemas/InventoryJobDetailResponse"}],"description":"This is the list/history of all the jobs."}},"required":["items"],"type":"object"},"InventoryExportQuantityFilter":{"properties":{"max":{"description":"The maximum quantity that needs to be exported.","type":"integer"},"min":{"description":"The minimum quantity that needs to be exported.","type":"integer"},"operators":{"description":"Condition for the quantity that needs to be exported.","enum":["between","greater_than","lesser_than","equals"],"type":"string"}},"required":["operators"],"type":"object"},"InventoryExportRequest":{"properties":{"brand":{"items":{"type":"integer"},"type":"array"},"store":{"items":{"type":"integer"},"type":"array"},"type":{"default":"csv","enum":["csv","excel"],"nullable":true,"type":"string"}},"type":"object"},"InventoryExportResponse":{"properties":{"created_by":{"description":"The user that created the job.","format":"date-time","type":"string"},"created_on":{"description":"Creation datetime of the job","format":"date-time","type":"string"},"filters":{"description":"The filters that needs to be exported.","type":"object"},"modified_on":{"description":"Modification date of the job","format":"date-time","type":"string"},"notification_emails":{"description":"The notification emails for the job.","items":{"format":"email","type":"string"},"type":"array"},"seller_id":{"description":"The seller id that needs to be exported.","type":"integer"},"status":{"description":"The status of the job.","enum":["pending","running","success"],"type":"string"},"task_id":{"description":"The task id of the job.","type":"string"},"type":{"description":"The type of file that needs to be exported.","type":"string"}},"required":["seller_id","task_id"],"type":"object"},"InventoryFailedReason":{"properties":{"errors":{"description":"It is the error message of the inventory error response.","type":"string"},"message":{"description":"It is the message of the activity performed.","type":"string"}},"required":["message"],"type":"object"},"InventoryJobDetailResponse":{"properties":{"cancelled_by":{"allOf":[{"$ref":"#/components/schemas/UserDetail"}],"description":"This is the user detail of the user who cancelled the job."},"cancelled_on":{"description":"This is the timestamp of the cacellation for this job.","format":"date-time","type":"string"},"completed_on":{"description":"This is the timestamp of the completion for this job.","format":"date-time","type":"string"},"created_by":{"allOf":[{"$ref":"#/components/schemas/UserDetail"}],"description":"This is the user detail of the user who cancelled the job."},"created_on":{"description":"This is the timestamp of the creation for this job.","format":"date-time","type":"string"},"filters":{"allOf":[{"$ref":"#/components/schemas/InventoryJobFilters"}],"description":"This is the filter criteria applied for the export job."},"id":{"description":"This is the ID of the job.","type":"string"},"modified_on":{"description":"This is the timestamp of the modification for this job.","format":"date-time","type":"string"},"notification_emails":{"default":[],"description":"User email to get notification post completion of the job.","items":{"format":"email","type":"string"},"type":"array"},"seller_id":{"description":"This ID of the company.","type":"integer"},"status":{"description":"This tells you the current status of the export job.","enum":["pending","running","success"],"type":"string"},"task_id":{"description":"This is the task id of the jobs that is used for search.","type":"string"},"type":{"default":"csv","description":"This is the file type of the export.","enum":["csv","excel"],"nullable":true,"type":"string"},"url":{"description":"This is the url to download the export.","format":"url","type":"string"}},"required":["filters","id","seller_id","task_id","url"],"type":"object"},"InventoryJobFilters":{"properties":{"brands":{"default":[],"description":"The list of all the brands selected.","items":{"type":"string"},"type":"array"},"from_date":{"description":"The modified on date from which the data needs to be exported.","format":"date-time","type":"string"},"quantity":{"allOf":[{"$ref":"#/components/schemas/InventoryExportQuantityFilter"}],"description":"The quantity range that needs to be exported."},"stores":{"default":[],"description":"The list of all the store selected.","items":{"type":"string"},"type":"array"},"to_date":{"description":"The modified on date till when the data needs to be exported.","format":"date-time","type":"string"}},"type":"object"},"InventoryJobPayload":{"properties":{"currency":{"description":"The currency used for the item price.","example":"USD","type":"string"},"expiration_date":{"description":"The expiration date of the item.","example":"2023-12-31T15:43:59.410000Z","format":"date-time","type":"string"},"item_dimensions_unit_of_measure":{"description":"The unit of measure for the item dimensions.","example":"cm","type":"string"},"item_weight_unit_of_measure":{"description":"The unit of measure for the item weight.","example":"kg","type":"string"},"price":{"description":"The price of the item.","example":49.99,"type":"number"},"price_effective":{"description":"The effective price of the item.","example":79.99,"type":"number"},"price_marked":{"description":"The marked price of the item.","example":99.99,"type":"number"},"quantity":{"description":"The quantity of the item.","example":10,"type":"integer"},"seller_identifier":{"description":"The identifier of the seller.","example":"SELLER123","type":"string"},"store_code":{"description":"The code of the store.","example":"STORE456","type":"string"},"tags":{"description":"The tags associated with the item.","example":["tag1","tag2"],"items":{"type":"string"},"nullable":true,"type":"array"},"total_quantity":{"description":"The total quantity of the item.","example":100,"type":"integer"},"trace_id":{"description":"The trace ID of the inventory job payload.","example":"TRACE123","nullable":true,"type":"string"}},"required":["seller_identifier","store_code"],"type":"object"},"InventoryPage":{"properties":{"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"item_total":{"type":"integer"},"next_id":{"nullable":true,"type":"string"},"type":{"type":"string"}},"required":["item_total","type"],"type":"object"},"InventoryPayload":{"additionalProperties":true,"properties":{"expiration_date":{"description":"The expiration date of the inventory item.","example":"2023-06-30T15:43:59.410000Z","format":"date-time","type":"string"},"price_effective":{"description":"The effective price of the inventory item.","example":8.99,"type":"number"},"price_marked":{"description":"The marked price of the inventory item.","example":10.99,"type":"number"},"seller_identifier":{"description":"The identifier of the seller.","example":"SELLER123","pattern":"^[A-Za-z0-9-_@,#\\(\\)\\.\\+\\/ ]+$","type":"string"},"store_id":{"description":"The ID of the store.","example":123,"type":"integer"},"tags":{"description":"The tags associated with the inventory item.","example":["tag1","tag2"],"items":{"type":"string"},"nullable":true,"type":"array"},"total_quantity":{"description":"The total quantity of the inventory item.","example":100,"nullable":true,"type":"integer"},"trace_id":{"description":"The trace ID of the inventory payload.","example":"TRACE123","type":"string"}},"required":["seller_identifier","store_id"],"type":"object"},"InventoryRequest":{"properties":{"company_id":{"type":"integer"},"item":{"$ref":"#/components/schemas/ItemQuery"},"sizes":{"items":{"$ref":"#/components/schemas/InvSize"},"type":"array"}},"required":["company_id","item","sizes"],"type":"object"},"InventoryRequestSchemaV2":{"properties":{"company_id":{"description":"The ID of the company.","example":123,"type":"integer"},"meta":{"default":{},"description":"Additional metadata for the inventory request.","example":{"key1":"value1","key2":"value2"},"type":"object"},"payload":{"description":"The list of inventory payloads.","example":[{"expiration_date":"2023-12-31T15:43:59.410000Z","price_effective":79.99,"price_marked":99.99,"seller_identifier":"SELLER123","store_id":456,"tags":["tag1","tag2"],"total_quantity":100,"trace_id":"TRACE123"}],"items":{"$ref":"#/components/schemas/InventoryPayload"},"maxItems":50,"type":"array"}},"required":["company_id"],"type":"object"},"InventoryResponse":{"properties":{"currency":{"type":"string"},"identifiers":{"type":"object"},"inventory_updated_on":{"type":"string"},"item_id":{"type":"integer"},"price":{"type":"number"},"price_effective":{"type":"number"},"price_transfer":{"type":"number"},"quantity":{"type":"integer"},"sellable_quantity":{"type":"integer"},"seller_identifier":{"type":"string"},"size":{"type":"string"},"store":{"type":"object"},"uid":{"type":"string"}},"type":"object"},"InventoryResponseItem":{"properties":{"data":{"$ref":"#/components/schemas/InventoryPayload"},"reason":{"$ref":"#/components/schemas/InventoryFailedReason"}},"type":"object"},"InventoryResponsePaginated":{"properties":{"items":{"items":{"$ref":"#/components/schemas/InventoryResponse"},"type":"array"},"page":{"$ref":"#/components/schemas/Page"}},"type":"object"},"InventorySellerIdentifierResponsePaginated":{"properties":{"items":{"items":{"$ref":"#/components/schemas/InventorySellerResponse"},"type":"array"},"page":{"$ref":"#/components/schemas/Page"}},"type":"object"},"InventorySellerResponse":{"properties":{"_custom_json":{"description":"Custom JSON data for the article.","type":"object"},"added_on_store":{"description":"The date and time when the article was added to the store.","format":"date-time","type":"string"},"brand":{"allOf":[{"$ref":"#/components/schemas/BrandMeta"}],"description":"The metadata of the brand."},"company":{"allOf":[{"$ref":"#/components/schemas/CompanyMeta"}],"description":"The metadata of the company."},"country_of_origin":{"description":"The country of origin of the article.","type":"string"},"created_by":{"allOf":[{"$ref":"#/components/schemas/UserSerializer1"}],"description":"The user who created the article.","nullable":true,"type":"string"},"dimension":{"allOf":[{"$ref":"#/components/schemas/DimensionResponse"}],"description":"The dimensions of the article."},"expiration_date":{"description":"The expiration date of the article.","format":"date-time","type":"string"},"fragile":{"description":"Indicates if the article is fragile.","type":"boolean"},"fynd_article_code":{"description":"The Fynd article code.","example":"ART123","type":"string"},"fynd_item_code":{"description":"The Fynd item code.","example":"FYND123","type":"string"},"fynd_meta":{"description":"The Fynd metadata of the article.","type":"object"},"identifier":{"description":"The identifier of the article.","type":"object"},"is_active":{"default":true,"description":"Indicates if the article is active.","type":"boolean"},"is_set":{"type":"boolean"},"item_id":{"description":"The ID of the item.","example":12345,"type":"integer"},"manufacturer":{"allOf":[{"$ref":"#/components/schemas/ManufacturerResponse"}],"description":"The manufacturer of the article."},"meta":{"description":"Additional metadata for the article.","nullable":true,"type":"object"},"modified_by":{"allOf":[{"$ref":"#/components/schemas/UserSerializer1"}],"description":"The user who modified the article.","nullable":true,"type":"string"},"price":{"allOf":[{"$ref":"#/components/schemas/PriceMeta"}],"description":"The price metadata of the article."},"quantities":{"$ref":"#/components/schemas/Quantities"},"raw_meta":{"description":"The raw metadata of the article.","type":"object"},"return_config":{"allOf":[{"$ref":"#/components/schemas/ReturnConfig1"}],"description":"The return configuration of the article."},"seller_identifier":{"description":"The seller identifier of the article.","type":"string"},"set":{"$ref":"#/components/schemas/InventorySet"},"size":{"description":"The size of the article.","type":"string"},"stage":{"description":"The stage of the article.","type":"string"},"store":{"allOf":[{"$ref":"#/components/schemas/StoreMeta"}],"description":"The metadata of the store."},"tags":{"description":"The tags associated with the article.","items":{"type":"string"},"nullable":true,"type":"array"},"tax_identifier":{"description":"The tax identifier of the article.","type":"object"},"total_quantity":{"description":"The total quantity of the article.","minimum":0,"type":"integer"},"trace_id":{"description":"The trace ID of the article.","type":"string"},"track_inventory":{"default":true,"description":"Indicates if the inventory is tracked for the article.","type":"boolean"},"trader":{"description":"The traders associated with the article.","items":{"$ref":"#/components/schemas/Trader1"},"nullable":true,"type":"array"},"uid":{"description":"The unique identifier of the article.","example":"abc123","type":"string"},"weight":{"allOf":[{"$ref":"#/components/schemas/WeightResponse"}],"description":"The weight of the article."}},"required":["brand","company","country_of_origin","dimension","fragile","fynd_article_code","fynd_item_code","identifier","item_id","manufacturer","price","seller_identifier","size","store","total_quantity","uid","weight"],"type":"object"},"InventorySet":{"properties":{"name":{"type":"string"},"quantity":{"type":"integer"},"size_distribution":{"$ref":"#/components/schemas/SizeDistribution"}},"required":["size_distribution"],"type":"object"},"InventoryStockResponse":{"properties":{"items":{"default":[],"items":{"type":"object"},"type":"array"},"page":{"$ref":"#/components/schemas/InventoryPage"}},"required":["page"],"type":"object"},"InventoryUpdateResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/InventoryResponseItem"},"type":"array"},"message":{"description":"It is the success message of the inventory update.","type":"string"}},"required":["message"],"type":"object"},"InventoryValidationResponse":{"properties":{"data":{"type":"object"},"message":{"type":"string"}},"type":"object"},"InvoiceCredSerializer":{"type":"object","properties":{"username":{"type":"string"},"enabled":{"type":"boolean"},"password":{"type":"string"}}},"InvoiceDetailsSerializer":{"type":"object","properties":{"e_invoice":{"$ref":"#/components/schemas/InvoiceCredSerializer"},"e_waybill":{"$ref":"#/components/schemas/InvoiceCredSerializer"}}},"ItemQuery":{"properties":{"brand_uid":{"type":"integer"},"item_code":{"type":"string"},"uid":{"type":"integer"}},"type":"object"},"Items":{"properties":{"cancelled":{"type":"integer"},"cancelled_records":{"items":{"type":"string"},"type":"array"},"company_id":{"type":"integer"},"created_by":{"$ref":"#/components/schemas/UserCommon"},"created_on":{"type":"string"},"failed":{"type":"integer"},"failed_records":{"items":{"type":"string"},"type":"array"},"file_path":{"type":"string"},"id":{"type":"string"},"is_active":{"type":"boolean"},"modified_by":{"$ref":"#/components/schemas/UserCommon"},"modified_on":{"type":"string"},"retry":{"type":"integer"},"stage":{"type":"string"},"succeed":{"type":"integer"},"total":{"type":"integer"},"tracking_url":{"type":"string"}},"type":"object"},"LimitedProductData":{"properties":{"attributes":{"type":"object"},"country_of_origin":{"type":"string"},"identifier":{"type":"object"},"images":{"items":{"type":"string"},"type":"array"},"item_code":{"type":"string"},"name":{"type":"string"},"price":{"type":"object"},"quantity":{"type":"integer"},"short_description":{"type":"string"},"sizes":{"items":{"type":"string"},"type":"array"},"slug":{"type":"string"},"uid":{"type":"integer"}},"type":"object"},"ListSizeGuide":{"properties":{"items":{"items":{"type":"object"},"type":"array"},"page":{"type":"object"}},"type":"object"},"LocationDayWiseSerializer":{"type":"object","properties":{"open":{"type":"boolean"},"weekday":{"type":"string","enum":["sunday","saturday","monday","tuesday","wednesday","thursday","friday"]},"opening":{"$ref":"#/components/schemas/LocationTimingSerializer"},"closing":{"$ref":"#/components/schemas/LocationTimingSerializer"}},"required":["open","weekday"]},"LocationIntegrationType":{"properties":{"inventory":{"enum":["browntape_v2","easyops","holisol","logic","tcnss","increff","liberty","browntape","easyecom","major_brands","jiopos","jockey","omsguru","pulse","sellerware","unicommerce","ethos","sarasuole","vajor","vinculum","jiomart_pos","rbl_sap","ginesys-pos","fyndpos","jiopos_openapi","jiopos_hamleys","westelm","rbl_sap_furniture","vinculum_v2","wizapp"],"type":"string"},"order":{"enum":["browntape_v2","easyops","holisol","logic","tcnss","increff","liberty","browntape","easyecom","major_brands","jiopos","jockey","omsguru","pulse","sellerware","unicommerce","ethos","sarasuole","vajor","vinculum","jiomart_pos","rbl_sap","ginesys-pos","fyndpos","jiopos_openapi","jiopos_hamleys","westelm","rbl_sap_furniture","vinculum_v2","wizapp"],"type":"string"}},"type":"object"},"LocationListSerializer":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/GetLocationSerializer"}},"page":{"$ref":"#/components/schemas/Page"}},"required":[]},"LocationManagerSerializer":{"type":"object","properties":{"email":{"type":"string","format":"email"},"mobile_no":{"$ref":"#/components/schemas/SellerPhoneNumber"},"name":{"type":"string"}},"required":["mobile_no"]},"LocationTimingSerializer":{"type":"object","properties":{"hour":{"type":"integer"},"minute":{"type":"integer"}},"required":["hour","minute"]},"Logo":{"properties":{"aspect_ratio":{"type":"string"},"aspect_ratio_f":{"type":"integer"},"secure_url":{"type":"string"},"url":{"type":"string"}},"type":"object"},"MOQData":{"properties":{"increment_unit":{"default":1,"type":"integer"},"maximum":{"type":"integer"},"minimum":{"default":1,"type":"integer"}},"type":"object"},"ManufacturerResponse":{"properties":{"address":{"description":"The address of the manufacturer.","example":"123 Main St","type":"string"},"is_default":{"description":"Indicates if it is the default manufacturer.","example":true,"type":"boolean"},"name":{"description":"The name of the manufacturer.","example":"Example Manufacturer","type":"string"}},"required":["address","is_default","name"],"type":"object"},"ManufacturerResponse1":{"properties":{"address":{"type":"string"},"is_default":{"type":"boolean"},"name":{"type":"string"}},"type":"object"},"Media":{"properties":{"meta":{"type":"object"},"type":{"type":"string"},"url":{"type":"string"}},"required":["url"],"type":"object"},"Media1":{"properties":{"landscape":{"description":"It is the landscape cdn url for the category.","example":"http://cdn.fynd.com/image.jpg","type":"string"},"logo":{"description":"It is the logo cdn url for the category.","example":"http://cdn.fynd.com/image.jpg","type":"string"},"portrait":{"description":"It is the portrait cdn url for the category.","example":"http://cdn.fynd.com/image.jpg","type":"string"}},"required":["landscape","logo","portrait"],"type":"object"},"Media2":{"properties":{"aspect_ratio":{"type":"string"},"type":{"type":"string"},"url":{"type":"string"}},"type":"object"},"MetaDataListingFilterMetaResponse":{"properties":{"display":{"type":"string"},"filter_types":{"items":{"type":"string"},"type":"array"},"key":{"type":"string"},"units":{"items":{"type":"object"},"type":"array"}},"type":"object"},"MetaDataListingFilterResponse":{"additionalProperties":true,"properties":{"data":{"items":{"$ref":"#/components/schemas/MetaDataListingFilterMetaResponse"},"type":"array"}},"type":"object"},"MetaDataListingResponse":{"properties":{"filter":{"$ref":"#/components/schemas/MetaDataListingFilterResponse"},"sort":{"$ref":"#/components/schemas/MetaDataListingSortResponse"}},"required":["filter","sort"],"type":"object"},"MetaDataListingSortMetaResponse":{"properties":{"display":{"type":"string"},"key":{"type":"string"}},"type":"object"},"MetaDataListingSortResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/MetaDataListingSortMetaResponse"},"type":"array"}},"type":"object"},"MetaFields":{"properties":{"key":{"description":"The key of the metadata. Should be a non-empty string and length should not exceed 30 characters.","maxLength":30,"minLength":1,"type":"string"},"value":{"description":"The value of the metadata. Should be a non-empty string and length should not exceed 100 characters.","maxLength":100,"minLength":1,"type":"string"}},"required":["key","value"],"type":"object"},"NetQuantity":{"properties":{"unit":{"description":"The unit of measurement used for the net quantity of the product.","enum":["kg","g","L","ml","m","cm","nos","pack"],"type":"string"},"value":{"description":"The value of the net quantity of the product.","minimum":0.001,"type":"number"}},"type":"object"},"NetQuantityResponse":{"properties":{"unit":{"type":"string"},"value":{"type":"number"}},"type":"object"},"NextSchedule":{"type":"object","properties":{"start":{"type":"string"},"end":{"type":"string"}}},"OptInPostRequest":{"properties":{"brand_ids":{"items":{"type":"integer"},"type":"array"},"company_id":{"type":"integer"},"enabled":{"default":true,"type":"boolean"},"opt_level":{"type":"string"},"platform":{"type":"string"},"store_ids":{"items":{"type":"integer"},"type":"array"}},"required":["opt_level"],"type":"object"},"OptinCompanyBrandDetailsView":{"properties":{"items":{"items":{"$ref":"#/components/schemas/CompanyBrandDetail"},"type":"array"},"page":{"$ref":"#/components/schemas/Page"}},"type":"object"},"OptinCompanyDetail":{"properties":{"business_type":{"type":"string"},"company_type":{"type":"string"},"name":{"type":"string"},"uid":{"type":"integer"}},"type":"object"},"OptinCompanyMetrics":{"properties":{"brand":{"type":"integer"},"company":{"type":"string"},"store":{"type":"integer"}},"type":"object"},"OptinStoreDetails":{"properties":{"items":{"items":{"$ref":"#/components/schemas/StoreDetail"},"type":"array"},"page":{"$ref":"#/components/schemas/Page"}},"type":"object"},"OwnerAppItemResponse":{"properties":{"alt_text":{"default":{},"type":"object"},"is_cod":{"default":true,"type":"boolean"},"is_gift":{"default":false,"type":"boolean"},"moq":{"allOf":[{"$ref":"#/components/schemas/MOQData"}],"default":{"increment_unit":1,"minimum":1}},"seo":{"allOf":[{"$ref":"#/components/schemas/SEOData"}],"default":{"description":"","title":"","sitemap":{},"breadcrumbs":[],"meta_tags":[]}}},"type":"object"},"PTErrorResponse":{"properties":{"code":{"type":"string"},"errors":{"type":"object"},"message":{"type":"string"},"meta":{"type":"object"},"status":{"type":"integer"}},"type":"object"},"PageResponse":{"properties":{"current":{"description":"It is the current page of the page response schema.","example":"1","type":"string"},"has_next":{"description":"It is the bool indicates if there is a  next page.","example":true,"type":"boolean"},"has_previous":{"description":"It is the bool indicates if there is a  previous page.","example":true,"type":"boolean"},"item_total":{"description":"It is the total number of item present for the filter.","example":10000,"type":"integer"},"size":{"description":"It is the size of each page.","example":10,"type":"integer"}},"type":"object"},"PageResponse1":{"properties":{"current":{"type":"integer"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"item_total":{"type":"integer"},"size":{"type":"integer"},"type":{"type":"string"}},"type":"object"},"PageResponseType":{"properties":{"current":{"type":"integer"},"has_next":{"type":"boolean"},"next":{"type":"integer"},"total_count":{"type":"integer"}},"required":["current","has_next","next","total_count"],"type":"object"},"Price":{"properties":{"currency":{"type":"string"},"max_effective":{"type":"number"},"max_marked":{"type":"number"},"min_effective":{"type":"number"},"min_marked":{"type":"number"}},"type":"object"},"Price1":{"properties":{"currency_code":{"type":"string"},"currency_symbol":{"type":"string"},"max":{"type":"number"},"min":{"type":"number"}},"type":"object"},"PriceArticle":{"properties":{"currency":{"type":"string"},"effective":{"type":"number"},"marked":{"type":"number"},"tp_notes":{"type":"object"},"transfer":{"type":"number"}},"type":"object"},"PriceMeta":{"properties":{"currency":{"description":"The currency used for the prices.","example":"USD","type":"string"},"effective":{"description":"The effective price.","example":79.99,"type":"number"},"marked":{"description":"The marked price.","example":99.99,"type":"number"},"tp_notes":{"description":"Additional notes for the transfer price.","type":"object"},"transfer":{"description":"The transfer price.","example":89.99,"type":"number"},"updated_at":{"description":"The date and time of the last update.","format":"date-time","type":"string"}},"required":["currency","effective","marked","transfer"],"type":"object"},"ProdcutTemplateCategoriesResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/CategoriesResponse"},"type":"array"},"page":{"$ref":"#/components/schemas/Page"}},"type":"object"},"Product":{"type":"object","properties":{"name":{"type":"string"},"list_enabled":{"type":"boolean"},"category":{"type":"string"},"type":{"type":"string"},"supported_validations":{"type":"array","items":{"$ref":"#/components/schemas/SupportedValidationsSchema"}}}},"ProductAttributesResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/AttributeMasterSerializer"},"type":"array"}},"required":["items"],"type":"object"},"ProductBrand":{"properties":{"action":{"$ref":"#/components/schemas/Action"},"logo":{"$ref":"#/components/schemas/Media"},"name":{"type":"string"},"uid":{"type":"integer"}},"type":"object"},"ProductBulkAssets":{"properties":{"batch_id":{"type":"string"},"company_id":{"type":"integer"},"url":{"format":"url","type":"string"},"user":{"type":"object"}},"required":["url","user"],"type":"object"},"ProductBulkRequest":{"properties":{"cancelled":{"type":"integer"},"cancelled_records":{"items":{"type":"object"},"type":"array"},"company_id":{"type":"integer"},"created_by":{"$ref":"#/components/schemas/UserDetail1"},"created_on":{"format":"date-time","type":"string"},"failed":{"type":"integer"},"failed_records":{"items":{"type":"object"},"type":"array"},"file_path":{"format":"url","type":"string"},"is_active":{"type":"boolean"},"modified_by":{"$ref":"#/components/schemas/UserDetail1"},"modified_on":{"format":"date-time","type":"string"},"stage":{"type":"string"},"succeed":{"type":"integer"},"template":{"$ref":"#/components/schemas/ProductTemplate"},"template_tag":{"type":"string"},"total":{"type":"integer"}},"type":"object"},"ProductBulkRequestList":{"properties":{"items":{"items":{"$ref":"#/components/schemas/ProductBulkRequest"},"type":"array"},"page":{"$ref":"#/components/schemas/Page"}},"type":"object"},"ProductBundleItem":{"properties":{"allow_remove":{"type":"boolean"},"auto_add_to_cart":{"type":"boolean"},"auto_select":{"type":"boolean"},"max_quantity":{"maximum":99,"minimum":1,"type":"integer"},"min_quantity":{"maximum":99,"minimum":1,"type":"integer"},"product_uid":{"type":"integer"}},"required":["max_quantity","min_quantity","product_uid"],"type":"object"},"ProductBundleRequest":{"properties":{"choice":{"type":"string"},"company_id":{"type":"integer"},"created_by":{"type":"object"},"created_on":{"format":"date-time","type":"string"},"is_active":{"type":"boolean"},"logo":{"nullable":true,"type":"string"},"meta":{"type":"object"},"modified_by":{"type":"object"},"modified_on":{"format":"date-time","type":"string"},"name":{"type":"string"},"page_visibility":{"items":{"enum":["pdp"],"type":"string"},"type":"array"},"products":{"items":{"$ref":"#/components/schemas/ProductBundleItem"},"maxItems":10,"type":"array"},"same_store_assignment":{"default":true,"type":"boolean"},"slug":{"type":"string"}},"required":["choice","is_active","name","products","slug"],"type":"object"},"ProductBundleUpdateRequest":{"properties":{"choice":{"type":"string"},"company_id":{"type":"integer"},"is_active":{"type":"boolean"},"logo":{"nullable":true,"type":"string"},"meta":{"type":"object"},"modified_by":{"type":"object"},"modified_on":{"format":"date-time","type":"string"},"name":{"type":"string"},"page_visibility":{"items":{"enum":["pdp"],"type":"string"},"type":"array"},"products":{"items":{"$ref":"#/components/schemas/ProductBundleItem"},"maxItems":10,"type":"array"},"same_store_assignment":{"default":true,"type":"boolean"},"slug":{"type":"string"}},"required":["choice","is_active","name","products","slug"],"type":"object"},"ProductConfigurationDownloads":{"properties":{"data":{"items":{"type":"object"},"type":"array"},"multivalue":{"type":"boolean"}},"type":"object"},"ProductCreateUpdateSchemaV2":{"properties":{"_custom_json":{"type":"object"},"action":{"enum":["upsert","update","delete"],"type":"string"},"attributes":{"type":"object"},"brand_uid":{"type":"integer"},"bulk_job_id":{"type":"string"},"category_slug":{"type":"string"},"change_request_id":{"nullable":true,"type":"string"},"company_id":{"type":"integer"},"country_of_origin":{"type":"string"},"currency":{"type":"string"},"custom_order":{"$ref":"#/components/schemas/CustomOrder"},"departments":{"items":{"type":"integer"},"maxItems":1,"minItems":1,"type":"array"},"description":{"type":"string"},"highlights":{"items":{"nullable":true,"type":"string"},"nullable":true,"type":"array"},"is_active":{"default":true,"type":"boolean"},"is_dependent":{"default":false,"type":"boolean"},"is_image_less_product":{"default":false,"type":"boolean"},"is_set":{"default":false,"type":"boolean"},"item_code":{"pattern":"^[A-Za-z0-9-_@,#\\(\\)\\. ]+$","type":"string"},"item_type":{"enum":["standard","set","composite","digital"],"type":"string"},"media":{"items":{"$ref":"#/components/schemas/Media"},"maxItems":30,"nullable":true,"type":"array"},"multi_size":{"default":true,"type":"boolean"},"name":{"maxLength":300,"minLength":1,"type":"string"},"net_quantity":{"$ref":"#/components/schemas/NetQuantity"},"no_of_boxes":{"default":1,"minimum":1,"type":"integer"},"product_group_tag":{"items":{"type":"string"},"maxItems":7,"type":"array"},"product_publish":{"$ref":"#/components/schemas/ProductPublish1"},"requester":{"default":"user","enum":["admin","user"],"type":"string"},"return_config":{"$ref":"#/components/schemas/ReturnConfig"},"short_description":{"maxLength":50,"type":"string"},"size_guide":{"type":"string"},"sizes":{"items":{"type":"object"},"type":"array"},"slug":{"pattern":"^[a-z0-9-_]*$","type":"string"},"tags":{"items":{"type":"string"},"type":"array"},"tax_identifier":{"$ref":"#/components/schemas/TaxIdentifier"},"teaser_tag":{"$ref":"#/components/schemas/TeaserTag"},"template_tag":{"type":"string"},"trader":{"items":{"$ref":"#/components/schemas/Trader"},"type":"array"},"uid":{"nullable":true,"type":"integer"},"variant_group":{"type":"object"},"variant_media":{"type":"object"},"variants":{"type":"object"}},"required":["brand_uid","category_slug","company_id","country_of_origin","currency","departments","item_code","item_type","name","return_config","sizes","slug","tax_identifier","template_tag","trader"],"type":"object"},"ProductDetail":{"properties":{"attributes":{"type":"object"},"brand":{"$ref":"#/components/schemas/ProductBrand"},"color":{"type":"string"},"description":{"type":"string"},"grouped_attributes":{"items":{"$ref":"#/components/schemas/ProductDetailGroupedAttribute"},"type":"array"},"has_variant":{"type":"boolean"},"highlights":{"items":{"type":"string"},"type":"array"},"image_nature":{"type":"string"},"item_code":{"type":"string"},"item_type":{"type":"string"},"medias":{"items":{"$ref":"#/components/schemas/Media"},"type":"array"},"name":{"type":"string"},"product_online_date":{"format":"date-time","type":"string"},"promo_meta":{"type":"object"},"rating":{"type":"number"},"rating_count":{"type":"integer"},"short_description":{"type":"string"},"similars":{"items":{"type":"string"},"type":"array"},"slug":{"type":"string"},"teaser_tag":{"type":"object"},"tryouts":{"items":{"type":"string"},"type":"array"},"type":{"type":"string"},"uid":{"type":"integer"}},"required":["slug"],"type":"object"},"ProductDetailAttribute":{"properties":{"key":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}},"type":"object"},"ProductDetailGroupedAttribute":{"properties":{"details":{"items":{"$ref":"#/components/schemas/ProductDetailAttribute"},"type":"array"},"title":{"type":"string"}},"type":"object"},"ProductDownloadsResponse":{"properties":{"items":{"description":"The items of the job.","items":{"$ref":"#/components/schemas/ProductTemplateExportResponse"},"type":"array"}},"type":"object"},"ProductFilters":{"properties":{"key":{"$ref":"#/components/schemas/ProductFiltersKey"},"values":{"items":{"$ref":"#/components/schemas/ProductFiltersValue"},"type":"array"}},"required":["key","values"],"type":"object"},"ProductFiltersKey":{"properties":{"display":{"type":"string"},"kind":{"type":"string"},"logo":{"format":"url","type":"string"},"name":{"type":"string"},"operators":{"items":{"type":"string"},"type":"array"}},"required":["display","name"],"type":"object"},"ProductFiltersValue":{"properties":{"count":{"type":"integer"},"currency_code":{"type":"string"},"currency_symbol":{"type":"string"},"display":{"type":"string"},"display_format":{"type":"string"},"is_selected":{"type":"boolean"},"max":{"type":"integer"},"min":{"type":"integer"},"query_format":{"type":"string"},"selected_max":{"type":"integer"},"selected_min":{"type":"integer"},"value":{}},"required":["display","is_selected","value"],"type":"object"},"ProductListingDetail":{"properties":{"attributes":{"type":"object"},"brand":{"$ref":"#/components/schemas/ProductBrand"},"color":{"type":"string"},"description":{"type":"string"},"discount":{"type":"string"},"grouped_attributes":{"items":{"$ref":"#/components/schemas/ProductDetailGroupedAttribute"},"type":"array"},"has_variant":{"type":"boolean"},"highlights":{"items":{"type":"string"},"type":"array"},"image_nature":{"type":"string"},"item_code":{"type":"string"},"item_type":{"type":"string"},"medias":{"items":{"$ref":"#/components/schemas/Media"},"type":"array"},"name":{"type":"string"},"price":{"$ref":"#/components/schemas/ProductListingPrice"},"product_online_date":{"format":"date-time","type":"string"},"promo_meta":{"type":"object"},"rating":{"type":"number"},"rating_count":{"type":"integer"},"sellable":{"type":"boolean"},"short_description":{"type":"string"},"similars":{"items":{"type":"string"},"type":"array"},"slug":{"type":"string"},"teaser_tag":{"type":"object"},"tryouts":{"items":{"type":"string"},"type":"array"},"type":{"type":"string"},"uid":{"type":"integer"}},"required":["slug"],"type":"object"},"ProductListingPrice":{"properties":{"effective":{"$ref":"#/components/schemas/Price1"},"marked":{"$ref":"#/components/schemas/Price1"}},"type":"object"},"ProductListingResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/Product"},"type":"array"},"page":{"$ref":"#/components/schemas/Page"}},"type":"object"},"ProductListingResponseV2":{"properties":{"items":{"items":{"$ref":"#/components/schemas/ProductSchemaV2"},"type":"array"},"page":{"$ref":"#/components/schemas/Page"}},"type":"object"},"ProductPublish":{"properties":{"is_set":{"default":false,"type":"boolean"},"product_online_date":{"format":"date-time","type":"string"}},"type":"object"},"ProductPublish1":{"properties":{"is_set":{"default":false,"type":"boolean"},"product_online_date":{"format":"date-time","type":"string"}},"type":"object"},"ProductPublished":{"properties":{"is_set":{"type":"boolean"},"product_online_date":{"type":"integer"}},"type":"object"},"ProductReturnConfigSerializer":{"type":"object","properties":{"on_same_store":{"type":"boolean"},"store_uid":{"type":"integer"}}},"ProductReturnConfigBaseSerializer":{"properties":{"returnable":{"description":"Boolean Flag for item returnable","type":"boolean"},"time":{"description":"Valid return time for an item","type":"integer"},"unit":{"description":"Unit of return config days|hours","enum":["days","hours"],"type":"string"}},"required":["returnable","time","unit"],"type":"object"},"ProductSchemaV2":{"properties":{"_custom_json":{"type":"object"},"all_company_ids":{"items":{"type":"integer"},"type":"array"},"all_identifiers":{"items":{"type":"string"},"type":"array"},"all_sizes":{"items":{"type":"object"},"type":"array"},"attributes":{"type":"object"},"brand":{"$ref":"#/components/schemas/Brand"},"brand_uid":{"type":"integer"},"category":{"type":"object"},"category_slug":{"type":"string"},"category_uid":{"type":"integer"},"color":{"type":"string"},"company_id":{"type":"integer"},"country_of_origin":{"type":"string"},"created_by":{"type":"object"},"created_on":{"format":"date-time","type":"string"},"currency":{"type":"string"},"custom_order":{"type":"object"},"departments":{"items":{"type":"integer"},"type":"array"},"description":{"type":"string"},"highlights":{"items":{"type":"string"},"type":"array"},"hsn_code":{"type":"string"},"id":{"type":"string"},"image_nature":{"type":"string"},"images":{"items":{"$ref":"#/components/schemas/Image"},"type":"array"},"is_active":{"type":"boolean"},"is_dependent":{"type":"boolean"},"is_expirable":{"type":"boolean"},"is_image_less_product":{"type":"boolean"},"is_physical":{"type":"boolean"},"is_set":{"type":"boolean"},"item_code":{"type":"string"},"item_type":{"type":"string"},"l3_mapping":{"items":{"type":"string"},"type":"array"},"media":{"items":{"$ref":"#/components/schemas/Media"},"type":"array"},"modified_by":{"type":"object"},"modified_on":{"format":"date-time","type":"string"},"moq":{"type":"object"},"multi_size":{"type":"boolean"},"name":{"type":"string"},"net_quantity":{"$ref":"#/components/schemas/NetQuantityResponse"},"no_of_boxes":{"type":"integer"},"pending":{"type":"string"},"primary_color":{"type":"string"},"product_group_tag":{"items":{"type":"string"},"type":"array"},"product_publish":{"$ref":"#/components/schemas/ProductPublish"},"return_config":{"$ref":"#/components/schemas/ReturnConfigResponse"},"short_description":{"type":"string"},"size_guide":{"type":"string"},"sizes":{"items":{"type":"object"},"type":"array"},"slug":{"type":"string"},"stage":{"type":"string"},"tags":{"items":{"type":"string"},"type":"array"},"tax_identifier":{"type":"object"},"teaser_tag":{"type":"object"},"template_tag":{"type":"string"},"trader":{"items":{"$ref":"#/components/schemas/Trader"},"type":"array"},"uid":{"type":"integer"},"variant_group":{"type":"object"},"variant_media":{"type":"object"},"variants":{"type":"object"},"verified_by":{"$ref":"#/components/schemas/VerifiedBy"},"verified_on":{"type":"string"}},"type":"object"},"ProductSize":{"properties":{"max":{"minimum":1,"type":"integer"},"min":{"minimum":1,"type":"integer"}},"required":["max","min"],"type":"object"},"ProductSizeDeleteDataResponse":{"properties":{"company_id":{"type":"integer"},"item_id":{"type":"integer"},"size":{"type":"string"}},"type":"object"},"ProductSizeDeleteResponse":{"properties":{"data":{"$ref":"#/components/schemas/ProductSizeDeleteDataResponse"},"success":{"type":"boolean"}},"type":"object"},"ProductSortOn":{"properties":{"is_selected":{"type":"boolean"},"name":{"type":"string"},"value":{"type":"string"}},"type":"object"},"ProductTagsViewResponse":{"properties":{"items":{"items":{"type":"string"},"type":"array"}},"type":"object"},"ProductTemplate":{"properties":{"attributes":{"default":[],"items":{"type":"string"},"nullable":true,"type":"array"},"categories":{"default":[],"items":{"type":"string"},"nullable":true,"type":"array"},"created_by":{"type":"object"},"created_on":{"format":"date-time","type":"string"},"departments":{"default":[],"items":{"type":"string"},"nullable":true,"type":"array"},"description":{"type":"string"},"is_active":{"default":true,"type":"boolean"},"is_archived":{"type":"boolean"},"is_expirable":{"type":"boolean"},"is_physical":{"type":"boolean"},"logo":{"type":"string"},"modified_by":{"type":"object"},"modified_on":{"format":"date-time","type":"string"},"name":{"type":"string"},"slug":{"type":"string"},"tag":{"type":"string"}},"required":["is_expirable","is_physical","slug"],"type":"object"},"ProductTemplateDownloadsExport":{"properties":{"filters":{"allOf":[{"$ref":"#/components/schemas/ProductTemplateExportFilterRequest"}],"description":"This is the filters of the file for the export."},"notification_emails":{"description":"The list of the emails to be notified after the completion of the job.","items":{"format":"email","type":"string"},"type":"array"},"type":{"description":"This is the type of the file for the export.","nullable":true,"type":"string"}},"type":"object"},"ProductTemplateExportFilterRequest":{"properties":{"brands":{"description":"The list of the brands that needs to be exported.","items":{"type":"string"},"type":"array"},"catalogue_types":{"description":"The list of the type of the catalog such as set, standard and composite.","items":{"type":"string"},"minItems":1,"type":"array"},"from_date":{"description":"The modified on date from which the data needs to be exported.","format":"date-time","type":"string"},"templates":{"description":"The list of the templates that needs to be exported.","items":{"type":"string"},"minItems":1,"type":"array"},"to_date":{"description":"The modified on date till when the data needs to be exported.","format":"date-time","type":"string"}},"required":["catalogue_types","templates"],"type":"object"},"ProductTemplateExportResponse":{"properties":{"completed_on":{"description":"Completion datetime of the job","format":"date-time","type":"string"},"created_by":{"allOf":[{"$ref":"#/components/schemas/UserInfo1"}],"description":"The user that created the job."},"filters":{"description":"The filters that needs to be exported.","type":"object"},"modified_on":{"description":"Modification date of the job","format":"date-time","type":"string"},"notification_emails":{"description":"The notification emails for the job.","items":{"format":"email","type":"string"},"type":"array"},"seller_id":{"description":"The seller id that needs to be exported.","type":"integer"},"status":{"description":"The status of the job.","enum":["pending","running","success"],"type":"string"},"task_id":{"description":"The task id of the job.","type":"string"},"type":{"description":"The type of file that needs to be exported.","type":"string"},"url":{"description":"The filters that needs to be exported.","format":"url","type":"string"}},"required":["seller_id","task_id"],"type":"object"},"ProductVariants":{"properties":{"brand_uid":{"type":"integer"},"category_uid":{"type":"integer"},"item_code":{"type":"string"},"media":{"items":{"$ref":"#/components/schemas/Media"},"type":"array"},"name":{"type":"string"},"uid":{"type":"integer"}},"type":"object"},"ProductVariantsResponse":{"properties":{"page":{"$ref":"#/components/schemas/Page"},"variants":{"items":{"$ref":"#/components/schemas/ProductVariants"},"type":"array"}},"type":"object"},"Properties":{"properties":{"brand_uid":{"type":"object"},"category_slug":{"type":"object"},"command":{"type":"object"},"country_of_origin":{"type":"object"},"currency":{"type":"object"},"custom_order":{"type":"object"},"description":{"type":"object"},"highlights":{"type":"object"},"hsn_code":{"type":"object"},"is_active":{"type":"object"},"is_dependent":{"type":"object"},"item_code":{"type":"object"},"item_type":{"type":"object"},"media":{"type":"object"},"multi_size":{"type":"object"},"name":{"type":"object"},"no_of_boxes":{"type":"object"},"product_group_tag":{"type":"object"},"product_publish":{"type":"object"},"return_config":{"type":"object"},"short_description":{"type":"object"},"size_guide":{"type":"object"},"sizes":{"type":"object"},"slug":{"type":"object"},"tags":{"type":"object"},"teaser_tag":{"type":"object"},"trader":{"type":"object"},"trader_type":{"type":"object"},"variants":{"type":"object"}},"type":"object"},"Quantities":{"properties":{"damaged":{"$ref":"#/components/schemas/QuantityBase"},"not_available":{"$ref":"#/components/schemas/QuantityBase"},"order_committed":{"$ref":"#/components/schemas/QuantityBase"},"sellable":{"$ref":"#/components/schemas/QuantityBase"}},"type":"object"},"QuantitiesArticle":{"properties":{"damaged":{"$ref":"#/components/schemas/Quantity"},"not_available":{"$ref":"#/components/schemas/Quantity"},"order_committed":{"$ref":"#/components/schemas/Quantity"},"sellable":{"$ref":"#/components/schemas/Quantity"}},"type":"object"},"Quantity":{"properties":{"count":{"type":"integer"}},"type":"object"},"QuantityBase":{"properties":{"count":{"type":"integer"},"updated_at":{"format":"date-time","type":"string"}},"type":"object"},"ReturnConfig":{"type":"object","properties":{"returnable":{"type":"boolean","nullable":true},"time":{"type":"number","nullable":true},"unit":{"type":"string","nullable":true}}},"ReturnConfig1":{"properties":{"returnable":{"default":false,"description":"Indicates if the item is returnable.","example":true,"type":"boolean"},"time":{"description":"The return time in days or hours.","example":7,"minimum":0,"type":"integer"},"unit":{"description":"The unit of return time.","enum":["days","hours"],"example":"days","type":"string"}},"type":"object"},"ReturnConfig2":{"properties":{"returnable":{"type":"boolean"},"time":{"minimum":0,"type":"integer"},"unit":{"enum":["days","hours"],"type":"string"}},"type":"object"},"ReturnConfigResponse":{"properties":{"returnable":{"type":"boolean"},"time":{"type":"integer"},"unit":{"type":"string"}},"type":"object"},"Sitemap":{"properties":{"priority":{"type":"number"},"frequency":{"type":"string"}},"type":"object"},"ApplicationItemSeoAction":{"properties":{"page":{"type":"object"},"type":{"type":"string"}},"type":"object"},"ApplicationItemSeoBreadcrumbs":{"properties":{"url":{"type":"string"},"action":{"items":{"$ref":"#/components/schemas/ApplicationItemSeoAction"},"type":"array"}},"type":"object"},"ApplicationItemSeoMetaTagItem":{"properties":{"key":{"type":"string"},"value":{"type":"string"}},"type":"object"},"ApplicationItemSeoMetaTags":{"properties":{"title":{"type":"string"},"items":{"items":{"$ref":"#/components/schemas/ApplicationItemSeoMetaTagItem"},"type":"array"}},"type":"object"},"Metatags":{"properties":{"title":{"type":"string"},"items":{"items":{"$ref":"#/components/schemas/ApplicationItemSeoMetaTags"},"type":"array"}},"type":"object"},"SizePromotionThreshold":{"properties":{"threshold_type":{"type":"string"},"threshold_value":{"type":"integer"}},"type":"object"},"SEOData":{"properties":{"description":{"default":"","type":"string"},"title":{"default":"","type":"string"},"sitemap":{"$ref":"#/components/schemas/Sitemap"},"breadcrumbs":{"items":{"$ref":"#/components/schemas/ApplicationItemSeoBreadcrumbs"},"type":"array"},"meta_tags":{"items":{"$ref":"#/components/schemas/Metatags"},"type":"array"},"canonical_url":{"default":"","type":"string"}},"type":"object"},"SearchKeywordResult":{"properties":{"query":{"type":"object"},"sort_on":{"type":"string"}},"required":["query","sort_on"],"type":"object"},"SearchableAttribute":{"properties":{"key":{"description":"The attribute key to search on. This key matches the solr document key","type":"string"},"name":{"description":"The name of key to search on. This is for displaying purposes on platform","type":"string"},"priority":{"description":"Order in which the searchable attribute should kick in. Higher the priority, higher the weight considered while searching","type":"number"}},"required":["key","name","priority"],"type":"object"},"SecondLevelChild":{"properties":{"_custom_json":{"type":"object"},"action":{"$ref":"#/components/schemas/Action"},"banners":{"$ref":"#/components/schemas/ImageUrls"},"childs":{"items":{"$ref":"#/components/schemas/ThirdLevelChild"},"type":"array"},"name":{"type":"string"},"slug":{"type":"string"},"uid":{"type":"integer"}},"type":"object"},"SellerPhoneNumber":{"type":"object","properties":{"country_code":{"type":"integer"},"number":{"type":"string","maxLength":12,"pattern":"^[0-9]*$"}},"required":["country_code","number"]},"SeoDetail":{"properties":{"description":{"type":"string"},"title":{"type":"string"},"sitemap":{"type":"object"},"breadcrumbs":{"items":{"$ref":"#/components/schemas/ApplicationItemSeoBreadcrumbs"},"type":"array"},"meta_tags":{"items":{"$ref":"#/components/schemas/Metatags"},"type":"array"},"canonical_url":{"type":"string"}},"type":"object"},"SetSize":{"properties":{"pieces":{"maximum":100,"minimum":1,"type":"integer"},"size":{"type":"string"}},"required":["pieces","size"],"type":"object"},"SingleCategoryResponse":{"properties":{"data":{"$ref":"#/components/schemas/Category"}},"type":"object"},"SingleProductResponse":{"properties":{"data":{"$ref":"#/components/schemas/ProductSchemaV2"}},"type":"object"},"Size":{"properties":{"display":{"type":"string"},"is_available":{"type":"boolean"},"quantity":{"type":"integer"},"value":{"type":"string"}},"type":"object"},"SizeDistribution":{"properties":{"sizes":{"items":{"$ref":"#/components/schemas/SetSize"},"type":"array"}},"required":["sizes"],"type":"object"},"SizeGuideResponse":{"properties":{"active":{"type":"boolean"},"brand_id":{"type":"integer"},"company_id":{"type":"integer"},"created_by":{"type":"object"},"created_on":{"type":"string"},"guide":{"type":"object"},"id":{"type":"string"},"modified_by":{"type":"object"},"modified_on":{"type":"string"},"name":{"type":"string"},"subtitle":{"type":"string"},"tag":{"type":"string"},"title":{"type":"string"}},"type":"object"},"StoreAssignResponse":{"properties":{"_id":{"type":"string"},"article_assignment":{"$ref":"#/components/schemas/ArticleAssignment1"},"company_id":{"type":"integer"},"group_id":{"type":"string"},"index":{"type":"integer"},"item_id":{"type":"integer"},"meta":{"type":"object"},"price_effective":{"type":"integer"},"price_marked":{"type":"integer"},"quantity":{"type":"integer"},"s_city":{"type":"string"},"size":{"type":"string"},"status":{"type":"boolean"},"store_id":{"type":"integer"},"store_pincode":{"type":"integer"},"strategy_wise_listing":{"default":[],"items":{"type":"object"},"type":"array"},"uid":{"type":"string"}},"required":["article_assignment","item_id","quantity","size","status"],"type":"object"},"StoreDetail":{"type":"object","properties":{"store_name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"country":{"type":"string"},"country_code":{"type":"string"},"zip_code":{"type":"string"},"state_code":{"type":"string"},"gstin":{"type":"string","nullable":true},"display_address":{"type":"string"},"sector":{"type":"string"},"store_id":{"type":"string"}}},"StoreMeta":{"type":"object","properties":{"additional_contact_details":{"type":"object","nullable":true},"timing":{"type":"array","nullable":true,"items":{"type":"object"}},"notification_emails":{"type":"array","nullable":true,"items":{"type":"string"}},"gst_number":{"type":"string","nullable":true},"ewaybill_portal_details":{"type":"object","nullable":true},"einvoice_portal_details":{"$ref":"#/components/schemas/EInvoicePortalDetails"},"gst_credentials":{"$ref":"#/components/schemas/StoreGstCredentials"},"stage":{"type":"string"},"product_return_config":{"type":"object","nullable":true},"documents":{"$ref":"#/components/schemas/StoreDocuments"},"display_name":{"type":"string"}},"required":["display_name","gst_credentials","stage"]},"SuccessResponse":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}},"SuccessResponse1":{"properties":{"success":{"type":"boolean"},"uid":{"type":"integer"}},"type":"object"},"TaxIdentifier":{"properties":{"hsn_code":{"minLength":4,"type":"string"},"hsn_code_id":{"type":"string"},"reporting_hsn":{"minLength":6,"type":"string"}},"type":"object"},"TaxSlab":{"properties":{"cess":{"type":"number"},"effective_date":{"format":"date-time","type":"string"},"rate":{"enum":[0,0.25,1.5,2.5,3,5,10,12,18,28],"type":"number"},"threshold":{"type":"number"}},"required":["effective_date","rate","threshold"],"type":"object"},"TeaserTag":{"properties":{"tag":{"nullable":true,"type":"string"},"url":{"format":"url","nullable":true,"pattern":"^(?:http|ftp)s?://(?:[^:@]+?:[^:@]*?@|)(?:(?:[A-Z0-9](?:[A-Z0-9-]{0,61}[A-Z0-9])?\\.)+(?:[A-Z]{2,6}\\.?|[A-Z0-9-]{2,}\\.?)|\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}|\\[?[A-F0-9]*:[A-F0-9:]+\\]?)(?::\\d+)?(?:/?|[/?](\\S| )+)$","type":"string"}},"type":"object"},"TemplateDetails":{"properties":{"attributes":{"default":[],"items":{"type":"string"},"nullable":true,"type":"array"},"categories":{"default":[],"items":{"type":"string"},"nullable":true,"type":"array"},"departments":{"default":[],"items":{"type":"string"},"nullable":true,"type":"array"},"description":{"type":"string"},"id":{"type":"string"},"is_active":{"default":true,"type":"boolean"},"is_archived":{"type":"boolean"},"is_expirable":{"type":"boolean"},"is_physical":{"type":"boolean"},"logo":{"type":"string"},"name":{"type":"string"},"slug":{"type":"string"},"tag":{"type":"string"}},"required":["is_expirable","is_physical","slug"],"type":"object"},"TemplateValidationData":{"properties":{"global_validation":{"$ref":"#/components/schemas/GlobalValidation"},"template_validation":{"type":"object"}},"type":"object"},"TemplatesResponse":{"properties":{"items":{"$ref":"#/components/schemas/ProductTemplate"},"page":{"$ref":"#/components/schemas/Page"}},"type":"object"},"TemplatesValidationResponse":{"properties":{"data":{"$ref":"#/components/schemas/TemplateValidationData"},"template_details":{"$ref":"#/components/schemas/TemplateDetails"}},"type":"object"},"ThirdLevelChild":{"properties":{"_custom_json":{"type":"object"},"action":{"$ref":"#/components/schemas/Action"},"banners":{"$ref":"#/components/schemas/ImageUrls"},"childs":{"items":{"type":"object"},"type":"array"},"name":{"type":"string"},"slug":{"type":"string"},"uid":{"type":"integer"}},"type":"object"},"Trader":{"properties":{"address":{"items":{"type":"string"},"type":"array"},"name":{"maxLength":300,"minLength":1,"type":"string"},"type":{"enum":["Importer","Packer","Manufacturer","Marketer"],"type":"string"}},"required":["name"],"type":"object"},"Trader1":{"properties":{"address":{"items":{"type":"string"},"type":"array"},"name":{"type":"string"},"type":{"enum":["Manufacturer","Importer","Packer","Marketer"],"type":"string"}},"required":["address","name","type"],"type":"object"},"Trader2":{"properties":{"address":{"items":{"type":"string"},"type":"array"},"name":{"type":"string"},"type":{"enum":["Manufacturer","Importer","Packer","Marketer"],"type":"string"}},"type":"object"},"UpdateCollection":{"properties":{"_custom_json":{"type":"object"},"_locale_language":{"type":"object"},"_schedule":{"$ref":"#/components/schemas/CollectionSchedule"},"allow_facets":{"type":"boolean"},"allow_sort":{"type":"boolean"},"badge":{"$ref":"#/components/schemas/CollectionBadge"},"banners":{"$ref":"#/components/schemas/CollectionBanner"},"description":{"type":"string"},"is_active":{"type":"boolean"},"is_visible":{"type":"boolean"},"logo":{"$ref":"#/components/schemas/CollectionImage"},"meta":{"type":"object"},"modified_by":{"allOf":[{"$ref":"#/components/schemas/UserInfo"}],"description":"User info.","nullable":true,"type":"string"},"name":{"type":"string"},"priority":{"type":"integer"},"published":{"type":"boolean"},"query":{"items":{"$ref":"#/components/schemas/CollectionQuery"},"type":"array"},"seo":{"$ref":"#/components/schemas/SeoDetail"},"slug":{"type":"string"},"sort_on":{"type":"string"},"tags":{"items":{"type":"string"},"type":"array"},"type":{"type":"string"},"visible_facets_keys":{"items":{"type":"string"},"type":"array"}},"type":"object"},"UpdateSearchConfigurationRequest":{"properties":{"application_id":{"description":"The application id where custom search configuration is set","type":"string"},"company_id":{"description":"The company id where custom search configuration is set","type":"integer"},"created_by":{"allOf":[{"$ref":"#/components/schemas/UserSerializer"}],"description":"The user who created the search configuration."},"created_on":{"description":"The date and time when the search configuration was created.","example":"2022-03-15T14:56:22.123Z","format":"date-time","type":"string"},"is_proximity_enabled":{"default":false,"description":"Flag indicating if proximity search is enabled for this attribute.","type":"boolean"},"modified_by":{"allOf":[{"$ref":"#/components/schemas/UserSerializer"}],"description":"The user who modified the search configuration."},"modified_on":{"description":"The date and time when the search configuration was last modified.","example":"2022-03-16T09:12:33.456Z","format":"date-time","type":"string"},"proximity":{"default":1,"description":"Proximity distance configuration","type":"integer"},"searchable_attributes":{"description":"The searchable attributes defined on the application.","items":{"$ref":"#/components/schemas/SearchableAttribute"},"type":"array"}},"required":["application_id","company_id"],"type":"object"},"UpdateSearchConfigurationResponse":{"properties":{"success":{"type":"boolean"}},"type":"object"},"UpdatedResponse":{"properties":{"items_not_updated":{"items":{"type":"integer"},"type":"array"},"message":{"type":"string"}},"type":"object"},"UserCommon":{"properties":{"company_id":{"type":"integer"},"user_id":{"type":"string"},"username":{"type":"string"}},"type":"object"},"UserDetail":{"properties":{"contact":{"description":"The contact details of the user.","type":"string"},"super_user":{"description":"A flag indicating whether the user is a super user.","type":"boolean"},"user_id":{"description":"The user ID of the user.","type":"string"},"username":{"description":"The username of the user.","type":"string"}},"required":["user_id","username"],"type":"object"},"UserDetail1":{"properties":{"full_name":{"type":"string"},"user_id":{"type":"string"},"username":{"type":"string"}},"type":"object"},"UserInfo1":{"properties":{"email":{"description":"The email address of the user.","format":"email","type":"string"},"uid":{"description":"The unique ID of the user.","type":"string"},"user_id":{"description":"The ID of the user.","type":"string"},"username":{"description":"The username of the user.","type":"string"}},"type":"object"},"UserSerializer":{"type":"object","properties":{"user_id":{"type":"string"},"contact":{"type":"string"},"username":{"type":"string"}}},"UserSerializer1":{"properties":{"_id":{"type":"string"},"contact":{"type":"string"},"uid":{"type":"string"},"user_id":{"type":"string"},"username":{"type":"string"}},"type":"object"},"UserSerializer2":{"properties":{"contact":{"type":"string"},"user_id":{"type":"string"},"username":{"type":"string"}},"type":"object"},"UserSerializer3":{"properties":{"contact":{"type":"string"},"user_id":{"type":"string"},"username":{"type":"string"}},"type":"object"},"ValidateIdentifier":{"properties":{"gtin_type":{"type":"string"},"gtin_value":{"type":"string"},"primary":{"type":"boolean"}},"required":["gtin_type","gtin_value"],"type":"object"},"ValidateProduct":{"properties":{"valid":{"type":"boolean"}},"type":"object"},"ValidateSizeGuide":{"properties":{"active":{"type":"boolean"},"brand_id":{"type":"integer"},"company_id":{"type":"integer"},"created_by":{"type":"object"},"created_on":{"format":"date-time","type":"string"},"description":{"type":"string"},"guide":{"$ref":"#/components/schemas/Guide"},"id":{"type":"string"},"image":{"format":"url","type":"string"},"modified_by":{"type":"object"},"modified_on":{"format":"date-time","type":"string"},"name":{"type":"string"},"subtitle":{"type":"string"},"tag":{"type":"string"},"title":{"type":"string"}},"required":["name","title"],"type":"object"},"VerifiedBy":{"properties":{"user_id":{"type":"string"},"username":{"type":"string"}},"type":"object"},"WeightResponse":{"properties":{"is_default":{"description":"Indicates if it is the default weight.","example":true,"type":"boolean"},"shipping":{"description":"The shipping weight.","example":1.5,"type":"number"},"unit":{"description":"The unit of weight.","example":"kg","type":"string"}},"required":["is_default","shipping","unit"],"type":"object"},"WeightResponse1":{"properties":{"shipping":{"type":"number"},"unit":{"type":"string"}},"type":"object"},"CreatedBy":{"type":"object","properties":{"username":{"type":"string"}}},"Marketplaces":{"properties":{"brand_ids":{"type":"array","items":{"type":"integer"}},"app_id":{"type":"string"},"enabled":{"type":"boolean"},"created_by":{"allOf":[{"$ref":"#/components/schemas/CreatedBy"}]},"created_on":{"format":"date-time"},"opt_level":{"type":"string"},"company_id":{"type":"integer"},"modified_by":{"allOf":[{"$ref":"#/components/schemas/CreatedBy"}]},"store_ids":{"type":"array","items":{"type":"integer"}},"modified_on":{"format":"date-time"},"platforms":{"type":"string"},"_id":{"type":"string"}}},"GetAllMarketplaces":{"properties":{"items":{"items":{"$ref":"#/components/schemas/Marketplaces"},"type":"array"},"page":{"$ref":"#/components/schemas/Page"}},"type":"object"},"UpdateMarketplaceOptinRequest":{"properties":{"brand_ids":{"type":"array","items":{"type":"integer"}},"company_id":{"type":"integer"},"enabled":{"type":"boolean"},"opt_level":{"type":"string"},"platform":{"type":"string"},"store_ids":{"type":"array","items":{"type":"integer"}}}},"UpdateMarketplaceOptinResponse":{"properties":{"brand_ids":{"type":"array","items":{"type":"integer"}},"company_id":{"type":"integer"},"app_id":{"type":"string"},"enabled":{"type":"boolean"},"opt_level":{"type":"string"},"platform":{"type":"string"},"store_ids":{"type":"array","items":{"type":"integer"}},"created_by":{"allOf":[{"$ref":"#/components/schemas/CreatedBy"}]},"modified_by":{"allOf":[{"$ref":"#/components/schemas/CreatedBy"}]}}},"ApplicationResponse":{"type":"object","properties":{"application":{"$ref":"#/components/schemas/Application"},"_id":{"type":"string","description":"The unique identifier (24-digit Mongo Object ID) of the current sales channel supported currency"},"is_active":{"type":"boolean","description":"Shows currency is enabled or not in current sales channel"},"name":{"type":"string","description":"Name of the currency, e.g. Indian Rupee"},"code":{"type":"string","description":"3-character currency code, e.g. INR, USD, EUR."},"created_at":{"type":"string","description":"ISO 8601 timestamp of sales channel support currency creation"},"updated_at":{"type":"string","description":"ISO 8601 timestamp of sales channel support currency updation"},"decimal_digits":{"type":"integer","format":"int32","description":"Acceptable decimal limits for a given currency, e.g. 1.05$ means upto 2 decimal digits can be accepted as a valid value of a currency."},"symbol":{"type":"string","description":"Unique symbol for identifying the currency, e.g. ₹"}}},"Domain":{"type":"object","properties":{"name":{"type":"string","description":"Full domain name, e.g. newton.com"},"_id":{"type":"string","description":"The unique identifier (24-digit Mongo Object ID) of the sales channel domain"},"verified":{"type":"boolean","description":"Domain is verified or not. TXT and A records should propagate correctly."},"is_primary":{"type":"boolean","description":"Domain is primary or not. Primary domain is the default/main domain."},"is_shortlink":{"type":"boolean","description":"Shortlink is present or not for the domain"},"is_predefined":{"type":"boolean","description":"Domain is hosting domain or not."},"message":{"type":"string"}}},"ApplicationWebsite":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Shows whether sales channel website URL is enabled or not"},"basepath":{"type":"string","description":"Base path for the current sales channel website"}}},"ApplicationCors":{"type":"object","properties":{"domains":{"type":"array","items":{"type":"string","description":"List of all the domains added to the sales channel"}}}},"ApplicationAuth":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Shows sales channel auth is enabled or not enabled."}}},"ApplicationRedirections":{"type":"object","properties":{"redirect_from":{"type":"string","description":"Old domain url of the sales channel"},"redirect_to":{"type":"string","description":"New domain URL of the sales channel. Users will be automatically redirected from old domain to new domain."},"type":{"type":"string","description":"It shows domain redirection type. Permanent redirection is for long time period redirection, and temporary redirection for a short time period.","enum":["permanent","temporary"]}}},"ApplicationMeta":{"type":"object","properties":{"name":{"type":"string","description":"Indicates to name of application meta"},"value":{"type":"string","description":"Value related to application meta name"}}},"SecureUrl":{"type":"object","properties":{"secure_url":{"type":"string","description":"Hosted URL of the image"}}},"Application":{"type":"object","additionalProperties":true,"properties":{"website":{"$ref":"#/components/schemas/ApplicationWebsite"},"cors":{"$ref":"#/components/schemas/ApplicationCors"},"auth":{"$ref":"#/components/schemas/ApplicationAuth"},"description":{"type":"string","description":"It contains detailed information about the sales channel."},"channel_type":{"type":"string","description":"It indicates different channel types like store, website-and-mobile-apps. Default value is store"},"cache_ttl":{"type":"integer","format":"int32","description":"An integer value that specifies the number of seconds until the key expires"},"is_internal":{"type":"boolean","description":"Indicates whether a sales channel is internal or not"},"is_active":{"type":"boolean","description":"Indicates sales channel is active or not active"},"_id":{"type":"string","description":"The unique identifier (24-digit Mongo Object ID) of the sales channel"},"name":{"type":"string","description":"Name of the sales channel, e.g. Zenz Fashion"},"owner":{"type":"string","description":"The unique identifier (24-digit Mongo Object ID) of owner who owns the application"},"company_id":{"type":"integer","format":"int32","description":"Numeric ID allotted to a business account where the sales channel exists"},"token":{"type":"string","description":"Random generated fix length string for sales channel. It is required and auto-generated.          "},"redirections":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationRedirections"}},"meta":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationMeta"}},"created_at":{"type":"string","description":"ISO 8601 timestamp of sales channel creation"},"modified_at":{"type":"string","description":"ISO 8601 timestamp of sales channel updation"},"__v":{"type":"integer","format":"int32","description":"Version key for tracking revisions. Default value is zero."},"banner":{"$ref":"#/components/schemas/SecureUrl"},"logo":{"$ref":"#/components/schemas/SecureUrl"},"favicon":{"$ref":"#/components/schemas/SecureUrl"},"domains":{"type":"array","items":{"$ref":"#/components/schemas/Domain"}},"app_type":{"type":"string","description":"It shows application is live or in development mode.","enum":["live","development"]},"mobile_logo":{"$ref":"#/components/schemas/SecureUrl"},"domain":{"$ref":"#/components/schemas/Domain"},"slug":{"type":"string"},"mode":{"type":"string"},"status":{"type":"string"},"tokens":{"type":"array","items":{"$ref":"#/components/schemas/TokenSchema"}},"secret":{"type":"string"}}},"NotFound":{"type":"object","properties":{"message":{"type":"string","description":"Response message for not found"},"success":{"type":"boolean","description":"Flag for required not successfull."}}},"LocationDefaultLanguage":{"type":"object","properties":{"name":{"type":"string","example":"English"},"code":{"type":"string","example":"en-IN"}}},"LocationDefaultCurrency":{"type":"object","properties":{"name":{"type":"string","example":"Indian Rupee"},"symbol":{"type":"string","example":"₹"},"code":{"type":"string","example":"INR"}}},"LocationCountry":{"type":"object","properties":{"capital":{"type":"string","example":"Kabul"},"currency":{"type":"string","example":"AFN"},"iso2":{"type":"string","example":"AF"},"iso3":{"type":"string","example":"AFG"},"name":{"type":"string","example":"Afghanistan"},"parent":{"type":"string","format":"nullable"},"phone_code":{"type":"string","example":""},"type":{"type":"string","example":"country"},"uid":{"type":"integer","format":"int32","example":1},"__v":{"type":"integer","format":"int32","example":0},"_id":{"type":"string","example":"5ec50c613c403900600fcdec,"},"default_currency":{"$ref":"#/components/schemas/LocationDefaultCurrency"},"default_language":{"$ref":"#/components/schemas/LocationDefaultLanguage"},"state_code":{"type":"string"},"country_code":{"type":"string"},"latitude":{"type":"string"},"longitude":{"type":"string"}}},"Locations":{"type":"object","description":"","properties":{"items":{"type":"array","description":"Object Containing Country Locations Details","items":{"$ref":"#/components/schemas/LocationCountry"}}}},"EventSubscriptionsBulkUpdateRequest":{"type":"object","properties":{"subscriptions":{"type":"array","items":{"$ref":"#/components/schemas/SubscriptionsObject"}}}},"EventSubscriptionsBulkUpdateResponse":{"type":"object","properties":{"template":{"$ref":"#/components/schemas/EventSubscriptionTemplate"},"_id":{"type":"string","example":"5e56598f2bfda9050ccaa8e8"},"application":{"type":"string","example":"5e5653c1d503e0038407fc10"},"event":{"type":"string","example":"5e5653c1d503e0038407fc10"},"slug":{"type":"string","example":"reset-password-event"},"category":{"type":"string","enum":["website","platform","partner"],"example":"website"},"created_at":{"type":"string","example":"2020-02-26T11:42:08.164Z"},"updated_at":{"type":"string","example":"2021-03-03T09:00:47.871Z"},"__v":{"type":"integer","format":"int32","example":0}}},"SubscriptionsObject":{"type":"object","properties":{"_id":{"type":"string","description":"Subscription ID","example":"60458c3874957307e6cd5a01"},"template":{"$ref":"#/components/schemas/TemplateObject"}}},"TemplateObject":{"type":"object","properties":{"sms":{"$ref":"#/components/schemas/CommunicationTemplate"},"email":{"$ref":"#/components/schemas/CommunicationTemplate"},"pushnotification":{"$ref":"#/components/schemas/CommunicationTemplate"}}},"CommunicationTemplate":{"type":"object","properties":{"subscribed":{"type":"boolean","description":"Whether the user is subscribed or not","example":true},"template":{"type":"string","description":"Template ID","example":"60458c3874957307e6cd5a01"}}},"AppProvider":{"type":"object","properties":{"email":{"$ref":"#/components/schemas/AppProviderRes"},"sms":{"$ref":"#/components/schemas/AppProviderRes"},"voice":{"$ref":"#/components/schemas/AppProviderResVoice"},"_id":{"type":"string","example":"5fd9fd07c474a7710dd376d5"},"application":{"type":"string","example":"5fd9fd07c474a7710dd376d5"},"created_at":{"type":"string","example":"2023-05-30T07:16:39.161Z"},"updated_at":{"type":"string","example":"2023-05-30T07:16:39.161Z"},"__v":{"type":"integer","format":"int32","example":0}}},"AppProviderRes":{"type":"object","properties":{"transaction":{"$ref":"#/components/schemas/AppProviderResObj"},"promotional":{"$ref":"#/components/schemas/AppProviderResObj"},"otp":{"$ref":"#/components/schemas/AppProviderResObj"}}},"AppProviderResVoice":{"type":"object","properties":{"transaction":{"$ref":"#/components/schemas/AppProviderResObj"},"otp":{"$ref":"#/components/schemas/AppProviderResObj"}}},"AppProviderResObj":{"type":"object","properties":{"provider":{"type":"string","example":"5fd9fd07c474a7710dd376d5"}}},"GlobalProviders":{"type":"object","properties":{"email":{"type":"array","items":{"$ref":"#/components/schemas/GlobalProvidersResObj"}},"sms":{"type":"array","items":{"$ref":"#/components/schemas/GlobalProvidersResObj"}},"voice":{"type":"array","items":{"$ref":"#/components/schemas/GlobalProvidersResObj"}}}},"GlobalProvidersResObj":{"type":"object","properties":{"_id":{"type":"string","example":"5fd9fd07c474a7710dd376d5"},"name":{"type":"string","example":"5fd9fd07c474a7710dd376d5"}}},"AppProviderReq":{"type":"object","properties":{"email":{"$ref":"#/components/schemas/AppProviderRes"},"sms":{"$ref":"#/components/schemas/AppProviderRes"},"voice":{"$ref":"#/components/schemas/AppProviderResVoice"}}},"StatsImported":{"type":"object","properties":{"count":{"type":"integer","format":"int32","example":2}}},"StatsProcessedEmail":{"type":"object","properties":{"success":{"type":"integer","format":"int32","example":2},"failed":{"type":"integer","format":"int32","example":0},"suppressed":{"type":"integer","format":"int32","example":0}}},"StatsProcessedSms":{"type":"object","properties":{"success":{"type":"integer","format":"int32","example":0},"failed":{"type":"integer","format":"int32","example":0},"suppressed":{"type":"integer","format":"int32","example":0}}},"StatsProcessed":{"type":"object","properties":{"email":{"$ref":"#/components/schemas/StatsProcessedEmail"},"sms":{"$ref":"#/components/schemas/StatsProcessedSms"}}},"Stats":{"type":"object","properties":{"_id":{"type":"string","example":"6009a1ea1f6a61d88e80a867"},"imported":{"items":{"$ref":"#/components/schemas/StatsImported"}},"processed":{"items":{"$ref":"#/components/schemas/StatsProcessed"}}}},"GetStats":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Stats"}}}},"CampaignReq":{"type":"object","properties":{"description":{"type":"string","example":"test description"},"tags":{"type":"array","items":{"type":"string","example":"csv"}},"headers":{"type":"array","items":{"type":"string"}},"is_active":{"type":"boolean"},"name":{"type":"string","example":"Test csv"},"file_url":{"type":"string","example":"https://hdn-1.addsale.com/x0/application/000000000000000000000004/datasources/2_r_D1jt6-test-1-entries.csv"},"type":{"type":"string","example":"raw_csv"},"records_count":{"type":"integer","format":"int32","example":3},"application":{"type":"string","example":"64802b8bd4dc759bcc1fef86"}}},"RecipientHeaders":{"type":"object","properties":{"email":{"type":"string","example":"email"}}},"CampaignEmailTemplate":{"type":"object","properties":{"key":{"type":"string","example":"_id"},"value":{"type":"string","example":"5fb6757a09fd90ca91917a60"}}},"CampignEmailProvider":{"type":"object","properties":{"_id":{"type":"string","example":"5e560652b5eb4b1f13b4d601"},"from_name":{"type":"string","example":"Fynd"},"from_email":{"type":"string","example":"hey@gofynd.com"}}},"CampaignEmail":{"type":"object","properties":{"template":{"$ref":"#/components/schemas/CampaignEmailTemplate"},"provider":{"$ref":"#/components/schemas/CampignEmailProvider"}}},"Campaign":{"type":"object","properties":{"recipient_headers":{"$ref":"#/components/schemas/RecipientHeaders"},"email":{"$ref":"#/components/schemas/CampaignEmail"},"description":{"type":"string","example":"null"},"tags":{"type":"array","items":{}},"is_active":{"type":"boolean"},"_id":{"type":"string","example":"6009a1ea1f6a61d88e80a867"},"datasource":{"type":"string","example":"6009a1be1f6a61a13180a866"},"type":{"type":"string","example":"email"},"name":{"type":"string","example":"testing bq email"},"application":{"type":"string","example":"64802b8bd4dc759bcc1fef86"},"created_at":{"type":"string","example":"2021-01-21T15:46:50.357Z"},"updated_at":{"type":"string","example":"2021-01-21T15:46:50.357Z"},"slug":{"type":"string","example":"testing-bq-email-vPyAd1YB1"},"__v":{"type":"integer","format":"int32","example":0}}},"Campaigns":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Campaign"}},"page":{"$ref":"#/components/schemas/Page"}}},"BadRequestSchema":{"description":"Bad Request.","type":"object","properties":{"status":{"description":"Response status.","type":"string"},"message":{"description":"Failure message.","type":"string"}}},"AudienceReq":{"type":"object","properties":{"name":{"type":"string","example":"dummy ds"},"description":{"type":"string","example":"desc"},"tags":{"type":"array","items":{"type":"string","example":"tag1"}},"file_url":{"type":"string","example":"https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/fyndnp/wrkr/x5/application/64802b8bd4dc759bcc1fef86/datasources/wu10BBMXD-jsonviewer.csv"},"type":{"type":"string","example":"raw_csv"},"records_count":{"type":"integer","format":"int32","example":3},"headers":{"type":"array","items":{"type":"string","example":"phone"}}}},"Audience":{"type":"object","properties":{"_id":{"type":"string","example":"64ad30a15efbc5f85fb549d8"},"application":{"type":"string","example":"64802b8bd4dc759bcc1fef86"},"name":{"type":"string","example":"dummy ds"},"description":{"type":"string","example":"desc"},"records_count":{"type":"integer","format":"int32","example":3},"type":{"type":"string","example":"raw_csv"},"tags":{"type":"array","items":{"type":"string","example":"tag1"}},"headers":{"type":"array","items":{"type":"string","example":"phone"}},"file_url":{"type":"string","example":"https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/fyndnp/wrkr/x5/application/64802b8bd4dc759bcc1fef86/datasources/ODKRR6aBQ-jsonviewer.csv"},"is_active":{"type":"boolean","example":true},"created_at":{"type":"string","example":"2023-07-11T10:36:17.340Z"},"updated_at":{"type":"string","example":"2023-07-11T10:36:17.340Z"},"slug":{"type":"string","example":"dummy-1-5JrNGM8LA"},"__v":{"type":"integer","format":"int32","example":0}}},"Audiences":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Audience"}},"page":{"$ref":"#/components/schemas/Page"}},"required":[]},"GetNRecordsCsvReq":{"type":"object","properties":{"url":{"type":"string","example":"https://api.fyndx0.de/common/assets/v1/proxy/fetch?url=https://hdn-1.addsale.com/x0/application/000000000000000000000004/datasources/2_r_D1jt6-test-1-entries.csv"},"header":{"type":"boolean"},"count":{"type":"integer","format":"int32","example":10}}},"GetNRecordsCsvResItems":{"type":"object","properties":{"phone_number":{"type":"string","example":"1234567890"},"email":{"type":"string","example":"abcxyz@gofynd.com"},"firstname":{"type":"string","example":"Abc"},"lastname":{"type":"string","example":"Xyz"},"orderid":{"type":"string","example":"1"}}},"GetNRecordsCsvRes":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/GetNRecordsCsvResItems"}}}},"DummyDatasources":{"type":"object","properties":{"id":{"type":"integer","format":"int32","example":2},"name":{"type":"string","example":"Data source 2"}}},"DummyDatasourcesMeta":{"type":"object","properties":{"id":{"type":"integer","format":"int32","example":2},"data":{"$ref":"#/components/schemas/DummyDatasourcesMetaObj"}}},"DummyDatasourcesMetaObj":{"type":"object","properties":{"b":{"type":"integer","format":"int32","example":2}}},"EmailProviderReqFrom":{"type":"object","properties":{"name":{"type":"string","example":"abc"},"email":{"type":"string","example":"abc@test.com"},"is_default":{"type":"boolean"}}},"EmailProviderReq":{"type":"object","properties":{"name":{"type":"string","example":"test falconide"},"description":{"type":"string","example":"test"},"api_key":{"type":"string","example":"testtttt"},"type":{"type":"string","example":"application"},"provider":{"type":"string","example":"falconide"},"from_address":{"type":"array","items":{"$ref":"#/components/schemas/EmailProviderReqFrom"}}}},"EmailProvider":{"type":"object","properties":{"type":{"type":"string","example":"application"},"provider":{"type":"string","example":"falconide"},"from_address":{"type":"array","items":{"$ref":"#/components/schemas/EmailProviderReqFrom"}},"_id":{"type":"string","example":"5fd9fd44c474a7e3d5d376d6"},"name":{"type":"string","example":"test falconide"},"description":{"type":"string","example":"test"},"api_key":{"type":"string","example":"testtttt"},"application":{"type":"string","example":"64802b8bd4dc759bcc1fef86"},"created_at":{"type":"string","example":"2020-12-16T12:27:48.051Z"},"updated_at":{"type":"string","example":"2020-12-16T12:27:48.051Z"},"slug":{"type":"string","example":"test-falconide-application-falconide-ZTD-D7wbB"},"__v":{"type":"integer","format":"int32","example":0}}},"EmailProviders":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/EmailProvider"}},"page":{"$ref":"#/components/schemas/Page"}},"required":[]},"EmailTemplateKeys":{"type":"object","properties":{"to":{"type":"string","example":"abc@gofynd.com"},"cc":{"type":"string","example":"abc@gofynd.com"},"bcc":{"type":"string","example":"abc@gofynd.com"}}},"EmailTemplateHeaders":{"type":"object","properties":{"key":{"type":"string","example":"x-test-header"},"value":{"type":"string","example":"test123"}}},"EmailTemplateReq":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"test"},"description":{"type":"string","example":"test template"},"from_name":{"type":"string","example":"Fynd"},"static_to":{"type":"array","items":{"type":"string","example":"abc@gofynd.com"}},"static_cc":{"type":"array","items":{"type":"string","example":"abc@gofynd.com"}},"static_bcc":{"type":"array","items":{"type":"string","example":"abc@gofynd.com"}},"reply_to":{"type":"string","example":"abc@gofynd.com"},"priority":{"type":"string","enum":["high","low"],"example":"low"},"tags":{"type":"array","items":{"type":"string"},"example":["tag1"]},"template_variables":{"type":"object","example":{"hello":"world"}},"published":{"type":"boolean","example":true},"subject":{"$ref":"#/components/schemas/TemplateAndType"},"html":{"$ref":"#/components/schemas/TemplateAndType"},"editor_type":{"type":"string","example":"bee"},"editor_meta":{"type":"string","example":""},"attachments":{"type":"array","items":{"type":"integer"},"example":[]},"headers":{"type":"array","items":{"$ref":"#/components/schemas/EmailTemplateHeaders"}},"keys":{"$ref":"#/components/schemas/EmailTemplateKeys"},"text":{"$ref":"#/components/schemas/TemplateAndType"}}},"TemplateAndType":{"type":"object","properties":{"template_type":{"type":"string","enum":["static","nunjucks"]},"template":{"type":"string","example":"This is test email"}}},"EmailTemplate":{"type":"object","properties":{"application":{"type":"string","example":"637b6355dc65337da9b5c951"},"is_system":{"type":"boolean","example":false},"is_internal":{"type":"boolean","example":false},"name":{"type":"string","example":"Application creation"},"description":{"type":"string","example":"Application creation"},"editor_type":{"type":"string","example":"bee"},"editor_meta":{"type":"string","example":""},"static_to":{"type":"array","items":{"type":"string","example":"abc@gofynd.com"}},"static_cc":{"type":"array","items":{"type":"string","example":"abc@gofynd.com"}},"static_bcc":{"type":"array","items":{"type":"string","example":"abc@gofynd.com"}},"reply_to":{"type":"string","example":"abc@gofynd.com"},"tags":{"type":"array","items":{"type":"string"}},"subject":{"$ref":"#/components/schemas/TemplateAndType"},"html":{"$ref":"#/components/schemas/TemplateAndType"},"url_shorten":{"$ref":"#/components/schemas/EnabledObj"},"priority":{"type":"string","enum":["high","low"],"example":"high"},"template_variables":{"type":"object","example":{"hello":"world"}},"published":{"type":"boolean","example":true},"category":{"type":"string","enum":["website","platform","partner"],"example":"website"},"_id":{"type":"string","example":"5ef42a49c8b67d279c27a980"},"headers":{"type":"array","items":{"$ref":"#/components/schemas/EmailTemplateHeaders"}},"attachments":{"type":"array","items":{"type":"integer"},"example":[]},"created_at":{"type":"string","example":"2020-06-25T04:38:34.003Z"},"updated_at":{"type":"string","example":"2020-06-25T04:38:34.003Z"},"slug":{"type":"string","example":"application-creation"},"__v":{"type":"integer","format":"int32","example":0},"from_name":{"type":"string","example":"Fynd"},"text":{"$ref":"#/components/schemas/TemplateAndType"}}},"SystemEmailTemplate":{"type":"object","properties":{"is_system":{"type":"boolean","example":false},"is_internal":{"type":"boolean","example":false},"name":{"type":"string","example":"Application creation"},"description":{"type":"string","example":"Application creation"},"static_to":{"type":"array","items":{"type":"string","example":"abc@gofynd.com"}},"static_cc":{"type":"array","items":{"type":"string","example":"abc@gofynd.com"}},"static_bcc":{"type":"array","items":{"type":"string","example":"abc@gofynd.com"}},"tags":{"type":"array","items":{"type":"string"}},"subject":{"$ref":"#/components/schemas/TemplateAndType"},"html":{"$ref":"#/components/schemas/TemplateAndType"},"url_shorten":{"$ref":"#/components/schemas/EnabledObj"},"priority":{"type":"string","enum":["high","low"],"example":"high"},"template_variables":{"type":"object","example":{"hello":"world"}},"published":{"type":"boolean","example":true},"category":{"type":"string","enum":["website","platform","partner"],"example":"website"},"_id":{"type":"string","example":"5ef42a49c8b67d279c27a980"},"headers":{"type":"array","items":{"$ref":"#/components/schemas/EmailTemplateHeaders"}},"attachments":{"type":"array","items":{"type":"integer"},"example":[]},"created_at":{"type":"string","example":"2020-06-25T04:38:34.003Z"},"updated_at":{"type":"string","example":"2020-06-25T04:38:34.003Z"},"slug":{"type":"string","example":"application-creation"},"__v":{"type":"integer","format":"int32","example":0},"text":{"$ref":"#/components/schemas/TemplateAndType"}}},"EmailTemplates":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/EmailTemplate"}},"page":{"$ref":"#/components/schemas/Page"}},"required":[]},"SystemEmailTemplates":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/SystemEmailTemplate"}}}},"PayloadEmailTemplateStructure":{"type":"object","properties":{"key":{"type":"string","example":"event-slug"},"value":{}}},"PayloadEmailProviderStructure":{"type":"object","properties":{"_id":{"type":"string","example":"611113b5d4beb64b288f8d66"}}},"PayloadEmailStructure":{"type":"object","properties":{"template":{"$ref":"#/components/schemas/PayloadEmailTemplateStructure"},"provider":{"$ref":"#/components/schemas/PayloadEmailProviderStructure"}}},"PayloadSmsTemplateStructure":{"type":"object","properties":{"key":{"type":"string","example":"event-slug"},"value":{}}},"PayloadSmsProviderStructure":{"type":"object","properties":{"_id":{"type":"string","example":"611113b5d4beb64b288f8d66"}}},"PayloadSmsStructure":{"type":"object","properties":{"template":{"$ref":"#/components/schemas/PayloadSmsTemplateStructure"},"provider":{"$ref":"#/components/schemas/PayloadSmsProviderStructure"}}},"PayloadStructure":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object"}},"email":{"$ref":"#/components/schemas/PayloadEmailStructure"},"sms":{"$ref":"#/components/schemas/PayloadSmsStructure"},"application":{"type":"string","example":"611113b5d4beb64b288f8d66"}}},"MetaStructure":{"type":"object","properties":{"job_type":{"type":"string","example":"event"},"action":{"type":"string","example":"send"},"trace":{"type":"string","example":"partner.uuid1"},"timestamp":{"type":"string","example":"2022-02-22T05:21:50.005Z"}}},"EngineRequest":{"type":"object","properties":{"payload":{"$ref":"#/components/schemas/PayloadStructure"},"meta":{"$ref":"#/components/schemas/MetaStructure"}}},"EngineResponse":{"type":"object","properties":{"success":{"type":"boolean"}}},"EventSubscriptionTemplateSms":{"type":"object","properties":{"subscribed":{"type":"boolean"},"template":{"type":"string","format":"nullable"}}},"EventSubscriptionTemplateEmail":{"type":"object","properties":{"subscribed":{"type":"boolean"},"template":{"type":"string","example":"5e5653c1d503e0038407fc16"}}},"EventSubscriptionTemplate":{"type":"object","properties":{"sms":{"$ref":"#/components/schemas/EventSubscriptionTemplateSms"},"email":{"$ref":"#/components/schemas/EventSubscriptionTemplateEmail"}}},"EventSubscription":{"type":"object","properties":{"template":{"$ref":"#/components/schemas/EventSubscriptionTemplate"},"is_default":{"type":"boolean"},"_id":{"type":"string","example":"5e56598f2bfda9050ccaa8e8"},"application":{"type":"string","example":"64802b8bd4dc759bcc1fef86"},"event":{"type":"string","example":"5e5653c1d503e0038407fc10"},"slug":{"type":"string","example":"reset-password-event"},"created_at":{"type":"string","example":"2020-02-26T11:42:08.164Z"},"updated_at":{"type":"string","example":"2021-03-03T09:00:47.871Z"},"__v":{"type":"integer","format":"int32","example":0}}},"EventSubscriptions":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/EventSubscription"}},"page":{"$ref":"#/components/schemas/Page"}},"required":[]},"TriggerJobResponse":{"type":"object","properties":{"status":{"type":"integer","format":"int32","example":200}}},"TriggerJobRequest":{"type":"object","properties":{"job_id":{"type":"string","example":"60458c3874957307e6cd5a01"}}},"GlobalVariablesGetResponse":{"type":"object","properties":{"read_only":{"type":"object","example":{}},"editable":{"type":"object","example":{}}}},"GlobalVariablesPostResponse":{"type":"object","properties":{"_id":{"type":"string","example":"60619f167dbd13ff0722f6dd"},"category":{"type":"string","enum":["website","platform","partner"],"example":"website"},"application":{"type":"string","example":"60619f167dbd13ff0722f6dd"},"global_variables":{"type":"object","example":{}},"created_at":{"type":"string","example":"2023-07-03T12:25:05.819Z"}}},"GlobalVariablesReq":{"type":"object","properties":{"global_variables":{"type":"object","example":{}}}},"Job":{"type":"object","properties":{"completed":{"type":"boolean"},"is_active":{"type":"boolean"},"_id":{"type":"string","example":"6044be260c92a7be0624f1cf"},"campaign":{"type":"string","example":"6044be1e0c92a7026924f1ce"},"application":{"type":"string","example":"64802b8bd4dc759bcc1fef86"},"created_at":{"type":"string","example":"2021-03-07T11:51:02.234Z"},"updated_at":{"type":"string","example":"2021-03-07T12:12:36.587Z"},"__v":{"type":"integer","format":"int32","example":0}}},"Jobs":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Job"}},"page":{"$ref":"#/components/schemas/Page"}},"required":[]},"CreateJobsRes":{"type":"object","properties":{"application":{"type":"string","example":"64802b8bd4dc759bcc1fef86"},"campaign":{"type":"string","example":"64802b8bd4dc759bcc1fef86"},"completed":{"type":"boolean","example":true},"is_active":{"type":"boolean","example":true},"_id":{"type":"string","example":"64802b8bd4dc759bcc1fef86"},"created_at":{"type":"string","example":"2021-03-07T12:12:36.587Z"},"updated_at":{"type":"string","example":"2021-03-07T12:12:36.587Z"},"__v":{"type":"integer","format":"int32","example":0}}},"CreateJobsReq":{"type":"object","properties":{"campaign":{"type":"string","example":"64802b8bd4dc759bcc1fef86"}}},"JobLog":{"type":"object","properties":{"imported":{"items":{"$ref":"#/components/schemas/StatsImported"}},"processed":{"items":{"$ref":"#/components/schemas/StatsProcessed"}},"_id":{"type":"string","example":"6044be30bc5f4b79aae7b29f"},"job":{"type":"string","example":"6044be260c92a7be0624f1cf"},"campaign":{"type":"string","example":"6044be1e0c92a7026924f1ce"},"created_at":{"type":"string","example":"2021-03-07T11:51:12.778Z"},"updated_at":{"type":"string","example":"2021-03-07T12:14:11.475Z"},"__v":{"type":"integer","format":"int32","example":0}}},"JobLogs":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/JobLog"}},"page":{"$ref":"#/components/schemas/Page"}},"required":[]},"LogEmail":{"type":"object","properties":{"template":{"type":"string","example":"null"}}},"LogPushnotification":{"type":"object","properties":{"pushtokens":{"type":"array","items":{"type":"string"}}}},"LogMeta":{"type":"object","properties":{"type":{"type":"string","example":"event"},"identifier":{"type":"string","example":"test-bfb54412f68a435aa320bad232841b58"},"key":{"type":"string","example":"FYMP60114D3F19B2DD77"},"offset":{"type":"string","example":"9"},"partition":{"type":"string","example":"0"},"topic":{"type":"string","example":"fynd-json-pointblank-internal-event-communication-v2"}}},"Log":{"type":"object","properties":{"email":{"$ref":"#/components/schemas/LogEmail"},"pushnotification":{"$ref":"#/components/schemas/LogPushnotification"},"meta":{"$ref":"#/components/schemas/LogMeta"},"_id":{"type":"string","example":"60118960dce642343018c33d"},"application":{"type":"string","example":"5ea6821b3425bb07c82a25c1"},"service":{"type":"string","example":"router-consumer"},"step":{"type":"string","example":"MSG_CONSUMED_ROUTER"},"status":{"type":"string","example":"error"},"data":{},"expire_at":{"type":"string","example":"2021-02-26T15:40:16.713Z"},"created_at":{"type":"string","example":"2021-01-27T15:40:16.716Z"}}},"Logs":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Log"}},"page":{"$ref":"#/components/schemas/Page"}},"required":[]},"SendOtpSmsCommsTemplate":{"type":"object","properties":{"key":{"type":"string","example":"event-slug"},"value":{}}},"SendOtpSmsCommsProvider":{"type":"object","properties":{"slug":{"type":"string","example":"send-otp-provider"},"_id":{"type":"string","example":"4435sfee65rr32tyuto6"}}},"SendOtpEmailCommsProvider":{"type":"object","properties":{"slug":{"type":"string","example":"send-otp-provider"},"_id":{"type":"string","example":"4435sfee65rr32tyuto6"}}},"SendOtpEmailCommsTemplate":{"type":"object","properties":{"key":{"type":"string","example":"event-slug"},"value":{}}},"SendOtpCommsReqData":{"type":"object","properties":{"send_same_otp_to_channel":{"type":"boolean"},"mobile":{"type":"string","example":"9096686804"},"country_code":{"type":"string","example":"91"},"to":{"type":"string","example":"parvezshaikh@gofynd.com"}}},"SendOtpCommsReqSms":{"type":"object","properties":{"otp_length":{"type":"integer","format":"int32","example":4},"expiry":{"type":"integer","format":"int32","example":300},"template":{"$ref":"#/components/schemas/SendOtpSmsCommsTemplate"},"provider":{"$ref":"#/components/schemas/SendOtpSmsCommsProvider"}}},"SendOtpCommsReqEmail":{"type":"object","properties":{"otp_length":{"type":"integer","format":"int32","example":4},"expiry":{"type":"integer","format":"int32","example":300},"template":{"$ref":"#/components/schemas/SendOtpEmailCommsTemplate"},"provider":{"$ref":"#/components/schemas/SendOtpEmailCommsProvider"}}},"SendOtpCommsResSms":{"type":"object","properties":{"success":{"type":"boolean"},"request_id":{"type":"string","example":"c8d1bd63d56a2d368aae9dbd4e7d8326"},"message":{"type":"string","example":"OTP sent"},"mobile":{"type":"string","example":"9096686804"},"country_code":{"type":"string","example":"91"},"resend_timer":{"type":"integer","format":"int32","example":30}}},"SendOtpCommsResEmail":{"type":"object","properties":{"success":{"type":"boolean"},"request_id":{"type":"string","example":"1cc79c911923971580d903039ea9ee05"},"message":{"type":"string","example":"OTP sent"},"to":{"type":"string","example":"parvezshaikh@gofynd.com"},"resend_timer":{"type":"integer","format":"int32","example":30}}},"SendOtpCommsReq":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/SendOtpCommsReqData"},"sms":{"$ref":"#/components/schemas/SendOtpCommsReqSms"},"email":{"$ref":"#/components/schemas/SendOtpCommsReqEmail"}}},"SendOtpCommsRes":{"type":"object","properties":{"sms":{"$ref":"#/components/schemas/SendOtpCommsResSms"},"email":{"$ref":"#/components/schemas/SendOtpCommsResEmail"}}},"VerifyOtpCommsReq":{"type":"object","properties":{"request_id":{"type":"string","example":"c8d1bd63d56a2d368aae9dbd4e7d8326"},"otp":{"type":"string","example":"3916"}}},"VerifyOtpCommsSuccessRes":{"type":"object","properties":{"success":{"type":"boolean"},"mobile":{"type":"string","example":"9096686804"},"country_code":{"type":"string","example":"91"},"message":{"type":"string","example":"OTP verified"}}},"VerifyOtpCommsErrorRes":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string","example":"Invalid request"}}},"SmsProviderReq":{"type":"object","properties":{"name":{"type":"string","example":"test telspiel"},"description":{"type":"string","example":"test"},"sender":{"type":"string","example":"test"},"username":{"type":"string","example":"test"},"authkey":{"type":"string","example":"test"},"type":{"type":"string","example":"application"},"provider":{"type":"string","example":"telspiel"},"password":{"type":"string","description":"The password for the test."},"senderid":{"type":"string","description":"The sender ID for the test."},"feedid":{"type":"string","description":"The feed ID for the test."},"entityid":{"type":"string","description":"The entity ID for the test."},"override_dnd":{"type":"boolean","description":"Whether to override Do Not Disturb."},"host":{"type":"string","description":"The host for the test."},"port":{"type":"integer","description":"The port for the test."},"entity_id":{"type":"string","description":"The entity ID for the test."},"apikey":{"type":"string","description":"The apikey for the test."},"version_id":{"type":"integer","format":"int32","description":"The version ID for the test."},"sender_id":{"type":"string","description":"The sender ID for the test."},"api_key":{"type":"string","description":"The api_key for the test."}}},"SmsProvider":{"type":"object","properties":{"rpt":{"type":"integer","format":"int32","example":1},"type":{"type":"string","example":"application"},"provider":{"type":"string","example":"telspiel"},"_id":{"type":"string","example":"5fd9fd07c474a7710dd376d5"},"name":{"type":"string","example":"test telspiel"},"description":{"type":"string","example":"test"},"sender":{"type":"string","example":"test"},"username":{"type":"string","example":"test"},"authkey":{"type":"string","example":"test"},"application":{"type":"string","example":"64802b8bd4dc759bcc1fef86"},"created_at":{"type":"string","example":"2020-12-16T12:26:47.794Z"},"updated_at":{"type":"string","example":"2020-12-16T12:26:47.794Z"},"slug":{"type":"string","example":"test-telspiel-application-telspiel-p9UY1r7nG"},"__v":{"type":"integer","format":"int32","example":0}}},"SmsProviders":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/SmsProvider"}},"page":{"$ref":"#/components/schemas/Page"}}},"DefaultSmsProviders":{"type":"object","properties":{"_id":{"type":"string","example":"63db8c68975237fff4f2133e"},"name":{"type":"string","example":"timesinternet"},"is_default":{"type":"boolean","example":true}}},"SmsTemplateMessage":{"type":"object","properties":{"template_type":{"type":"string","example":"nunjucks"},"template":{"type":"string","example":"This is a test message"}}},"SmsTemplates":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/SmsTemplate"}},"page":{"$ref":"#/components/schemas/Page"}},"required":[]},"SmsTemplate":{"type":"object","properties":{"url_shorten":{"$ref":"#/components/schemas/EnabledObj"},"_id":{"type":"string","example":"649968feca21d7edd0595b35"},"application":{"type":"string","example":"637b6355dc65337da9b5c951"},"is_system":{"type":"boolean","example":false},"is_internal":{"type":"boolean","example":false},"meta":{"$ref":"#/components/schemas/metaObj"},"name":{"type":"string","example":"An Sms Template"},"description":{"type":"string","example":"This is a test sms template"},"message":{"$ref":"#/components/schemas/SmsTemplateMessage"},"priority":{"type":"string","enum":["high","low"],"example":"high"},"tags":{"type":"array","items":{"type":"string"},"example":["tag1"]},"template_variables":{"type":"object","example":{"hello":"world"}},"template_id":{"type":"string","example":"1.234567891234568e+21"},"published":{"type":"boolean","example":true},"category":{"type":"string","enum":["website","platform","partner"],"example":"website"},"created_at":{"type":"string","example":"2020-12-12T04:30:42.456Z"},"updated_at":{"type":"string","example":"2020-12-24T15:13:20.558Z"},"slug":{"type":"string","example":"sms-template-000"},"__v":{"type":"integer","format":"int32","example":0}}},"SystemSmsTemplates":{"type":"object","properties":{"url_shorten":{"$ref":"#/components/schemas/EnabledObj"},"_id":{"type":"string","example":"649968feca21d7edd0595b35"},"is_system":{"type":"boolean","example":false},"is_internal":{"type":"boolean","example":false},"name":{"type":"string","example":"An Sms Template"},"description":{"type":"string","example":"This is a test sms template"},"message":{"$ref":"#/components/schemas/SmsTemplateMessage"},"priority":{"type":"string","enum":["high","low"],"example":"high"},"tags":{"type":"array","items":{"type":"string"},"example":["tag1"]},"template_variables":{"type":"object","example":{"hello":"world"}},"template_id":{"type":"string","example":"1.234567891234568e+21"},"published":{"type":"boolean","example":true},"category":{"type":"string","enum":["website","platform","partner"],"example":"website"},"created_at":{"type":"string","example":"2020-12-12T04:30:42.456Z"},"updated_at":{"type":"string","example":"2020-12-24T15:13:20.558Z"},"slug":{"type":"string","example":"sms-template-000"},"__v":{"type":"integer","format":"int32","example":0}}},"metaObj":{"type":"object","properties":{"type":{"type":"string","example":"cloned"},"is_system":{"type":"boolean","example":true},"template":{"type":"string","example":"61963d42ce3af81bde44a67d"}}},"SmsTemplateReq":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"test"},"description":{"type":"string","example":"test template"},"priority":{"type":"string","enum":["high","low"],"example":"low"},"template_id":{"type":"string","example":"1.234567891234568e+21"},"meta":{"$ref":"#/components/schemas/metaObj"},"template_variables":{"type":"object","example":{"hello":"world"}},"published":{"type":"boolean","example":true},"message":{"$ref":"#/components/schemas/SmsTemplateMessage"}}},"Notification":{"type":"object","properties":{"title":{"type":"string","example":"Xyz Company is verified!"},"body":{"type":"string","example":"null"},"subtitle":{"type":"string","example":"null"},"icon":{"type":"string","example":"icon.png"},"deeplink":{"type":"string","example":"null"},"click_action":{"type":"string","example":"null"}}},"SystemNotificationUser":{"type":"object","properties":{"type":{"type":"string","example":"company"},"value":{"type":"string","example":"1"}}},"SystemNotification":{"type":"object","properties":{"notification":{"$ref":"#/components/schemas/Notification"},"user":{"$ref":"#/components/schemas/SystemNotificationUser"},"settings":{"$ref":"#/components/schemas/SystemNotificationUser"},"_id":{"type":"string","example":"60619f167dbd13ff0722f6dd"},"group":{"type":"string","example":"fynd-platform"},"created_at":{"type":"string","example":"2021-03-29T09:34:14.182Z"}}},"SystemNotifications":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/SystemNotification"}},"last_read_anchor":{"type":"integer","format":"int32","example":1616748860},"page":{"$ref":"#/components/schemas/Page"}},"required":[]},"GenericError":{"type":"object","properties":{"message":{"$ref":"#/components/schemas/Message"},"sentry":{"type":"string","example":"781bd254455a4f79977830fe93d73f5d"}}},"GenericDelete":{"type":"object","properties":{"message":{"type":"string","example":"Deletion Successfull"},"acknowledged":{"type":"boolean","example":true},"affected":{"type":"integer","format":"int32","example":1},"operation":{"type":"string","example":"TEMP-ST-DEL:ID"}}},"Message":{"type":"object","properties":{"message":{"type":"string","example":"Oops! Something went wrong. Please try later"},"success":{"type":"boolean","example":false},"info":{"type":"string","example":"Argument passed in must be a string of 12 bytes or a string of 24 hex characters or an integer"},"operation":{"type":"string","example":"PRO-EP-GET"}}},"EnabledObj":{"type":"object","properties":{"enabled":{"type":"boolean","example":false}}},"OtpConfigurationExpiryDuration":{"type":"object","required":["time","denomination"],"properties":{"time":{"type":"number","example":5},"denomination":{"type":"string","example":"min","enum":["min","sec"]}}},"OtpConfigurationExpiry":{"type":"object","required":["duration","type"],"properties":{"duration":{"$ref":"#/components/schemas/OtpConfigurationExpiryDuration"},"type":{"type":"string","example":"new","enum":["new","same"]}}},"OtpConfiguration":{"type":"object","required":["otp_length","type","expiry"],"properties":{"otp_length":{"type":"integer","example":4,"enum":[4,6,8]},"type":{"type":"string","example":"numeric","enum":["numeric","alphanumeric"]},"expiry":{"$ref":"#/components/schemas/OtpConfigurationExpiry"},"application_id":{"type":"string","example":"6399ba6924ab1bacf0131492"},"company_id":{"type":"string","example":"1"}}},"CompanyTaxesSerializer":{"type":"object","properties":{"effective_date":{"type":"string","format":"date-time"},"rate":{"type":"number"},"enable":{"type":"boolean"}}},"Website":{"type":"object","properties":{"url":{"type":"string","format":"url"}}},"BusinessDetails":{"type":"object","properties":{"website":{"$ref":"#/components/schemas/Website"}}},"ContactDetails":{"type":"object","properties":{"phone":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/PhoneDetails"}},"emails":{"type":"array","nullable":true,"items":{"type":"string"}}}},"CountryCurrencyInfo":{"type":"object","properties":{"code":{"type":"string"},"symbol":{"type":"string"},"name":{"type":"string"}},"required":["code","symbol","name"]},"BusinessCountryInfo":{"type":"object","properties":{"country_code":{"type":"string"},"country":{"type":"string"},"currency":{"$ref":"#/components/schemas/CountryCurrencyInfo"},"timezone":{"type":"string"}},"required":["country_code","country","currency","timezone"]},"GetCompanyProfileSerializerResponse":{"type":"object","properties":{"business_info":{"type":"string"},"taxes":{"type":"array","items":{"$ref":"#/components/schemas/CompanyTaxesSerializer"}},"business_type":{"type":"string"},"name":{"type":"string"},"_custom_json":{"type":"object"},"verified_on":{"type":"string","format":"date-time"},"created_by":{"$ref":"#/components/schemas/UserSerializer"},"created_on":{"type":"string","format":"date-time"},"warnings":{"type":"object"},"business_details":{"$ref":"#/components/schemas/BusinessDetails"},"mode":{"type":"string"},"contact_details":{"$ref":"#/components/schemas/ContactDetails"},"business_country_info":{"$ref":"#/components/schemas/BusinessCountryInfo"},"modified_on":{"type":"string","format":"date-time"},"uid":{"type":"integer"},"franchise_enabled":{"type":"boolean"},"stage":{"type":"string"},"company_type":{"type":"string"},"documents":{"type":"array","items":{"$ref":"#/components/schemas/Document"}},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/GetAddressSerializer"}},"verified_by":{"$ref":"#/components/schemas/UserSerializer"},"notification_emails":{"type":"array","items":{"type":"string"}},"modified_by":{"$ref":"#/components/schemas/UserSerializer"}},"required":["company_type","uid"]},"CompanyTaxesSerializer1":{"type":"object","properties":{"effective_date":{"type":"string","format":"date-time"},"rate":{"type":"number"},"enable":{"type":"boolean"}}},"CreateUpdateAddressSerializer":{"type":"object","properties":{"landmark":{"type":"string","pattern":"^[a-zA-Z0-9&()_,.:/s -]*$"},"country_code":{"type":"string"},"pincode":{"type":"integer"},"address_type":{"type":"string","enum":["office","registered"]},"longitude":{"type":"number","minimum":-180,"maximum":180},"country":{"type":"string","pattern":"^[a-zA-Z0-9&()_,.:/s -]*$"},"address2":{"type":"string","pattern":"^[a-zA-Z0-9&()_,.:/s -]*$"},"state":{"type":"string","pattern":"^[a-zA-Z0-9&()_,.:/s -]*$"},"address1":{"type":"string","pattern":"^[a-zA-Z0-9&()_,.:/s -]*$"},"city":{"type":"string","pattern":"^[a-zA-Z0-9&()_,.:/s -]*$"},"latitude":{"type":"number","minimum":-90,"maximum":90}},"required":["address1","address_type","city","country","latitude","longitude","pincode","state"]},"UpdateCompany":{"type":"object","properties":{"franchise_enabled":{"type":"boolean"},"business_info":{"type":"string","pattern":"^[a-zA-Z0-9!@#$%^&*(){}\\[\\]|\\\\:;\\\"'`<>.,?/_+-= \\s]*$"},"warnings":{"type":"object"},"company_type":{"type":"string","pattern":"^[a-zA-Z0-9&()_,.:/s -]*$"},"_custom_json":{"type":"object"},"taxes":{"type":"array","items":{"$ref":"#/components/schemas/CompanyTaxesSerializer1"}},"business_details":{"$ref":"#/components/schemas/BusinessDetails"},"documents":{"type":"array","items":{"$ref":"#/components/schemas/Document"}},"business_type":{"type":"string","pattern":"^[a-zA-Z0-9&()_,.:/s -]*$"},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/CreateUpdateAddressSerializer"}},"notification_emails":{"type":"array","items":{"type":"string","format":"email"}},"contact_details":{"$ref":"#/components/schemas/ContactDetails"},"reject_reason":{"type":"string"},"name":{"type":"string","pattern":"^[a-zA-Z0-9&()_,.:/s -]*$"}}},"ProfileSuccessResponse":{"type":"object","properties":{"uid":{"type":"integer"},"message":{"type":"string"},"success":{"type":"boolean"}}},"DocumentsObj":{"type":"object","properties":{"pending":{"type":"integer"},"verified":{"type":"integer"}}},"MetricsSerializer":{"type":"object","properties":{"stage":{"type":"string"},"store":{"$ref":"#/components/schemas/DocumentsObj"},"company_documents":{"$ref":"#/components/schemas/DocumentsObj"},"store_documents":{"$ref":"#/components/schemas/DocumentsObj"},"product":{"$ref":"#/components/schemas/DocumentsObj"},"uid":{"type":"integer"},"brand":{"$ref":"#/components/schemas/DocumentsObj"}}},"BrandBannerSerializer":{"type":"object","properties":{"portrait":{"type":"string"},"landscape":{"type":"string"}},"required":["landscape","portrait"]},"GetBrandResponseSerializer":{"type":"object","properties":{"modified_by":{"$ref":"#/components/schemas/UserSerializer"},"banner":{"$ref":"#/components/schemas/BrandBannerSerializer"},"name":{"type":"string"},"_custom_json":{"type":"object"},"verified_on":{"type":"string","format":"date-time"},"created_by":{"$ref":"#/components/schemas/UserSerializer"},"created_on":{"type":"string","format":"date-time"},"warnings":{"type":"object"},"_locale_language":{"type":"object"},"mode":{"type":"string"},"synonyms":{"type":"array","items":{"type":"string"}},"modified_on":{"type":"string","format":"date-time"},"uid":{"type":"integer"},"reject_reason":{"type":"string"},"stage":{"type":"string"},"verified_by":{"$ref":"#/components/schemas/UserSerializer"},"slug_key":{"type":"string"},"logo":{"type":"string"},"description":{"type":"string"}},"required":["name"]},"CreateUpdateBrandRequestSerializer":{"type":"object","properties":{"_custom_json":{"type":"object"},"_locale_language":{"type":"object"},"synonyms":{"type":"array","items":{"type":"string"}},"company_id":{"type":"integer"},"description":{"type":"string"},"logo":{"type":"string"},"brand_tier":{"type":"string","enum":["boutique","mid","prime","seller"]},"uid":{"type":"integer"},"banner":{"$ref":"#/components/schemas/BrandBannerSerializer"},"name":{"type":"string"}},"required":["banner","logo","name"]},"CompanySocialAccounts":{"type":"object","properties":{"name":{"type":"string"},"url":{"type":"string"}},"required":["name","url"]},"CompanyDetails":{"type":"object","properties":{"company_name":{"type":"string","nullable":true},"address":{"type":"object","nullable":true},"company_cin":{"type":"string","nullable":true},"company_id":{"type":"integer","nullable":true},"company_gst":{"type":"string","nullable":true},"company_contact":{"$ref":"#/components/schemas/ContactDetails"}}},"CompanySerializer":{"type":"object","properties":{"stage":{"type":"string"},"_custom_json":{"type":"object"},"verified_on":{"type":"string","format":"date-time"},"verified_by":{"$ref":"#/components/schemas/UserSerializer"},"created_on":{"type":"string","format":"date-time"},"created_by":{"$ref":"#/components/schemas/UserSerializer"},"company_type":{"type":"string"},"modified_on":{"type":"string","format":"date-time"},"market_channels":{"type":"array","items":{"type":"string"}},"business_type":{"type":"string"},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/GetAddressSerializer"}},"notification_emails":{"type":"array","items":{"type":"string"}},"details":{"$ref":"#/components/schemas/CompanyDetails"},"business_country_info":{"$ref":"#/components/schemas/BusinessCountryInfo"},"uid":{"type":"integer"},"reject_reason":{"type":"string"},"name":{"type":"string"},"modified_by":{"$ref":"#/components/schemas/UserSerializer"}},"required":["business_type","company_type"]},"CompanyBrandSerializer":{"type":"object","properties":{"stage":{"type":"string"},"verified_on":{"type":"string","format":"date-time"},"verified_by":{"$ref":"#/components/schemas/UserSerializer"},"created_on":{"type":"string","format":"date-time"},"created_by":{"$ref":"#/components/schemas/UserSerializer"},"company":{"$ref":"#/components/schemas/CompanySerializer"},"warnings":{"type":"object"},"modified_on":{"type":"string","format":"date-time"},"uid":{"type":"integer"},"reject_reason":{"type":"string"},"brand":{"$ref":"#/components/schemas/GetBrandResponseSerializer"},"modified_by":{"$ref":"#/components/schemas/UserSerializer"}}},"CompanyBrandListSerializer":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/CompanyBrandSerializer"}},"page":{"$ref":"#/components/schemas/Page"}},"required":[]},"CompanyBrandPostRequestSerializer":{"type":"object","properties":{"uid":{"type":"integer"},"brands":{"type":"array","items":{"type":"integer"}},"company":{"type":"integer"}},"required":["brands","company"]},"HolidayDateSerializer":{"type":"object","properties":{"end_date":{"type":"string","format":"date-time"},"start_date":{"type":"string","format":"date-time"}},"required":["end_date","start_date"]},"HolidaySchemaSerializer":{"type":"object","properties":{"date":{"$ref":"#/components/schemas/HolidayDateSerializer"},"title":{"type":"string"},"holiday_type":{"type":"string","enum":["national","custom"]}},"required":["date","holiday_type","title"]},"AddressSerializer":{"type":"object","properties":{"landmark":{"type":"string","pattern":"^[a-zA-Z0-9&()_,.:/s -]*$"},"country_code":{"type":"string"},"pincode":{"type":"integer"},"address_type":{"type":"string"},"longitude":{"type":"number","minimum":-180,"maximum":180},"country":{"type":"string","pattern":"^[a-zA-Z0-9&()_,.:/s -]*$"},"address2":{"type":"string","pattern":"^[a-zA-Z0-9&()_,.:/s -]*$"},"state":{"type":"string","pattern":"^[a-zA-Z0-9&()_,.:/s -]*$"},"sector":{"type":"string","pattern":"^[a-zA-Z0-9&()_,.:/s -]*$"},"state_code":{"type":"string","pattern":"^[a-zA-Z0-9&()_,.:/s -]*$"},"address1":{"type":"string","pattern":"^[a-zA-Z0-9&()_,.:/s -]*$"},"city":{"type":"string","pattern":"^[a-zA-Z0-9&()_,.:/s -]*$"},"latitude":{"type":"number","minimum":-90,"maximum":90}},"required":["latitude","longitude","country_code"]},"LocationSerializer":{"type":"object","properties":{"code":{"type":"string"},"gst_credentials":{"$ref":"#/components/schemas/InvoiceDetailsSerializer"},"contact_numbers":{"type":"array","items":{"$ref":"#/components/schemas/SellerPhoneNumber"}},"name":{"type":"string"},"_custom_json":{"type":"object"},"warnings":{"type":"object"},"address":{"$ref":"#/components/schemas/AddressSerializer"},"company":{"type":"integer"},"store_type":{"type":"string"},"manager":{"$ref":"#/components/schemas/LocationManagerSerializer"},"auto_invoice":{"type":"boolean","default":false},"uid":{"type":"integer"},"timing":{"type":"array","items":{"$ref":"#/components/schemas/LocationDayWiseSerializer"}},"stage":{"type":"string"},"documents":{"type":"array","items":{"$ref":"#/components/schemas/Document"}},"credit_note":{"type":"boolean","default":false},"holiday":{"type":"array","items":{"$ref":"#/components/schemas/HolidaySchemaSerializer"}},"product_return_config":{"$ref":"#/components/schemas/ProductReturnConfigSerializer"},"display_name":{"type":"string"},"notification_emails":{"type":"array","items":{"type":"string"}},"tags":{"type":"array","items":{"type":"string"},"default":[]},"default_order_acceptance_timing":{"type":"boolean","description":"Flag to set order_acceptance_timing as default timing"},"order_acceptance_timing":{"type":"array","items":{"$ref":"#/components/schemas/LocationDayWiseSerializer"},"description":"Order acceptance timing of the store"},"avg_order_processing_time":{"$ref":"#/components/schemas/AverageOrderProcessingTime"},"bulk_shipment":{"type":"boolean","default":false},"auto_assign_courier_partner":{"type":"boolean","default":true}},"required":["address","code","company","display_name","name","documents"]},"BulkLocationSerializer":{"type":"object","properties":{"data":{"type":"array","maxItems":100,"items":{"$ref":"#/components/schemas/LocationSerializer"}}}},"AverageOrderProcessingTime":{"type":"object","properties":{"duration":{"type":"integer"},"duration_type":{"type":"string","enum":["hours","days","minutes"]}}},"StoreTagsResponseSchema":{"type":"object","properties":{"tags":{"type":"array","items":{"type":"string"}},"success":{"type":"boolean"}}},"ApplicationInventory":{"type":"object","properties":{"inventory":{"$ref":"#/components/schemas/AppInventoryConfig"},"authentication":{"$ref":"#/components/schemas/AuthenticationConfig"},"article_assignment":{"$ref":"#/components/schemas/ArticleAssignmentConfig"},"reward_points":{"$ref":"#/components/schemas/RewardPointsConfig"},"cart":{"$ref":"#/components/schemas/AppCartConfig"},"payment":{"$ref":"#/components/schemas/AppPaymentConfig"},"order":{"$ref":"#/components/schemas/AppOrderConfig"},"logistics":{"$ref":"#/components/schemas/AppLogisticsConfig"},"pii_masking":{"$ref":"#/components/schemas/PiiMasking"},"tags":{"type":"array","items":{"type":"string"}},"__v":{"type":"integer"},"business":{"type":"string","description":"Indicates the business type for sales channel e.g. retail or wholesale"},"comms_enabled":{"type":"boolean","description":"Shows communication(comms) is enabled or not for sales channel inventory"},"communication":{"$ref":"#/components/schemas/CommunicationConfig"},"platforms":{"type":"array","items":{"type":"string","description":"Shows a list of inventory platforms e.g. fynd_store, uniket_store"}},"_id":{"type":"string","description":"The unique identifier (24-digit Mongo Object ID) of the sales channel inventory"},"loyalty_points":{"$ref":"#/components/schemas/LoyaltyPointsConfig"},"app":{"type":"string","description":"Current sales channel ID"},"created_at":{"type":"string","description":"ISO 8601 timestamp of sales channel inventory creation"},"modified_at":{"type":"string","description":"ISO 8601 timestamp of sales channel inventory updation"},"modified_by":{"type":"string","description":"User ID of the person who made the latest changes in the sales channel inventory"}}},"PiiMasking":{"type":"object","properties":{"enabled":{"type":"boolean","default":false}}},"AppInventoryConfig":{"type":"object","properties":{"brand":{"$ref":"#/components/schemas/InventoryBrand"},"store":{"$ref":"#/components/schemas/InventoryStore"},"category":{"$ref":"#/components/schemas/InventoryCategory"},"price":{"$ref":"#/components/schemas/InventoryPrice"},"discount":{"$ref":"#/components/schemas/InventoryDiscount"},"out_of_stock":{"type":"boolean","description":"Indicates whether out of stock products are allowed to show up on the website"},"only_verified_products":{"type":"boolean","description":"Show only verified products (the ones whose data has been verified by the admin)"},"franchise_enabled":{"type":"boolean","description":"Allow other businesses (companies) to consume the current sales channel's inventory and sell products"},"exclude_category":{"type":"array","description":"List of excluded brands category","items":{}},"image":{"type":"array","items":{"type":"string","description":"Indicates whether imageless products are allowed to show up on the website","enum":["standard","substandard","default"]}},"company_store":{"type":"array","items":{},"description":"List of selling locations whose inventory is available to the sales channel for displaying on the website"},"company_id":{"type":"integer"}}},"InventoryBrand":{"type":"object","properties":{"criteria":{"type":"string","description":"All brands or specific (explicit) brands to be shown on the website"},"brands":{"type":"array","description":"List of brands","items":{"type":"integer"}}}},"InventoryStore":{"type":"object","properties":{"criteria":{"type":"string","description":"All stores or specific (explicit) stores to be shown on the website"},"stores":{"type":"array","description":"List of stores","items":{}},"rules":{"type":"array","description":"Rules to show which brands or companies products should be listed on sales channel.","items":{"$ref":"#/components/schemas/AppStoreRules"}}}},"AppStoreRules":{"type":"object","properties":{"companies":{"type":"array","description":"List of companies whose inventory is available to the sales channel for displaying on the website","items":{"type":"integer","format":"int32"}},"brands":{"type":"array","description":"List of brands whose products will be shown on the website","items":{"type":"integer"}}}},"InventoryCategory":{"type":"object","properties":{"criteria":{"type":"string"},"categories":{"type":"array","description":"List of categories whose products will be shown on the website","items":{}}}},"InventoryPrice":{"type":"object","properties":{"min":{"type":"number","format":"float","description":"Minimum inventory price"},"max":{"type":"number","format":"float","description":"Maximum inventory price"}}},"InventoryDiscount":{"type":"object","properties":{"min":{"type":"number","format":"float","description":"Minimum inventory discount"},"max":{"type":"number","format":"float","description":"Maximum inventory discount"}}},"AuthenticationConfig":{"type":"object","properties":{"required":{"type":"boolean","description":"Shows sales channel inventory authentication is required or not"},"provider":{"type":"string","description":"Shows inventory authentication provider"}}},"ArticleAssignmentConfig":{"type":"object","properties":{"rules":{"$ref":"#/components/schemas/ArticleAssignmentRules"},"post_order_reassignment":{"type":"boolean","description":"Allow post order reassigment of article"},"enforced_stores":{"type":"array","items":{"type":"integer"}}}},"ArticleAssignmentRules":{"type":"object","properties":{"store_priority":{"$ref":"#/components/schemas/StorePriority"}}},"StorePriority":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Shows store priority is enabled or disabled for assignment of article"},"storetype_order":{"type":"array","items":{},"description":"List of store types for article assignment e.g. warehouse, mall, highstreet"}}},"AppCartConfig":{"type":"object","properties":{"delivery_charges":{"$ref":"#/components/schemas/DeliveryCharges"},"international_delivery_charges":{"$ref":"#/components/schemas/InternationalDeliveryCharges"},"enabled":{"type":"boolean","description":"Shows whether cart configuration is enabled or not"},"max_cart_items":{"type":"integer","format":"int32","description":"Maximum number of items that can be added to cart by the customer"},"min_cart_value":{"type":"number","format":"float","description":"Minimum cart value below which customer cannot place an order"},"bulk_coupons":{"type":"boolean","description":"Allow creation of bulk coupons"},"revenue_engine_coupon":{"type":"boolean","description":"Allow coupon apply and credits together. Default value is false."},"pan_card":{"$ref":"#/components/schemas/PanCardConfig"}}},"InternationalDeliveryCharges":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Allow international delivery charges"},"charges":{"type":"array","items":{"$ref":"#/components/schemas/Charges"}}}},"AppPaymentConfig":{"type":"object","properties":{"callback_url":{"$ref":"#/components/schemas/CallbackUrl"},"methods":{"$ref":"#/components/schemas/Methods"},"payment_selection_lock":{"$ref":"#/components/schemas/PaymentSelectionLock"},"mode_of_payment":{"type":"string","description":"Mode of payment for sales channel payment, e.g. 'ECOMM'."},"source":{"type":"string","description":"Source of the payment mode, e.g. 'ECOMM'. Default value is FYND."},"enabled":{"type":"boolean","description":"Allow payment option within sales channel"},"cod_amount_limit":{"type":"number","format":"float","description":"Maximum amount allowed for COD order. Beyond this, customer cannot opt for COD."},"cod_charges":{"type":"number","format":"float","description":"Extra charge applicable for COD orders"},"anonymous_cod":{"type":"boolean","description":"Allow cash on delivery for anonymous user"},"user_cod_limit":{"type":"number","format":"float"}}},"CallbackUrl":{"type":"object","properties":{"app":{"type":"string","description":"Payment callback url for app"},"web":{"type":"string","description":"Payment callback url for web"}}},"Methods":{"type":"object","properties":{"pl":{"$ref":"#/components/schemas/PaymentModeConfig"},"card":{"$ref":"#/components/schemas/PaymentModeConfig"},"nb":{"$ref":"#/components/schemas/PaymentModeConfig"},"wl":{"$ref":"#/components/schemas/PaymentModeConfig"},"ps":{"$ref":"#/components/schemas/PaymentModeConfig"},"upi":{"$ref":"#/components/schemas/PaymentModeConfig"},"qr":{"$ref":"#/components/schemas/PaymentModeConfig"},"cod":{"$ref":"#/components/schemas/PaymentModeConfig"},"pp":{"$ref":"#/components/schemas/PaymentModeConfig"},"jp":{"$ref":"#/components/schemas/PaymentModeConfig"},"pac":{"$ref":"#/components/schemas/PaymentModeConfig"},"fc":{"$ref":"#/components/schemas/PaymentModeConfig"},"jiopp":{"$ref":"#/components/schemas/PaymentModeConfig"},"stripepg":{"$ref":"#/components/schemas/PaymentModeConfig"},"juspaypg":{"$ref":"#/components/schemas/PaymentModeConfig"},"payubizpg":{"$ref":"#/components/schemas/PaymentModeConfig"},"payumoneypg":{"$ref":"#/components/schemas/PaymentModeConfig"},"rupifipg":{"$ref":"#/components/schemas/PaymentModeConfig"},"simpl":{"$ref":"#/components/schemas/PaymentModeConfig"}}},"PaymentModeConfig":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment."}}},"AppOrderConfig":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Allow orders to be accepted from the sales channel"},"force_reassignment":{"type":"boolean","description":"Allow force reassigning of an order"},"message":{"type":"string","description":"Reason for reassigning an order"}}},"AppLogisticsConfig":{"type":"object","properties":{"logistics_by_seller":{"type":"boolean"},"serviceability_check":{"type":"boolean"},"same_day_delivery":{"type":"boolean"},"dp_assignment":{"type":"boolean"}}},"LoyaltyPointsConfig":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Shows loyalty points is enabled or not enabled"},"auto_apply":{"type":"boolean","description":"Allow auto apply of loyalty points"}}},"AppInventoryPartialUpdate":{"type":"object","properties":{"reward_points":{"$ref":"#/components/schemas/RewardPointsConfig"},"cart":{"$ref":"#/components/schemas/AppCartConfig"},"payment":{"$ref":"#/components/schemas/AppPaymentConfig"},"loyalty_points":{"$ref":"#/components/schemas/LoyaltyPointsConfig"},"comms_enabled":{"type":"boolean","description":"Shows communication (comms) is enabled or not for sales channel partial inventory update"},"communication":{"$ref":"#/components/schemas/CommunicationConfig"}}},"BrandCompanyInfo":{"type":"object","properties":{"company_name":{"type":"string","description":"Name of the company dealing with the brand"},"company_id":{"type":"integer","format":"int32","description":"Numeric ID allotted to a business account"}}},"CompanyByBrandsRequest":{"type":"object","properties":{"brands":{"type":"integer","format":"int32","description":"Brand UID"},"search_text":{"type":"string","description":"A search field for finding a company by its name"}},"required":["brands"]},"CompanyByBrandsResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/BrandCompanyInfo"}},"page":{"$ref":"#/components/schemas/Page"}},"required":[]},"StoreByBrandsRequest":{"type":"object","properties":{"company_id":{"type":"integer","format":"int32","description":"Current company ID for current company stores only. Don't send in case cross-selling (franchise) is enabled."},"brands":{"type":"integer","format":"int32","description":"Brand UID"},"search_text":{"type":"string","description":"Search store by its name or store code"}},"required":["brands"]},"StoreByBrandsResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/BrandStoreInfo"}},"page":{"$ref":"#/components/schemas/Page"}},"required":[]},"BrandStoreInfo":{"type":"object","properties":{"store_name":{"type":"string","description":"Name of the selling location (store)"},"store_id":{"type":"integer","format":"int32","description":"The unique identifier of the selling location (store)"},"store_type":{"type":"string","description":"Store type of the brand like warehouse, high_street, mall"},"store_code":{"type":"string","description":"Store code of the brand. It is unique for every brand store."},"store_address":{"$ref":"#/components/schemas/OptedStoreAddress"},"company":{"$ref":"#/components/schemas/OptedCompany"}}},"CompanyBrandInfo":{"type":"object","properties":{"name":{"type":"string","description":"Brand name, e.g. Raymonds"},"value":{"type":"integer","format":"int32","description":"Brand UID for identifying the brand"},"brand_logo_url":{"type":"string","description":"Hosted URL of the brand's logo"},"brand_banner_url":{"type":"string","description":"Hosted URL of the brand's banner image"},"brand_banner_portrait_url":{"type":"string","description":"Hosted URL of the brand's portrait banner"}}},"BrandsByCompanyResponse":{"type":"object","properties":{"brands":{"type":"array","items":{"$ref":"#/components/schemas/CompanyBrandInfo"}}}},"ValidationFailedResponse":{"type":"object","properties":{"message":{"type":"string","description":"Response message for failed validation"}}},"CommunicationConfig":{"type":"object","description":"Maintains communication channel enable/disable state for email, sms and voice","properties":{"email":{"$ref":"#/components/schemas/CommsConfig"},"sms":{"$ref":"#/components/schemas/CommsConfig"},"voice":{"$ref":"#/components/schemas/CommsConfig"}}},"CommsConfig":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Check current communication channel is enabled"}}},"PanCardConfig":{"type":"object","properties":{"enabled":{"type":"boolean","description":"If pan card accepting is enabled on cart"},"cod_threshold_amount":{"type":"number","description":"On which COD order amount pan card number is expected from customer for order"},"online_threshold_amount":{"type":"number","description":"On which online payment order amount pan card number is expected from customer for order"}}},"CreateApplicationRequest":{"type":"object","properties":{"app":{"$ref":"#/components/schemas/App"},"configuration":{"$ref":"#/components/schemas/ApplicationInventory"},"domain":{"$ref":"#/components/schemas/AppDomain"}}},"CreateAppResponse":{"type":"object","properties":{"app":{"$ref":"#/components/schemas/Application"},"configuration":{"$ref":"#/components/schemas/ApplicationInventory"}}},"ApplicationsResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Application"}},"page":{"$ref":"#/components/schemas/Page"}},"required":[]},"MobileAppConfiguration":{"type":"object","properties":{"is_active":{"type":"boolean","description":"Indicates the availability of the mobile build"},"_id":{"type":"string","description":"The unique identifier (24-digit Mongo Object ID) for mobile application configuration"},"app_name":{"type":"string","description":"Name of the mobile app"},"landing_image":{"$ref":"#/components/schemas/LandingImage"},"splash_image":{"$ref":"#/components/schemas/SplashImage"},"application":{"type":"string","description":"Application ID of the current sales channel"},"platform_type":{"type":"string","enum":["android","ios"],"description":"Device platform for which the mobile app was built, e.g. android, ios."},"created_at":{"type":"string","description":"ISO 8601 timestamp of application configuration creation"},"modified_at":{"type":"string","description":"ISO 8601 timestamp of last known modifications to the app build"},"__v":{"type":"integer","format":"int32","description":"Version key for tracking revisions. Default value is zero."},"package_name":{"type":"string","description":"Shows bundle identifier if device platform is iOS, and directory of the app if device platform is Android"}}},"LandingImage":{"type":"object","properties":{"aspect_ratio":{"type":"string","description":"Width-to-height ratio of landing image"},"secure_url":{"type":"string","description":"URL where the landing image is hosted"}}},"SplashImage":{"type":"object","properties":{"aspect_ratio":{"type":"string","description":"Width-to-height ratio of splash image"},"secure_url":{"type":"string","description":"URL where the splash image is hosted"}}},"MobileAppConfigRequest":{"type":"object","properties":{"app_name":{"type":"string","description":"Name of the mobile app"},"landing_image":{"$ref":"#/components/schemas/LandingImage"},"splash_image":{"$ref":"#/components/schemas/SplashImage"},"is_active":{"type":"boolean","description":"shows update in mobile app config is active or not"}}},"BuildVersionHistory":{"type":"object","properties":{"versions":{"type":"array","items":{"$ref":"#/components/schemas/BuildVersion"}},"latest_available_version_name":{"type":"string","description":"Latest version number of the mobile build, in dot-decimal notation"}}},"BuildVersion":{"type":"object","properties":{"_id":{"type":"string","description":"24-digit Mongo Object ID"},"application":{"type":"string","description":"Application ID of the sales channel"},"platform_type":{"type":"string","enum":["android","ios"],"description":"Device platform for which the mobile app was built, e.g. android, ios."},"build_status":{"type":"string","enum":["pending","cancelled","failed","success"],"description":"Current progress of the mobile build, e.g. pending, cancelled, failed, success"},"version_name":{"type":"string","description":"Version number of the mobile build, in dot-decimal notation"},"version_code":{"type":"integer","format":"int32","description":"A positive integer used as an internal version number"},"download_url":{"$ref":"#/components/schemas/LandingImage"},"created_at":{"type":"string","description":"ISO 8601 timestamp of app creation"},"modified_at":{"type":"string","description":"ISO 8601 timestamp of last known modifications to the app build"},"__v":{"type":"integer","format":"int32","description":"Version key for tracking revisions. Default value is zero."}}},"AppSupportedCurrency":{"type":"object","properties":{"_id":{"type":"string","description":"The unique identifier (24-digit Mongo Object ID) of the currency configuration supported by the application"},"supported_currency":{"type":"array","items":{"type":"string","description":"List of currencies added to the supported currencies of current sales channel"}},"application":{"type":"string","description":"Alphanumeric ID allotted to an application (sales channel website) created within a business account."},"default_currency":{"$ref":"#/components/schemas/DefaultCurrency"},"created_at":{"type":"string","description":"ISO 8601 timestamp when currency was added in the list of currencies supported by the sales channel"},"modified_at":{"type":"string","description":"ISO 8601 timestamp when currency was updated in the list of currencies supported by the sales channel"}}},"DefaultCurrency":{"type":"object","properties":{"ref":{"type":"string","description":"The unique identifier (24-digit Mongo Object ID) of the default currency"},"code":{"type":"string","description":"3-character code of the default currency, e.g. INR, EUR, USD"}}},"DomainAdd":{"type":"object","properties":{"name":{"type":"string","description":"Full domain name, e.g. uniket.hostx0.de"},"_id":{"type":"string","description":"The unique identifier (24-digit Mongo Object ID) of the domain"},"verified":{"type":"boolean","description":"Domain is verified or not (indicates if A records and TXT records are correct)"},"is_primary":{"type":"boolean","description":"Domain is primary or not (indicates if the domain has been made the main URL of the sales channel)"},"is_shortlink":{"type":"boolean","description":"Indicates if the domain is a short link domain (short URL e.g. bitly)"},"message":{"type":"string","description":"Shows the message shown after adding a domain successfully, e.g. 'New domain added successfully'"},"txt_records":{"type":"array","items":{"type":"string","description":"List of TXT records added to the domain"}}}},"DomainAddRequest":{"type":"object","properties":{"domain":{"$ref":"#/components/schemas/DomainAdd"}}},"DomainsResponse":{"type":"object","properties":{"domains":{"type":"array","items":{"$ref":"#/components/schemas/Domain"}}}},"UpdateDomain":{"type":"object","properties":{"name":{"type":"string","description":"Full domain name, e.g. zenz.com"},"_id":{"type":"string","description":"The unique identifier (24-digit Mongo Object ID) of the domain"},"verified":{"type":"boolean","description":"Domain is verified or not (indicates if A records and TXT records are correct)"},"is_primary":{"type":"boolean","description":"Domain is primary or not (indicates if the domain has been made the main URL of the sales channel)"},"is_shortlink":{"type":"boolean","description":"Indicates if the domain is a short link domain (short URL e.g. bit.ly)"}}},"UpdateDomainTypeRequest":{"type":"object","properties":{"domain":{"$ref":"#/components/schemas/UpdateDomain"},"action":{"type":"string","description":"Shows domain is made primary domain for the sales channel or shorlink is created for the sales channel domain","enum":["primary","shortlink"]}}},"DomainStatusRequest":{"type":"object","properties":{"domain_url":{"type":"string","description":"URL of the domain, e.g. uniket.hostx0.de"}}},"DomainStatus":{"type":"object","properties":{"display":{"type":"string","description":"Shows TXT record and A records for the domain"},"status":{"type":"boolean","description":"Shows whether TXT record or A records for the domain are correctly propagating via DNS servers"}}},"DomainStatusResponse":{"type":"object","properties":{"connected":{"type":"boolean","description":"Check if domain is live and mapped to appropriate IP of Fynd Servers"},"status":{"type":"array","items":{"$ref":"#/components/schemas/DomainStatus"}}}},"DomainSuggestionsRequest":{"type":"object","properties":{"domain_url":{"type":"string","description":"Domain url"},"custom":{"type":"boolean","description":"Get suggestions for custom domains or Fynd domains"}}},"DomainSuggestion":{"type":"object","properties":{"name":{"type":"string","description":"URL of the custom domain"},"unsupported":{"type":"boolean","description":"Shows whether TLD domain is supported or not"},"is_available":{"type":"boolean","description":"Shows whether the custom domain of your choice is available or not available"},"price":{"type":"number","description":"Cost of purchasing a custom domain. Not present for Fynd domains."},"currency":{"type":"string","description":"Custom domain currency. Not present for Fynd domains."}},"required":["name","is_available"]},"DomainSuggestionsResponse":{"type":"object","properties":{"domains":{"type":"array","description":"Domain URL","items":{"$ref":"#/components/schemas/DomainSuggestion"}}}},"SuccessMessageResponse":{"type":"object","properties":{"success":{"type":"string"}}},"GetIntegrationsOptInsResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/IntegrationOptIn"}},"page":{"$ref":"#/components/schemas/Page"}},"required":[]},"IntegrationOptIn":{"type":"object","properties":{"validators":{"$ref":"#/components/schemas/Validators"},"description":{"type":"string","description":"Basic description about the opted integration"},"description_html":{"type":"string","description":"Basic HTML description about the opted integration"},"constants":{"type":"string"},"companies":{"type":"array","items":{"type":"string","description":"List of companies selected for opted integration"}},"support":{"type":"array","items":{"type":"string","description":"Shows the permissions selected for opted integration. It can be inventory or order. By default, both inventory and order are selected."}},"_id":{"type":"string","description":"The unique identifier (24-digit Mongo Object ID) of the opted integration"},"name":{"type":"string","description":"Nmae of the opted integration, e.g. SAP RBL Integration"},"slug":{"type":"string","description":"Slug of the opted integration, e.g. ginesys"},"hidden":{"type":"boolean"},"meta":{"type":"array","items":{"$ref":"#/components/schemas/IntegrationMeta"}},"icon":{"type":"string","description":"Hosted URL of the icon image"},"owner":{"type":"string","description":"The unique identifier (24-digit Mongo Object ID) of the user who created the integration"},"created_at":{"type":"string","description":"ISO 8601 timestamp of integration creation"},"modified_at":{"type":"string","description":"ISO 8601 timestamp of integration updation"},"token":{"type":"string","description":"Randomly generated fixed-length string for opted integration. It is auto-generated. It would never change once it is generated."},"secret":{"type":"string","description":"Randomly generated fixed-length string for opted integration. It is auto-generated. It would never change once it is generated."},"__v":{"type":"integer","format":"int32","description":"Version key for tracking revisions. Default value is zero."}}},"Validators":{"type":"object","properties":{"company":{"$ref":"#/components/schemas/CompanyValidator"},"store":{"$ref":"#/components/schemas/StoreValidator"},"inventory":{"$ref":"#/components/schemas/InventoryValidator"},"order":{"$ref":"#/components/schemas/OrderValidator"}}},"CompanyValidator":{"type":"object","properties":{"json_schema":{"type":"array","items":{"$ref":"#/components/schemas/JsonSchema"}},"browser_script":{"type":"string","description":"Browser script for the company validator"}}},"JsonSchema":{"type":"object","properties":{"display":{"type":"string","description":"Display text of the validator JSON schema. It will show in the UI."},"key":{"type":"string","description":"Key related to the display text of the validator JSON schema"},"type":{"type":"string","description":"Indicates the type of form field, e.g. Text, Dropdown."},"tooltip":{"type":"string","description":"Tooltip text for the UI of the validator JSON schema. It will show in the UI."}}},"StoreValidator":{"type":"object","properties":{"json_schema":{"type":"array","items":{"$ref":"#/components/schemas/JsonSchema"}},"browser_script":{"type":"string","description":"Browser script for the store validator"}}},"InventoryValidator":{"type":"object","properties":{"json_schema":{"type":"array","items":{"$ref":"#/components/schemas/JsonSchema"}},"browser_script":{"type":"string","description":"Browser script for the inventory validator"}}},"OrderValidator":{"type":"object","properties":{"json_schema":{"type":"array","items":{"$ref":"#/components/schemas/JsonSchema"}},"browser_script":{"type":"string","description":"Browser script for the order validator"}}},"IntegrationMeta":{"type":"object","additionalProperties":true,"properties":{"is_public":{"type":"boolean"},"_id":{"type":"string","description":"The unique identifier (24-digit Mongo Object ID) of the integration meta"},"name":{"type":"string","description":"Nmae of integration meta, e.g. price_level"},"value":{"type":"string","description":"Value related to integration meta name, e.g. store"}}},"Integration":{"type":"object","properties":{"validators":{"$ref":"#/components/schemas/Validators"},"description":{"type":"string","description":"Basic description about the integration"},"description_html":{"type":"string","description":"Basic HTML description about the integration"},"constants":{"type":"object"},"companies":{"type":"array","items":{"type":"string","description":"List of companies selected for integration. By default, all companies are selected."}},"support":{"type":"array","items":{"type":"string","description":"Shows the permissions selected for integration. It can be inventory or order. By default, both inventory and order are selected."}},"_id":{"type":"string","description":"The unique identifier (24-digit Mongo Object ID) of the integration"},"name":{"type":"string","description":"Name of the integration, e.g. SAP RBL Integration"},"slug":{"type":"string","description":"Name of the integration, e.g. SAP RBL Integration"},"meta":{"type":"array","items":{"$ref":"#/components/schemas/IntegrationMeta"}},"icon":{"type":"string","description":"Hosted URL of the icon image"},"hidden":{"type":"boolean"},"owner":{"type":"string","description":"The unique identifier (24-digit Mongo Object ID) of the user who created the integration"},"created_at":{"type":"string","description":"ISO 8601 timestamp of integration creation"},"modified_at":{"type":"string","description":"ISO 8601 timestamp of integration updation"},"token":{"type":"string","description":"Randomly generated fixed-length string for opted integration. It is auto-generated. It would never change once it is generated."},"secret":{"type":"string","description":"Randomly generated fixed-length string for opted integration. It is auto-generated. It would never change once it is generated."},"__v":{"type":"integer","format":"int32","description":"Version key for tracking revisions. Default value is zero."}}},"IntegrationConfigResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/IntegrationLevel"}}}},"IntegrationLevel":{"type":"object","additionalProperties":true,"properties":{"opted":{"type":"boolean","description":"Shows this integration is opted or not opted for the current company"},"permissions":{"type":"array","items":{"type":"object","description":"Indicates which perticular integration level you are doing. It can be inventory level or order level."}},"last_patch":{"type":"array","items":{"$ref":"#/components/schemas/LastPatch"}},"_id":{"type":"string","description":"The unique identifier (24-digit Mongo Object ID) of the integration config"},"integration":{"type":"string","description":"Integration id. Shows which integration you are enabling."},"level":{"type":"string","description":"Shows for what level the integration is set up. It can be company level or store level."},"uid":{"type":"integer","format":"int32","description":"It can be store uid or company uid. Depends on the level of integration."},"company_id":{"type":"integer","format":"int32","description":"Unique id of company."},"meta":{"type":"array","items":{"$ref":"#/components/schemas/IntegrationMeta"}},"token":{"type":"string","description":"Randomly generated fixed-length string for opted integration. It is auto-generated. It would never change once it is generated."},"created_at":{"type":"string","description":"ISO 8601 timestamp of integration config creation"},"modified_at":{"type":"string","description":"ISO 8601 timestamp of integration config updation"},"__v":{"type":"integer","format":"int32","description":"Version key for tracking revisions. Default value is zero."},"data":{"type":"object","description":"Schema data of the integration stored in key-value pairs"},"success":{"type":"boolean"},"message":{"type":"string"}}},"UpdateIntegrationLevelRequest":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/IntegrationLevel"}}}},"OptedStoreIntegration":{"type":"object","properties":{"other_opted":{"type":"boolean","description":"Allow user to opt same store in other integration"},"other_integration":{"$ref":"#/components/schemas/IntegrationOptIn"},"other_entity":{"$ref":"#/components/schemas/OtherEntity"}}},"OtherEntity":{"type":"object","properties":{"opted":{"type":"boolean","description":"Allow other entity opted in integration"},"permissions":{"type":"array","items":{"type":"string","description":"It can be inventory level or order level"}},"last_patch":{"type":"array","items":{"$ref":"#/components/schemas/LastPatch"}},"_id":{"type":"string","description":"The unique identifier of the other entity for opted store integration"},"integration":{"type":"string","description":"Integration ID. Shows which integration you are enabling."},"level":{"type":"string","description":"Indicates integration level. It can be company level or store level."},"uid":{"type":"integer","format":"int32","description":"It can be store uid or company uid. Depends on the level of integration."},"data":{"$ref":"#/components/schemas/OtherEntityData"},"meta":{"type":"array","items":{"type":"object","description":"Extra information (meta data) stored in key-value pairs"}},"token":{"type":"string","description":"Randomly generated fixed-length string for opted integration. It is auto-generated. It would never change once it is generated."},"created_at":{"type":"string","description":"ISO 8601 timestamp of other entity creation for opted store integration"},"modified_at":{"type":"string","description":"ISO 8601 timestamp of other entity updation for opted store integration"},"__v":{"type":"integer","format":"int32","description":"Version key for tracking revisions. Default value is zero."}}},"LastPatch":{"type":"object","properties":{"op":{"type":"string"},"path":{"type":"string"},"value":{"type":"string","description":"It can be inventory level or order level"}}},"OtherEntityData":{"type":"object","properties":{"article_identifier":{"type":"string"}}},"App":{"type":"object","properties":{"company_id":{"type":"string","description":"Numeric ID allotted to a business account on Fynd Platform."},"channel_type":{"type":"string","description":"It indicates different channel types like store, website-and-mobile-apps. Default value is store","enum":["website-and-mobile-apps","store"]},"auth":{"$ref":"#/components/schemas/ApplicationAuth"},"name":{"type":"string","description":"User-friendly name for sales channel, e.g. Zenz Fashion"},"desc":{"type":"string","description":"Detailed description about the sales channel"}}},"AppInventory":{"type":"object","properties":{"inventory":{"$ref":"#/components/schemas/InventoryConfig"},"payment":{"$ref":"#/components/schemas/InventoryPaymentConfig"},"article_assignment":{"$ref":"#/components/schemas/InventoryArticleAssignment"}}},"AppDomain":{"type":"object","properties":{"name":{"type":"string","description":"Domain URL of current sales channel, e.g. zenz.com"}}},"CompaniesResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/AppInventoryCompanies"}},"page":{"$ref":"#/components/schemas/Page"}},"required":[]},"AppInventoryCompanies":{"type":"object","additionalProperties":true,"properties":{"uid":{"type":"integer","format":"int32","description":"UID of the company, e.g. 108"},"name":{"type":"string","description":"Name of the company, e.g. Newton Traders"},"company_type":{"type":"string","description":"Indicates the type of the company, e.g. franchisee, distributor, etc."}}},"StoresResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/AppInventoryStores"}},"page":{"$ref":"#/components/schemas/Page"}},"required":[]},"AppInventoryStores":{"additionalProperties":true,"type":"object","properties":{"_id":{"type":"string","description":"The unique identifier of the store (24-digit Mongo Object ID) in the sales channel inventory"},"modified_on":{"type":"string","description":"ISO 8601 timestamp of last known updation to the stores in sales channel inventory"},"uid":{"type":"integer","format":"int32","description":"Sales channel inventory store UID"},"name":{"type":"string","description":"Name of the store in the sales channel inventory, e.g. Reebok Mumbai"},"display_name":{"type":"string","description":"Display name of the sales channel inventory store (can be different than the actual store name), e.g. Reebok MUM"},"store_type":{"type":"string","description":"Store type of the sales channel inventory store, such as mall, warehouse, high_street"},"store_code":{"type":"string","description":"Store code of the enabled inventory store, e.g. HS-c9bac. It is unique for every store."},"company_id":{"type":"integer","format":"int32","description":"Company ID of the selling location (store) added to the sales channel's inventory"},"address":{"type":"object","additionalProperties":true},"integration_type":{"type":"object","additionalProperties":true}}},"FilterOrderingStoreRequest":{"type":"object","properties":{"all_stores":{"type":"boolean","description":"Allow all stores from the ordering stores"},"deployed_stores":{"type":"array","items":{"type":"integer","format":"int32","description":"List of stores where the application is deployed"}},"q":{"type":"string","description":"Store code or name of the ordering store"}}},"DeploymentMeta":{"type":"object","properties":{"deployed_stores":{"type":"array","items":{"type":"integer","format":"int32","description":"List of deployed stores"}},"all_stores":{"type":"boolean","description":"Allow all stores from the ordering store"},"enabled":{"type":"boolean","description":"Allow ordering stores for current sales channel"},"type":{"type":"string","description":"Permitted values are 'hard' and 'soft'. For hard type delivery, store selection is compulsory. For soft type, delivery store selection is optional.","enum":["soft","hard"]},"_id":{"type":"string","description":"The unique identifier (24-digit Mongo Object ID) of the ordering stores"},"app":{"type":"string","description":"Alphanumeric ID allotted to an application (sales channel website) created within a business account"},"__v":{"type":"integer"}}},"OrderingStoreConfig":{"type":"object","properties":{"deployment_meta":{"$ref":"#/components/schemas/DeploymentMeta"}}},"OrderingStoreSelectRequest":{"type":"object","required":["ordering_store"],"properties":{"ordering_store":{"$ref":"#/components/schemas/OrderingStoreSelect"}}},"OrderingStoreSelect":{"type":"object","required":["uid"],"properties":{"uid":{"type":"integer","format":"int32","description":"Ordering store unique uid. It is required."}}},"OtherSellerCompany":{"type":"object","properties":{"uid":{"type":"integer","format":"int32","description":"Uid of the seller company"},"name":{"type":"string","description":"Name of the seller company"}}},"OtherSellerApplication":{"type":"object","properties":{"name":{"type":"string","description":"Name of the other seller's sales channel"},"description":{"type":"string","description":"Basic details about the other seller's sales channel"},"_id":{"type":"string","description":"The unique identifier (24-digit Mongo Object ID) of the other seller's sales channel"},"domain":{"type":"string","description":"Domain URL of the other seller's sales channel"},"company":{"$ref":"#/components/schemas/OtherSellerCompany"},"opt_type":{"type":"string","description":"Inventory opted by the other seller's sales channel. It can be the current company or stores in the current company.","enum":["store","company"]}}},"OtherSellerApplications":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/OtherSellerApplication"}},"page":{"$ref":"#/components/schemas/Page"}},"required":[]},"OptedApplicationResponse":{"type":"object","properties":{"name":{"type":"string","description":"Name of the other seller's sales channel"},"description":{"type":"string","description":"Basic details about the other seller's sales channel"},"_id":{"type":"string","description":"The unique identifier (24-digit Mongo Object ID) of the other seller's sales channel"},"domain":{"type":"string","description":"Domain URL of the other seller's sales channel"},"company":{"$ref":"#/components/schemas/OptedCompany"},"opted_inventory":{"$ref":"#/components/schemas/OptedInventory"},"opt_out_inventory":{"$ref":"#/components/schemas/OptOutInventory"}}},"OptedCompany":{"type":"object","properties":{"uid":{"type":"integer","format":"int32","description":"Company UID opted by the other seller's sales channel in its inventory. It has unique value for the company."},"name":{"type":"string","description":"Name of the company opted by the other seller's sales channel in its inventory"},"id":{"type":"integer","description":"The unique identifier of the opted inventory company"}}},"OptedInventory":{"type":"object","properties":{"opt_type":{"$ref":"#/components/schemas/OptType"},"items":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/OptedStore"},{"$ref":"#/components/schemas/OptedCompany"}]}}}},"OptType":{"type":"object","properties":{"key":{"type":"string","description":"Opted type of inventory store. It can be store or company."},"display":{"type":"string","description":"Display text of opted type for inventory store"}}},"OptedStore":{"type":"object","properties":{"name":{"type":"string","description":"Name of the inventory store opted by other seller's application"},"store_code":{"type":"string","description":"Store code of the opted inventory store. It is unique for every store."},"_id":{"type":"string","description":"The unique identifier of the opted inventory store"},"modified_on":{"type":"string","description":"ISO 8601 timestamp of opted inventory store creation"},"uid":{"type":"integer","format":"int32","description":"UID of opted inventory store"},"address":{"$ref":"#/components/schemas/OptedStoreAddress"},"display_name":{"type":"string","description":"Display name of the opted inventory store"},"store_type":{"type":"string","description":"Store type of the opted inventory store like warehouse, high_street, mall."},"company_id":{"type":"integer","format":"int32","description":"Company ID of the opted inventory store"}}},"OptOutInventory":{"type":"object","properties":{"store":{"type":"array","items":{"type":"integer","format":"int32"},"description":"List of selling locations (stores) opted out from the inventory of other seller's application"},"company":{"type":"array","items":{"type":"integer","format":"int32"},"description":"List of companies opted out from the inventory of other seller's application"}},"required":["store","company"]},"TokenResponse":{"type":"object","properties":{"tokens":{"$ref":"#/components/schemas/Tokens"},"_id":{"type":"string","description":"The unique identifier (24-digit Mongo Object ID) of the token"},"application":{"type":"string","description":"Alphanumeric ID allotted to the current application created within the current business account"},"created_at":{"type":"string","description":"ISO 8601 timestamp of token creation"},"modified_at":{"type":"string","description":"ISO 8601 timestamp of token updation"},"__v":{"type":"integer","format":"int32","description":"Version key for tracking revisions. Default value is zero."}}},"Tokens":{"type":"object","properties":{"firebase":{"$ref":"#/components/schemas/Firebase"},"moengage":{"$ref":"#/components/schemas/Moengage"},"segment":{"$ref":"#/components/schemas/Segment"},"gtm":{"$ref":"#/components/schemas/Gtm"},"freshchat":{"$ref":"#/components/schemas/Freshchat"},"safetynet":{"$ref":"#/components/schemas/Safetynet"},"fynd_rewards":{"$ref":"#/components/schemas/FyndRewards"},"google_map":{"$ref":"#/components/schemas/GoogleMap"}}},"Firebase":{"type":"object","properties":{"credentials":{"$ref":"#/components/schemas/Credentials"},"enabled":{"type":"boolean","description":"Shows whether Firebase integration is enabled or disabled for the sales channel"}}},"Credentials":{"type":"object","properties":{"ios":{"$ref":"#/components/schemas/Ios"},"android":{"$ref":"#/components/schemas/Android"},"project_id":{"type":"string","format":"base64","description":"Project ID for Firebase integration. Project ID is a unique identifier for a project and is used only within the console."},"gcm_sender_id":{"type":"string","format":"base64","description":"Google Cloud Manager's Sender ID for Firebase. It is a unique numerical value which is created when you configure your project in the Google Developers Console/Google Cloud Console."},"application_id":{"type":"string","format":"base64","description":"Alphanumeric ID allotted to the current application created within the current business account"},"api_key":{"type":"string","format":"base64","description":"An API key is a unique string that's used to route requests to your Firebase project when interacting with Firebase."}}},"Ios":{"type":"object","properties":{"application_id":{"type":"string","format":"base64","description":"Alphanumeric ID allotted to a sales channel application created within a business account"},"api_key":{"type":"string","format":"base64","description":"Firebase secret credential API key for IOS"}}},"Android":{"type":"object","properties":{"application_id":{"type":"string","format":"base64","description":"Alphanumeric ID allotted to a sales channel application created within a business account"},"api_key":{"type":"string","format":"base64","description":"Firebase secret credential API key for Android"}}},"Moengage":{"type":"object","properties":{"credentials":{"$ref":"#/components/schemas/MoengageCredentials"},"enabled":{"type":"boolean","description":"Shows whether MoEngage integation is enabled or disabled for the sales channel"}}},"MoengageCredentials":{"type":"object","properties":{"app_id":{"type":"string","description":"APP ID provided by MoEngage to identify a specific app. The app_id for your MoEngage account is available on the MoEngage Dashboard."}}},"Segment":{"type":"object","properties":{"credentials":{"$ref":"#/components/schemas/SegmentCredentials"},"enabled":{"type":"boolean","description":"Shows whether Segment integration is enabled or disabled for the sales channel"}}},"SegmentCredentials":{"type":"object","properties":{"write_key":{"type":"string","format":"base64","description":"The unique identifier for a source that tells Segment from which source data is coming from, to which workspace the data belongs, and which destinations should receive the data."}}},"Gtm":{"type":"object","properties":{"credentials":{"$ref":"#/components/schemas/GtmCredentials"},"enabled":{"type":"boolean","description":"Shows whether GTM integration is enabled or disabled for the sales channel"}}},"GtmCredentials":{"type":"object","properties":{"api_key":{"type":"string","format":"base64","description":"Secret credential API key for GTM"}}},"Freshchat":{"type":"object","properties":{"credentials":{"$ref":"#/components/schemas/FreshchatCredentials"},"enabled":{"type":"boolean","description":"Shows whether Freshchat integration is enabled or disabled for the sales channel"}}},"FreshchatCredentials":{"type":"object","properties":{"app_id":{"type":"string","format":"base64","description":"The unique app_id of your Freshchat account for integrating Freshchat with your sales channel"},"app_key":{"type":"string","format":"base64","description":"The unique app_key of your Freshchat account for integrating Freshchat with your sales channel"},"web_token":{"type":"string","format":"base64","description":"Web token used for accessing the Freshchat APIs"}}},"Safetynet":{"type":"object","properties":{"credentials":{"$ref":"#/components/schemas/SafetynetCredentials"},"enabled":{"type":"boolean","description":"Shows whether Safetynet integration is enabled or disabled for the sales channel"}}},"SafetynetCredentials":{"type":"object","properties":{"api_key":{"type":"string","format":"base64","description":"Secret credential API key for Safetynet. This API key is used for calling the methods of Safetynet APIs."}}},"FyndRewards":{"type":"object","properties":{"credentials":{"$ref":"#/components/schemas/FyndRewardsCredentials"}}},"FyndRewardsCredentials":{"type":"object","properties":{"public_key":{"type":"string","format":"base64","description":"Public key for integrating with Fynd rewards."},"private_key":{"type":"string","format":"base64","description":"Public key for integrating with Fynd rewards."}}},"GoogleMap":{"type":"object","properties":{"credentials":{"$ref":"#/components/schemas/GoogleMapCredentials"}}},"GoogleMapCredentials":{"type":"object","properties":{"api_key":{"type":"string","format":"base64","description":"Secret API key for Google Maps. A unique identifier that authenticates requests made to Google Maps API."}}},"RewardPointsConfig":{"type":"object","properties":{"credit":{"$ref":"#/components/schemas/Credit"},"debit":{"$ref":"#/components/schemas/Debit"}}},"Credit":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Shows whether reward points should be credited"}}},"Debit":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Shows whether reward points are available for debit"},"auto_apply":{"type":"boolean","description":"Allow automatic debit of reward points"},"strategy_channel":{"type":"string","description":"Strategy channel for debiting reward points"}}},"ProductDetailFeature":{"type":"object","properties":{"similar":{"type":"array","description":"Configuration to show similar products, other products from same seller, other products in same category, other products in same price range, etc.","items":{"type":"string","default":"basic","description":"Similar products detail. Default value is basic.","enum":["visual","basic","brand","category","seller","price","specs"]}},"seller_selection":{"type":"boolean","description":"Shows whether the customers can choose the seller on PDP","default":true},"update_product_meta":{"type":"boolean","description":"Allow user to update product meta. Default value is true.","default":true},"request_product":{"type":"boolean","description":"Indicates whether customers can request for a product. Default value is false.","default":false}}},"LaunchPage":{"type":"object","description":"Details of the page shown after successful login","properties":{"page_type":{"type":"string","description":"Type of the launch page"},"params":{"type":"object","format":"nullable","description":"Launch page params. It can be nullable."},"query":{"type":"object","format":"nullable","description":"Query related to launch page. It can be nullable."}}},"LandingPageFeature":{"type":"object","properties":{"launch_page":{"$ref":"#/components/schemas/LaunchPage"},"continue_as_guest":{"type":"boolean","description":"Shows whether a guest can checkout from cart without logging in"},"login_btn_text":{"type":"string","description":"Shows the text displayed over the login button"},"show_domain_textbox":{"type":"boolean","description":"Shows whether a textbox for entering domain is available"},"show_register_btn":{"type":"boolean","description":"Shows whether register button is available in the login/landing page"}}},"ListingPageFeature":{"type":"object","properties":{"sort_on":{"type":"string","default":"popular","enum":["latest","popular","relevance","discount_asc","discount_dsc","price_asc","price_dsc"]}}},"RegistrationPageFeature":{"type":"object","properties":{"ask_store_address":{"type":"boolean","description":"Shows whether a form to collect the address of the store, should be displayed upon visiting the website"}}},"AppFeature":{"type":"object","properties":{"product_detail":{"$ref":"#/components/schemas/ProductDetailFeature"},"landing_page":{"$ref":"#/components/schemas/LandingPageFeature"},"registration_page":{"$ref":"#/components/schemas/RegistrationPageFeature"},"home_page":{"$ref":"#/components/schemas/HomePageFeature"},"common":{"$ref":"#/components/schemas/CommonFeature"},"cart":{"$ref":"#/components/schemas/CartFeature"},"qr":{"$ref":"#/components/schemas/QrFeature"},"pcr":{"$ref":"#/components/schemas/PcrFeature"},"order":{"$ref":"#/components/schemas/OrderFeature"},"_id":{"type":"string","description":"The unique identifier (24-digit Mongo Object ID) for the sales channel features"},"app":{"type":"string","description":"Application ID of the sales channel"},"created_at":{"type":"string","description":"ISO 8601 timestamp showing the date when the features were configured"},"modified_at":{"type":"string","description":"ISO 8601 timestamp of last known modifications to the sales channel feature configuration"},"__v":{"type":"integer","format":"int32","description":"Version key for tracking revisions. Default value is zero"}}},"HomePageFeature":{"type":"object","properties":{"order_processing":{"type":"boolean","description":"Shows whether order processing is enabled or not enabled"}}},"CommonFeature":{"type":"object","properties":{"communication_optin_dialog":{"$ref":"#/components/schemas/CommunicationOptinDialogFeature"},"deployment_store_selection":{"$ref":"#/components/schemas/DeploymentStoreSelectionFeature"},"listing_price":{"$ref":"#/components/schemas/ListingPriceFeature"},"listing_page":{"$ref":"#/components/schemas/ListingPageFeature"},"currency":{"$ref":"#/components/schemas/CurrencyFeature"},"revenue_engine":{"$ref":"#/components/schemas/RevenueEngineFeature"},"feedback":{"$ref":"#/components/schemas/FeedbackFeature"},"compare_products":{"$ref":"#/components/schemas/CompareProductsFeature"},"reward_points":{"$ref":"#/components/schemas/RewardPointsConfig"},"international_shipping":{"$ref":"#/components/schemas/InternationalShipping"}}},"InternationalShipping":{"type":"object","properties":{"enabled":{"type":"boolean","description":"International shipping is enabled or not."}}},"CommunicationOptinDialogFeature":{"type":"object","properties":{"visibility":{"type":"boolean","description":"Shows whether WhatsApp communication is enabled"}}},"DeploymentStoreSelectionFeature":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Shows whether selection of store (for deploying the application) is permitted"},"type":{"type":"string","description":"Permitted values are 'hard' and 'soft'. For hard type delivery, store selection is compulsory. For soft type, delivery store selection is optional."}}},"ListingPriceFeature":{"type":"object","properties":{"value":{"type":"string","description":"Shows which price to display on PLP if one product has multiple prices (for each size), valid values are 'min', 'max', 'range'. Default value is range."},"sort":{"type":"string","description":"Sorting of listing price with min or max value. Default value is min."}}},"CurrencyFeature":{"type":"object","properties":{"value":{"type":"array","description":"3-letter currency code","items":{"type":"string","description":"list of different currency codes like 'INR', 'USD'."}},"type":{"type":"string","description":"If 'explicit', currency formatting shows currency code with price. For explicit or all currency selection."},"default_currency":{"type":"string","description":"3-letter code of the default currency used in the application. Default vaule is 'INR'."}}},"RevenueEngineFeature":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Enable revenue engine. Default value is false."}}},"FeedbackFeature":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Shows whether customer feedback is enabled on PDP. Default value is false."}}},"CompareProductsFeature":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Shows whether product comparison feature is enabled on PDP"}}},"CartFeature":{"type":"object","properties":{"gst_input":{"type":"boolean","description":"Shows whether customer is allowed to enter GST on the cart page for claiming input credits"},"staff_selection":{"type":"boolean","description":"Shows whether staff selection is enabled on cart page"},"placing_for_customer":{"type":"boolean","description":"Shows whether the staff is placing order on behalf of customer. Default value is true."},"google_map":{"type":"boolean","description":"Allow adding of Google Maps. Default value is true."},"revenue_engine_coupon":{"type":"boolean","description":"Allow coupon apply and credits, together. Default value is false."}}},"QrFeature":{"type":"object","properties":{"application":{"type":"boolean","description":"Shows whether sharing of mobile app via QR code is allowed. Default value is false."},"products":{"type":"boolean","description":"Shows whether sharing product via QR code is allowed. Default value is false."},"collections":{"type":"boolean","description":"Shows whether sharing collection via QR code is allowed. Default value is false."}}},"PcrFeature":{"type":"object","properties":{"staff_selection":{"type":"boolean","description":"Allow staff selection. Default value is false."}}},"OrderFeature":{"type":"object","properties":{"buy_again":{"type":"boolean","description":"Allow buy again option for order. Default value is false."}}},"AppFeatureRequest":{"type":"object","properties":{"feature":{"$ref":"#/components/schemas/AppFeature"}}},"AppFeatureResponse":{"type":"object","properties":{"feature":{"$ref":"#/components/schemas/AppFeature"}}},"Currency":{"type":"object","properties":{"currency_code":{"type":"string"},"currency_symbol":{"type":"string"}}},"TokenSchema":{"type":"object","properties":{"token":{"type":"string"},"created_by":{"type":"object","additionalProperties":true},"created_at":{"type":"string","description":"ISO 8601 timestamp of when token created"}}},"InvalidPayloadRequest":{"type":"object","properties":{"message":{"type":"string","description":"Error message when request body payload is improper"},"success":{"type":"boolean","description":"Flag for required not successfull."}}},"InventoryBrandRule":{"type":"object","properties":{"criteria":{"type":"string","description":"Whether all brands are enabled, or explicitly few brands in the inventory","enum":["all","explicit"]},"brands":{"type":"array","items":{"type":"integer","format":"int32","description":"Brand uids in case of explicit criteria"}}}},"StoreCriteriaRule":{"type":"object","properties":{"companies":{"type":"array","description":"List of company UID","items":{"type":"integer","format":"int32"}},"brands":{"type":"array","description":"List of brand UID","items":{"type":"integer","format":"int32"}}}},"InventoryStoreRule":{"type":"object","properties":{"criteria":{"type":"string","description":"Whether all stores are enabled, or explicitly few stores in the inventory, or use brands and company filter.","enum":["all","filter","explicit"]},"rules":{"type":"array","description":"List of rules with company and brands uids. Used when critera is `filter`.","items":{"$ref":"#/components/schemas/StoreCriteriaRule"}},"stores":{"type":"array","description":"List of store uids. Used when critera is `explicit`.","items":{"type":"integer","format":"int32"}}}},"InventoryPaymentConfig":{"type":"object","properties":{"mode_of_payment":{"type":"string","description":"Mode of payment for the inventory of sales channel. It is required and default value is null.","enum":["ECOMM"]},"source":{"type":"string","description":"Source of the payment mode for the inventory payment of sales channel. Default value is FYND.","enum":["ECOMM"]}}},"StorePriorityRule":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Shows store priority is enabled or not enabled for the article assignment."},"storetype_order":{"type":"array","items":{"type":"string","description":"List of store types for article assignment e.g. warehouse."}}}},"ArticleAssignmentRule":{"type":"object","properties":{"store_priority":{"$ref":"#/components/schemas/StorePriorityRule"}}},"InventoryArticleAssignment":{"type":"object","properties":{"post_order_reassignment":{"type":"boolean","description":"Allow post order reassigment of article"},"rules":{"$ref":"#/components/schemas/ArticleAssignmentRule"}}},"ApplicationInformation":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/InformationAddress"},"support":{"$ref":"#/components/schemas/InformationSupport"},"social_links":{"$ref":"#/components/schemas/SocialLinks"},"links":{"type":"array","items":{"$ref":"#/components/schemas/Links"}},"copyright_text":{"type":"string","description":"Copyright statement usually seen at the site's footer"},"_id":{"type":"string","description":"Unique identifier (24-digit Mongo Object ID) of the application information"},"business_highlights":{"type":"array","items":{"$ref":"#/components/schemas/BusinessHighlights"}},"application":{"type":"string","description":"Alphanumeric ID allotted to a sales channel application created within a business account"},"created_at":{"type":"string","description":"ISO 8601 timestamp of creation of the application information"},"modified_at":{"type":"string","description":"ISO 8601 timestamp of updation of the application information"},"__v":{"type":"integer","format":"int32","description":"Version key for tracking revisions. Default value is zero."}}},"InformationAddress":{"type":"object","properties":{"loc":{"$ref":"#/components/schemas/InformationLoc"},"address_line":{"type":"array","description":"Contact address of the sales channel","items":{"type":"string","description":"Detailed address info of the company"}},"phone":{"type":"array","items":{"$ref":"#/components/schemas/InformationPhone"}},"city":{"type":"string","description":"Name of the city, e.g. Mumbai"},"country":{"type":"string","description":"Name of the country, e.g. India"},"pincode":{"type":"integer","format":"int32","description":"6-digit PIN Code of the city, e.g. 400001"}}},"InformationPhone":{"type":"object","properties":{"code":{"type":"string","description":"Country code for contact number, e.g. +91 (for India)"},"number":{"type":"string","description":"10-digit mobile number"}}},"InformationLoc":{"type":"object","properties":{"type":{"type":"string","description":"Country code for contact number, e.g. +91 (for India)"},"coordinates":{"type":"array","items":{"type":"integer"},"description":"10-digit mobile number"}}},"InformationSupport":{"type":"object","properties":{"phone":{"type":"array","items":{"$ref":"#/components/schemas/InformationSupportPhone"}},"email":{"type":"array","items":{"$ref":"#/components/schemas/InformationSupportEmail"}},"timing":{"type":"string","description":"Working hours of support team, e.g. 9 AM to 9 PM"}}},"InformationSupportPhone":{"type":"object","properties":{"code":{"type":"string","description":"Country code for contact number, e.g. +91 (for India)"},"number":{"type":"string","description":"10-digit mobile number"},"key":{"type":"string"}}},"InformationSupportEmail":{"type":"object","properties":{"value":{"type":"string","description":"Value of email."},"key":{"type":"string"}}},"SocialLinks":{"type":"object","properties":{"facebook":{"$ref":"#/components/schemas/FacebookLink"},"instagram":{"$ref":"#/components/schemas/InstagramLink"},"twitter":{"$ref":"#/components/schemas/TwitterLink"},"pinterest":{"$ref":"#/components/schemas/PinterestLink"},"google_plus":{"$ref":"#/components/schemas/GooglePlusLink"},"youtube":{"$ref":"#/components/schemas/YoutubeLink"},"linked_in":{"$ref":"#/components/schemas/LinkedInLink"},"vimeo":{"$ref":"#/components/schemas/VimeoLink"},"blog_link":{"$ref":"#/components/schemas/BlogLink"}}},"FacebookLink":{"type":"object","properties":{"title":{"type":"string","description":"Name of the social media platform, e.g. Facebook"},"icon":{"type":"string","description":"Hosted URL of social icon image shown on the website"},"link":{"type":"string","description":"Web URL of brand's Facebook page"}}},"InstagramLink":{"type":"object","properties":{"title":{"type":"string","description":"Name of the social media platform, e.g. Instagram"},"icon":{"type":"string","description":"Hosted URL of social icon image shown on the website"},"link":{"type":"string","description":"Web URL of brand's Instagram page"}}},"TwitterLink":{"type":"object","properties":{"title":{"type":"string","description":"Name of the social media platform, e.g. Twitter"},"icon":{"type":"string","description":"Hosted URL of social icon image shown on the website"},"link":{"type":"string","description":"Web URL of brand's Twitter account"}}},"PinterestLink":{"type":"object","properties":{"title":{"type":"string","description":"Name of the social media platform, e.g. Pinterest"},"icon":{"type":"string","description":"Hosted URL of social icon image shown on the website"},"link":{"type":"string","description":"Web URL of brand's Pinterest page"}}},"GooglePlusLink":{"type":"object","properties":{"title":{"type":"string","description":"Name of the social media platform, e.g. Google+"},"icon":{"type":"string","description":"Hosted URL of social icon image shown on the website"},"link":{"type":"string","description":"Web URL of brand's Google+ account"}}},"YoutubeLink":{"type":"object","properties":{"title":{"type":"string","description":"Name of the social media platform, e.g. YouTube"},"icon":{"type":"string","description":"Hosted URL of social icon image shown on the website"},"link":{"type":"string","description":"Web URL of brand's YouTube channel"}}},"LinkedInLink":{"type":"object","properties":{"title":{"type":"string","description":"Name of the social media platform, e.g. LinkedIn"},"icon":{"type":"string","description":"Hosted URL of social icon image shown on the website"},"link":{"type":"string","description":"Web URL of brand's LinkedIn channel"}}},"VimeoLink":{"type":"object","properties":{"title":{"type":"string","description":"Name of the video hosting platform, e.g. Vimeo"},"icon":{"type":"string","description":"Hosted URL of social icon image shown on the website"},"link":{"type":"string","description":"Web URL of brand's Vimeo channel"}}},"BlogLink":{"type":"object","properties":{"title":{"type":"string","description":"Name of the brand's blog page"},"icon":{"type":"string","description":"Hosted URL of icon image shown on the website"},"link":{"type":"string","description":"Web URL of brand's blog page"}}},"Links":{"type":"object","properties":{"title":{"type":"string","description":"Name of the related page or link"},"link":{"type":"string","description":"Web URL for redirecting to a related page"}}},"BusinessHighlights":{"type":"object","properties":{"_id":{"type":"string","description":"Unique identifier (24-digit Mongo Object ID) of the related business"},"title":{"type":"string","description":"Title of the business highlight, e.g. Superfast Delivery"},"icon":{"type":"string","description":"Hosted URL of icon image representing the business highlight"},"sub_title":{"type":"string","description":"Detailed information about the highlight"}}},"ApplicationDetail":{"type":"object","additionalProperties":true,"properties":{"name":{"type":"string","description":"Name of the sales channel. It is required."},"description":{"type":"string","description":"It gives a detailed information about the sales channel. It is required."},"logo":{"$ref":"#/components/schemas/SecureUrl"},"mobile_logo":{"$ref":"#/components/schemas/SecureUrl"},"favicon":{"$ref":"#/components/schemas/SecureUrl"},"banner":{"$ref":"#/components/schemas/SecureUrl"},"domain":{"$ref":"#/components/schemas/Domain"},"domains":{"type":"array","items":{"$ref":"#/components/schemas/Domain"}},"_id":{"type":"string","description":"The unique identifier (24-digit Mongo Object ID) for the sales channel details"},"slug":{"type":"string"},"company_id":{"type":"integer"}},"required":["name"]},"CurrenciesResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Currency"}}}},"AppCurrencyResponse":{"type":"object","properties":{"_id":{"type":"string","description":"The unique identifier (24-digit Mongo Object ID) of the currency configuration supported by the application"},"application":{"type":"string","description":"Alphanumeric ID allotted to an application (sales channel website) created within a business account"},"default_currency":{"$ref":"#/components/schemas/DefaultCurrency"},"supported_currency":{"type":"array","items":{"$ref":"#/components/schemas/Currency"}},"created_at":{"type":"string","description":"ISO 8601 timestamp when currency was added in the list of currencies supported by the sales channel"},"modified_at":{"type":"string","description":"ISO 8601 timestamp when currency was updated in the list of currencies supported by the sales channel"}}},"StoreLatLong":{"type":"object","properties":{"type":{"type":"string","description":"Coordinates type of the opted store"},"coordinates":{"type":"array","items":{"type":"number","description":"Latitude and Longitude coordinates of the opted store"}}}},"OptedStoreAddress":{"type":"object","properties":{"state":{"type":"string","description":"State of the opted store, e.g. Maharashtra"},"address1":{"type":"string","description":"Address of the opted store"},"lat_long":{"$ref":"#/components/schemas/StoreLatLong"},"address2":{"type":"string","description":"Address of the opted store"},"pincode":{"type":"integer","format":"int32","description":"6-digit PIN code of the opted store location"},"country":{"type":"string","description":"Country of the opted store, e.g. India"},"city":{"type":"string","description":"City of the opted store, e.g. Mumbai"},"sector":{"type":"string","description":"Sector for the opted store."},"country_code":{"type":"string","description":"Country code of the selected country"},"state_code":{"type":"string","description":"Selected state code"}}},"OrderingStore":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/OptedStoreAddress"},"_id":{"type":"string","description":"The unique identifier (24-digit Mongo Object ID) of the ordering store"},"uid":{"type":"integer","format":"int32","description":"Ordering store UID"},"name":{"type":"string","description":"Store name of the ordering store"},"display_name":{"type":"string","description":"Display name of the ordering store"},"store_type":{"type":"string","description":"Store type of the ordering store, e.g. high_street, mall, warehouse"},"store_code":{"type":"string","description":"Store code of the ordering store, e.g. MUM-102"},"pincode":{"type":"integer","format":"int32","description":"6-digit PIN Code  of the ordering store, e.g. 400001"},"code":{"type":"string","description":"Code of the ordering store (usually same as Store Code)"}}},"OrderingStores":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/Page"},"items":{"type":"array","items":{"$ref":"#/components/schemas/OrderingStore"}},"deployed_stores":{"type":"array","items":{"type":"integer","format":"int32","description":"List of all deployed stores"}},"all_stores":{"type":"boolean","description":"Allow all stores of the ordering stores"},"enabled":{"type":"boolean","description":"Allow ordering stores for current sales channel"},"type":{"type":"string","description":"For hard type delivery, store selection is compulsory. For soft type, delivery store selection is optional.","enum":["soft","hard"]},"_id":{"type":"string","description":"The unique identifier (24-digit Mongo Object ID) of the ordering store"},"app":{"type":"string","description":"Alphanumeric ID allotted to an application (sales channel website) created within a business account"},"__v":{"type":"integer","format":"int32","description":"Version key for tracking ordering stores. Default value is zero."}},"required":[]},"OrderingStoresResponse":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/Page"},"items":{"type":"array","items":{"$ref":"#/components/schemas/OrderingStore"}}},"required":[]},"GenerationEntityType":{"type":"string","enum":[{"name":"title","value":"title","description":"Denotes title will be generated"},{"name":"description","value":"description","description":"Denotes description will be generated"}]},"GenerateSEOContent":{"properties":{"text":{"type":"string"},"existing_text":{"type":"string"},"keywords":{"type":"array","items":{"type":"string"}},"type":{"type":"string"}}},"GeneratedSEOContent":{"properties":{"title":{"type":"string"},"description":{"type":"string"}}},"ApplicationLegal":{"properties":{"application":{"type":"string"},"tnc":{"type":"string"},"policy":{"type":"string"},"shipping":{"type":"string"},"returns":{"type":"string"},"faq":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationLegalFAQ"}},"_id":{"type":"string"},"updated_at":{"type":"string","format":"date-time"},"created_at":{"type":"string","format":"date-time"}}},"ApplicationLegalFAQ":{"type":"object","properties":{"question":{"type":"string"},"answer":{"type":"string"}}},"PathMappingSchema":{"properties":{"application":{"type":"string"},"_id":{"type":"string"},"redirect_from":{"type":"string"},"redirect_to":{"type":"string"},"updated_at":{"type":"string","format":"date-time"},"created_at":{"type":"string","format":"date-time"},"__source":{"$ref":"#/components/schemas/PathSourceSchema"}}},"PathSourceSchema":{"type":"object","properties":{"type":{"type":"string"},"id":{"type":"string"}}},"SeoComponent":{"properties":{"seo":{"$ref":"#/components/schemas/SeoSchema"}}},"SeoSchema":{"properties":{"app":{"type":"string"},"_id":{"type":"string"},"robots_txt":{"type":"string"},"sitemap_enabled":{"type":"boolean"},"additional_sitemap":{"type":"string"},"cannonical_enabled":{"type":"boolean","default":false},"custom_meta_tags":{"type":"array","items":{"$ref":"#/components/schemas/CustomMetaTag"}},"details":{"$ref":"#/components/schemas/Detail"},"created_at":{"type":"string"},"updated_at":{"type":"string"}}},"CustomMetaTag":{"type":"object","properties":{"name":{"type":"string"},"content":{"type":"string"},"_id":{"type":"string"}}},"Detail":{"type":"object","properties":{"title":{"type":"string"},"description":{"type":"string"},"image_url":{"type":"string"}}},"SeoSchemaComponent":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/SEOSchemaMarkupTemplate"}},"page":{"$ref":"#/components/schemas/Page"}}},"SEOSchemaMarkupTemplate":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"page_type":{"type":"string"},"schema":{"type":"string"},"description":{"type":"string"},"active":{"type":"boolean"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"application":{"type":"string"},"target_json":{"type":"object","additionalProperties":true}}},"SEOSchemaMarkupTemplateRequestBody":{"type":"object","properties":{"title":{"type":"string"},"page_type":{"type":"string"},"schema":{"type":"string","format":"byte"},"description":{"type":"string"},"target_json":{"type":"object","additionalProperties":true},"active":{"type":"boolean"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}},"AnnouncementPageSchema":{"type":"object","properties":{"page_slug":{"type":"string"},"type":{"type":"string","enum":["system","custom"]}}},"EditorMeta":{"type":"object","properties":{"foreground_color":{"type":"string"},"background_color":{"type":"string"},"content_type":{"type":"string","enum":["markdown","raw_html"]},"content":{"type":"string"}}},"AnnouncementAuthorSchema":{"type":"object","properties":{"created_by":{"type":"string"},"modified_by":{"type":"string"}}},"AdminAnnouncementSchema":{"type":"object","properties":{"_id":{"type":"string"},"platforms":{"type":"array","items":{"type":"string"}},"title":{"type":"string"},"announcement":{"type":"string"},"pages":{"type":"array","items":{"$ref":"#/components/schemas/AnnouncementPageSchema"}},"editor_meta":{"$ref":"#/components/schemas/EditorMeta"},"author":{"$ref":"#/components/schemas/AnnouncementAuthorSchema"},"created_at":{"type":"string"},"app":{"type":"string"},"modified_at":{"type":"string"},"_schedule":{"$ref":"#/components/schemas/ScheduleSchema"}}},"DefaultSchemaComponent":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/DefaultSEOSchemaMarkupTemplate"}}}},"DefaultSEOSchemaMarkupTemplate":{"type":"object","properties":{"page_type":{"type":"string"},"schema":{"type":"string"},"target_json":{"type":"object","additionalProperties":true}}},"ScheduleSchema":{"type":"object","properties":{"cron":{"type":"string"},"start":{"type":"string"},"end":{"type":"string"},"duration":{"type":"number"},"next_schedule":{"type":"array","items":{"$ref":"#/components/schemas/NextSchedule"}}}},"BlogGetResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/BlogSchema"}},"page":{"$ref":"#/components/schemas/Page"}},"required":[]},"ResourceContent":{"type":"object","properties":{"type":{"type":"string"},"value":{"type":"string"}}},"Asset":{"type":"object","properties":{"aspect_ratio":{"type":"string"},"id":{"type":"string"},"secure_url":{"type":"string"}}},"Author":{"type":"object","properties":{"designation":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"}}},"BlogSchema":{"type":"object","properties":{"_id":{"type":"string"},"_custom_json":{"type":"object"},"application":{"type":"string"},"archived":{"type":"boolean"},"author":{"$ref":"#/components/schemas/Author"},"content":{"type":"array","items":{"$ref":"#/components/schemas/ResourceContent"}},"feature_image":{"$ref":"#/components/schemas/Asset"},"published":{"type":"boolean"},"reading_time":{"type":"string"},"slug":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"seo":{"$ref":"#/components/schemas/SEO"},"_schedule":{"$ref":"#/components/schemas/CronSchedule"},"title":{"type":"string"},"date_meta":{"$ref":"#/components/schemas/DateMeta"}}},"SEO":{"type":"object","properties":{"description":{"type":"string"},"image":{"$ref":"#/components/schemas/SEOImage"},"title":{"type":"string"},"meta_tags":{"type":"array","items":{"$ref":"#/components/schemas/SEOMetaItem"}},"sitemap":{"$ref":"#/components/schemas/SEOSitemap"},"breadcrumb":{"type":"array","items":{"$ref":"#/components/schemas/SEObreadcrumb"}},"canonical_url":{"type":"string"}}},"SEOImage":{"type":"object","properties":{"url":{"type":"string"}}},"SEOMetaItem":{"type":"object","properties":{"title":{"type":"string"},"items":{"type":"array","items":{"$ref":"#/components/schemas/SEOMetaItems"}}}},"SEOMetaItems":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}},"SEOSitemap":{"type":"object","properties":{"priority":{"type":"number"},"frequency":{"type":"string"}}},"SEObreadcrumb":{"type":"object","properties":{"url":{"type":"string"},"action":{"$ref":"#/components/schemas/Action"}}},"BlogRequest":{"type":"object","properties":{"application":{"type":"string"},"_custom_json":{"type":"object"},"author":{"$ref":"#/components/schemas/Author"},"content":{"type":"array","items":{"$ref":"#/components/schemas/ResourceContent"}},"feature_image":{"$ref":"#/components/schemas/Asset"},"published":{"type":"boolean"},"reading_time":{"type":"string"},"slug":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"title":{"type":"string"},"seo":{"$ref":"#/components/schemas/SEO"},"_schedule":{"$ref":"#/components/schemas/CronSchedule"}}},"GetAnnouncementListSchema":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/AdminAnnouncementSchema"}},"page":{"$ref":"#/components/schemas/Page"}},"required":[]},"CreateAnnouncementSchema":{"type":"object","properties":{"message":{"type":"string"},"data":{"$ref":"#/components/schemas/AdminAnnouncementSchema"}}},"DataLoaderResponseSchema":{"type":"object","properties":{"application":{"type":"string"},"company":{"type":"string"},"_id":{"type":"string"},"name":{"type":"string"},"service":{"type":"string"},"operation_id":{"type":"string"},"type":{"type":"string","enum":["url","function"]},"url":{"type":"string"},"content":{"type":"string"},"__source":{"$ref":"#/components/schemas/DataLoaderSourceSchema"}}},"DataLoaderResetResponseSchema":{"type":"object","properties":{"reset":{"type":"boolean"}}},"LocaleLanguage":{"type":"object","properties":{"hi":{"$ref":"#/components/schemas/Language"},"ar":{"$ref":"#/components/schemas/Language"},"en_us":{"$ref":"#/components/schemas/Language"}}},"Language":{"type":"object","properties":{"display":{"type":"string"}}},"NavigationReference":{"type":"object","properties":{"acl":{"type":"array","items":{"type":"string"}},"tags":{"type":"array","items":{"type":"string"}},"_locale_language":{"$ref":"#/components/schemas/LocaleLanguage"},"image":{"type":"string"},"type":{"type":"string"},"action":{"$ref":"#/components/schemas/Action"},"active":{"type":"boolean"},"display":{"type":"string"},"sort_order":{"type":"integer"},"sub_navigation":{"type":"array","items":{"$ref":"#/components/schemas/NavigationReference"}}}},"ConfigurationSchema":{"type":"object","properties":{"sleep_time":{"type":"integer"},"start_on_launch":{"type":"boolean"},"duration":{"type":"integer"},"slide_direction":{"type":"string"}}},"SlideshowMedia":{"type":"object","properties":{"type":{"type":"string"},"url":{"type":"string"},"bg_color":{"type":"string"},"duration":{"type":"integer"},"auto_decide_duration":{"type":"boolean"},"action":{"$ref":"#/components/schemas/Action"}}},"UpdateHandpickedSchema":{"type":"object","properties":{"tag":{"$ref":"#/components/schemas/HandpickedTagSchema"}}},"HandpickedTagSchema":{"type":"object","properties":{"position":{"type":"string"},"attributes":{"type":"object"},"name":{"type":"string"},"url":{"type":"string"},"type":{"type":"string"},"sub_type":{"type":"string"},"content":{"type":"string"}}},"RemoveHandpickedSchema":{"type":"object","properties":{"tags":{"type":"array","items":{"type":"string"}}}},"CreateTagSchema":{"type":"object","properties":{"name":{"type":"string"},"sub_type":{"type":"string","enum":["external","inline"]},"_id":{"type":"string"},"type":{"type":"string","enum":["js","css"]},"url":{"type":"string"},"position":{"type":"string","enum":["head","body-top","body-bottom"]},"attributes":{"type":"object"},"pages":{"type":"array","items":{"type":"object"}},"content":{"type":"string"}}},"CreateTagRequestSchema":{"type":"object","properties":{"tags":{"type":"array","items":{"$ref":"#/components/schemas/CreateTagSchema"}}}},"DataLoaderSchema":{"type":"object","properties":{"name":{"type":"string"},"service":{"type":"string"},"operation_id":{"type":"string"},"type":{"type":"string","enum":["url","function"]},"url":{"type":"string"},"content":{"type":"string"},"__source":{"$ref":"#/components/schemas/DataLoaderSourceSchema"},"_id":{"type":"string"}}},"DataLoaderSourceSchema":{"type":"object","properties":{"type":{"type":"string"},"id":{"type":"string"}}},"DataLoadersSchema":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/DataLoaderSchema"}}}},"TagDeleteSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean"}}},"ContentAPIError":{"type":"object","properties":{"message":{"type":"string"},"status":{"type":"number"},"code":{"type":"string"},"exception":{"type":"string"},"info":{"type":"string"},"request_id":{"type":"string"},"stack_trace":{"type":"string"},"meta":{"type":"object"}}},"CommonError":{"type":"object","properties":{"status_code":{"type":"string"},"error":{},"success":{"type":"string"}}},"CategorySchema":{"type":"object","properties":{"index":{"type":"integer"},"title":{"type":"string"},"description":{"type":"string"},"children":{"type":"array","items":{"type":"string"}},"_id":{"type":"string"},"slug":{"type":"string"},"application":{"type":"string"},"icon_url":{"type":"string"},"_custom_json":{"type":"object"}}},"ChildrenSchema":{"type":"object","properties":{"question":{"type":"string"},"answer":{"type":"string"},"slug":{"type":"string"},"application":{"type":"string"},"_id":{"type":"string"}}},"CategoryRequestSchema":{"type":"object","properties":{"slug":{"type":"string"},"title":{"type":"string"}}},"FAQCategorySchema":{"type":"object","properties":{"index":{"type":"integer"},"title":{"type":"string"},"description":{"type":"string"},"children":{"type":"array","items":{"$ref":"#/components/schemas/ChildrenSchema"}},"_id":{"type":"string"},"slug":{"type":"string"},"application":{"type":"string"},"icon_url":{"type":"string"},"_custom_json":{"type":"object"}}},"FaqSchema":{"type":"object","properties":{"slug":{"type":"string"},"application":{"type":"string"},"_id":{"type":"string"},"question":{"type":"string"},"answer":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}}}},"FAQ":{"type":"object","properties":{"slug":{"type":"string"},"question":{"type":"string"},"answer":{"type":"string"}}},"CreateFaqResponseSchema":{"type":"object","properties":{"faq":{"$ref":"#/components/schemas/FaqSchema"}}},"CreateFaqSchema":{"type":"object","properties":{"faq":{"$ref":"#/components/schemas/FAQ"}}},"GetFaqSchema":{"type":"object","properties":{"faqs":{"type":"array","items":{"$ref":"#/components/schemas/FaqSchema"}}}},"UpdateFaqCategoryRequestSchema":{"type":"object","properties":{"category":{"$ref":"#/components/schemas/CategorySchema"}}},"CreateFaqCategoryRequestSchema":{"type":"object","properties":{"category":{"$ref":"#/components/schemas/CategoryRequestSchema"}}},"CreateFaqCategorySchema":{"type":"object","properties":{"category":{"$ref":"#/components/schemas/CategorySchema"}}},"GetFaqCategoriesSchema":{"type":"object","properties":{"categories":{"type":"array","items":{"$ref":"#/components/schemas/CategorySchema"}}}},"GetFaqCategoryBySlugSchema":{"type":"object","properties":{"category":{"$ref":"#/components/schemas/FAQCategorySchema"}}},"LandingPageGetResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/LandingPageSchema"}},"page":{"$ref":"#/components/schemas/Page"}},"required":[]},"LandingPageSchema":{"type":"object","properties":{"slug":{"type":"string"},"action":{"$ref":"#/components/schemas/Action"},"platform":{"type":"array","items":{"type":"string"}},"created_by":{"$ref":"#/components/schemas/CreatedBySchema"},"date_meta":{"$ref":"#/components/schemas/DateMeta"},"_id":{"type":"string"},"application":{"type":"string"},"archived":{"type":"boolean"},"_custom_json":{"type":"object"}}},"DefaultNavigationResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/NavigationSchema"}}}},"NavigationGetResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/NavigationSchema"}},"page":{"$ref":"#/components/schemas/Page"}},"required":[]},"Orientation":{"type":"object","properties":{"portrait":{"type":"array","items":{"type":"string"}},"landscape":{"type":"array","items":{"type":"string"}}}},"NavigationSchema":{"type":"object","properties":{"_id":{"type":"string"},"application":{"type":"string"},"archived":{"type":"boolean"},"name":{"type":"string"},"slug":{"type":"string"},"platform":{"type":"array","items":{"type":"string"}},"created_by":{"$ref":"#/components/schemas/CreatedBySchema"},"date_meta":{"$ref":"#/components/schemas/DateMeta"},"orientation":{"$ref":"#/components/schemas/Orientation"},"version":{"type":"number"},"navigation":{"type":"array","items":{"$ref":"#/components/schemas/NavigationReference"}}}},"NavigationRequest":{"type":"object","properties":{"name":{"type":"string"},"slug":{"type":"string"},"platform":{"type":"array","items":{"type":"string"}},"orientation":{"$ref":"#/components/schemas/Orientation"},"navigation":{"type":"array","items":{"$ref":"#/components/schemas/NavigationReference"}}}},"PageGetResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PageSchema"}},"page":{"$ref":"#/components/schemas/Page"}},"required":[]},"PageSpec":{"type":"object","properties":{"specifications":{"type":"array","items":{"$ref":"#/components/schemas/PageSpecItem"}}}},"PageSpecParam":{"type":"object","properties":{"key":{"type":"string"},"required":{"type":"boolean"}}},"PageSpecItem":{"type":"object","properties":{"page_type":{"type":"string"},"display_name":{"type":"string"},"params":{"type":"array","items":{"$ref":"#/components/schemas/PageSpecParam"}},"query":{"type":"array","items":{"$ref":"#/components/schemas/PageSpecParam"}}}},"PageSchema":{"type":"object","properties":{"has_next":{"type":"boolean"},"item_total":{"type":"integer"},"size":{"type":"integer"},"current":{"type":"integer"},"type":{"type":"string"}},"required":["current","has_next","item_total","size","type"]},"CreatedBySchema":{"type":"object","properties":{"id":{"type":"string"}}},"PageRequest":{"type":"object","properties":{"_schedule":{"$ref":"#/components/schemas/CronSchedule"},"application":{"type":"string"},"author":{"$ref":"#/components/schemas/Author"},"_custom_json":{"type":"object"},"orientation":{"type":"string"},"content":{"type":"array","items":{"type":"object"}},"feature_image":{"$ref":"#/components/schemas/Asset"},"published":{"type":"boolean"},"reading_time":{"type":"string"},"slug":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"seo":{"$ref":"#/components/schemas/SEO"},"title":{"type":"string"}}},"CronSchedule":{"type":"object","properties":{"cron":{"type":"string"},"start":{"type":"string"},"end":{"type":"string"},"duration":{"type":"number"}}},"PagePublishRequest":{"type":"object","properties":{"publish":{"type":"boolean"}}},"PageMetaSchema":{"type":"object","properties":{"system_pages":{"type":"array","items":{"$ref":"#/components/schemas/NavigationSchema"}},"custom_pages":{"type":"array","items":{"$ref":"#/components/schemas/PageSchema"}},"application_id":{"type":"string"}}},"SlideshowGetResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/SlideshowSchema"}},"page":{"$ref":"#/components/schemas/Page"}},"required":[]},"SlideshowSchema":{"type":"object","properties":{"_id":{"type":"string"},"slug":{"type":"string"},"date_meta":{"$ref":"#/components/schemas/DateMeta"},"application":{"type":"string"},"platform":{"type":"string"},"configuration":{"$ref":"#/components/schemas/ConfigurationSchema"},"media":{"type":"array","items":{"$ref":"#/components/schemas/SlideshowMedia"}},"active":{"type":"boolean"},"archived":{"type":"boolean"},"_custom_json":{"type":"object"}}},"SlideshowRequest":{"type":"object","properties":{"slug":{"type":"string"},"platform":{"type":"string"},"configuration":{"$ref":"#/components/schemas/ConfigurationSchema"},"media":{"$ref":"#/components/schemas/SlideshowMedia"},"active":{"type":"boolean"}}},"Support":{"type":"object","properties":{"created":{"type":"boolean"},"_id":{"type":"string"},"config_type":{"type":"string"},"application":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"contact":{"$ref":"#/components/schemas/ContactSchema"}}},"PhoneProperties":{"type":"object","properties":{"key":{"type":"string"},"code":{"type":"string"},"number":{"type":"string"}}},"PhoneSchema":{"type":"object","properties":{"active":{"type":"boolean"},"phone":{"type":"array","items":{"$ref":"#/components/schemas/PhoneProperties"}}}},"EmailProperties":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}},"EmailSchema":{"type":"object","properties":{"active":{"type":"boolean"},"email":{"type":"array","items":{"$ref":"#/components/schemas/EmailProperties"}}}},"ContactSchema":{"type":"object","properties":{"phone":{"$ref":"#/components/schemas/PhoneSchema"},"email":{"$ref":"#/components/schemas/EmailSchema"}}},"TagsSchema":{"type":"object","properties":{"application":{"type":"string"},"_id":{"type":"string"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/TagSchema"}}}},"TagSchema":{"type":"object","properties":{"name":{"type":"string"},"url":{"type":"string"},"type":{"type":"string","enum":["js","css"]},"sub_type":{"type":"string","enum":["external","inline"]},"_id":{"type":"string"},"position":{"type":"string","enum":["head","body-top","body-bottom"]},"attributes":{"type":"object"},"content":{"type":"string"},"pages":{"type":"array","items":{"type":"object"}},"__source":{"$ref":"#/components/schemas/TagSourceSchema"}}},"TagSourceSchema":{"type":"object","properties":{"type":{"type":"string"},"id":{"type":"string"}}},"ResourcesSchema":{"description":"Custom fields Resources","type":"object","properties":{"resources":{"type":"array","items":{"$ref":"#/components/schemas/ResourceSchema"}}}},"ResourceSchema":{"type":"object","properties":{"name":{"type":"string","description":"Resource name"},"key":{"type":"string","description":"Resource key"},"definitions_count":{"type":"number","description":"Number of definitions"}}},"FieldValidations":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"integer"},{"type":"boolean"},{"type":"object"}]}}},"FieldDefinitionSchema":{"type":"object","properties":{"_id":{"type":"string"},"creator":{"type":"string"},"resource":{"type":"string"},"name":{"type":"string"},"namespace":{"type":"string"},"key":{"type":"string"},"description":{"type":"string"},"type":{"type":"string"},"multi_value":{"type":"boolean"},"validations":{"type":"array","items":{"$ref":"#/components/schemas/FieldValidations"}},"company_id":{"type":"string","format":"integer"},"created_by":{"type":"string"},"updated_by":{"type":"string"},"required":{"type":"boolean"},"is_deleted":{"type":"boolean"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"type_name":{"type":"string"},"invalid_fields_count":{"type":"integer"}}},"CustomFieldDefinitionsSchema":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/FieldDefinitionSchema"}},"page":{"$ref":"#/components/schemas/Page"}}},"CustomFieldDefinitionRequestSchema":{"type":"object","properties":{"resource":{"type":"string"},"type":{"type":"string"},"key":{"type":"string"},"namespace":{"type":"string"},"multi_value":{"type":"boolean"},"name":{"type":"string"},"description":{"type":"string"},"validations":{"type":"array","items":{"$ref":"#/components/schemas/FieldValidations"}}}},"CustomObjectCustomFieldDefinitions":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"description":{"type":"string"},"name":{"type":"string"},"multi_value":{"type":"boolean"},"required":{"type":"boolean"},"key":{"type":"string"},"validations":{"type":"array","items":{"$ref":"#/components/schemas/FieldValidations"}},"action":{"type":"string"}}},"CustomObjectDefinitionUpdateRequestSchema":{"type":"object","properties":{"type":{"type":"string"},"description":{"type":"string"},"name":{"type":"string"},"display_name_key":{"type":"string"},"field_definitions":{"type":"array","items":{"$ref":"#/components/schemas/CustomObjectCustomFieldDefinitions"}}}},"CustomFieldDefinitionDetailResSchema":{"type":"object","properties":{"creator":{"type":"string"},"resource":{"type":"string"},"name":{"type":"string"},"namespace":{"type":"string"},"key":{"type":"string"},"description":{"type":"string"},"type":{"type":"string"},"multi_value":{"type":"boolean"},"company_id":{"type":"string","format":"integer"},"application_id":{"type":"string"},"created_by":{"type":"string"},"updated_by":{"type":"string"},"required":{"type":"boolean"},"is_deleted":{"type":"boolean"},"_id":{"type":"string"},"validations":{"type":"array","items":{}},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}},"CustomDataDeleteSchema":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}},"CustomFieldValue":{"type":"object","properties":{"value":{"anyOf":[{"type":"integer"},{"type":"string"}]}}},"CustomFieldSchema":{"type":"object","properties":{"_id":{"type":"string"},"namespace":{"type":"string"},"key":{"type":"string"},"resource":{"type":"string"},"creator":{"type":"string"},"value":{"type":"array","items":{"$ref":"#/components/schemas/CustomFieldValue"}},"resource_id":{"type":"string"},"type":{"type":"string"},"multi_value":{"type":"boolean"},"company_id":{"type":"string","format":"integer"},"definition_id":{"type":"string"},"has_invalid_values":{"type":"boolean"},"invalid_value_errors":{"type":"array","items":{}},"created_by":{"type":"string"},"is_deleted":{"type":"boolean"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}},"CustomFieldsResponseSchema":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/CustomFieldSchema"}},"page":{"$ref":"#/components/schemas/Page"}}},"CustomFieldsResponseByResourceIdSchema":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/CustomFieldSchema"}}}},"CustomField":{"type":"object","properties":{"value":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"integer"},{"type":"boolean"},{"type":"object"}]}},"definition_id":{"type":"string"}}},"CustomFieldRequestSchema":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/CustomField"}}}},"CustomObjectSchema":{"type":"object","properties":{"_id":{"type":"string"},"creator":{"type":"string"},"company_id":{"type":"string","format":"integer"},"application_id":{"type":"string"},"created_by":{"type":"string"},"updated_by":{"type":"string"},"status":{"type":"string"},"type":{"type":"string"},"display_name":{"type":"string"},"definition_id":{"type":"string"},"fields":{"type":"array","items":{"$ref":"#/components/schemas/CustomFieldSchema"}}}},"CustomObjectDefinitionRequestSchema":{"type":"object","properties":{"type":{"type":"string"},"description":{"type":"string"},"name":{"type":"string"},"display_name_key":{"type":"string"},"field_definitions":{"type":"array","items":{"$ref":"#/components/schemas/CustomObjectCustomFieldDefinitions"}}}},"CustomObjectCustomFieldDefinitionResSchema":{"type":"object","properties":{"creator":{"type":"string"},"resource":{"type":"string"},"name":{"type":"string"},"namespace":{"type":"string"},"key":{"type":"string"},"description":{"type":"string"},"type":{"type":"string"},"multi_value":{"type":"boolean"},"validations":{"type":"array","items":{"$ref":"#/components/schemas/FieldValidations"}},"company_id":{"type":"string"},"created_by":{"type":"string"},"metaobject_definition_id":{"type":"string"},"required":{"type":"boolean"},"is_deleted":{"type":"boolean"},"_id":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}},"CustomObjectDefinitionSchema":{"type":"object","properties":{"_id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"display_name_key":{"type":"string"},"description":{"type":"string"},"creator":{"type":"string"},"created_by":{"type":"string"},"updated_by":{"type":"string"},"field_definitions":{"type":"array","items":{"$ref":"#/components/schemas/CustomObjectCustomFieldDefinitionResSchema"}}}},"CustomObjectDefinitionDeleteResponseSchema":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}},"CustomObjectEntryBulkUploadResponse":{"type":"object","properties":{"url":{"type":"string"},"total_records":{"type":"integer"}}},"CustomObjectListItemDefinationSchema":{"type":"object","properties":{"_id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"}}},"CustomObjectListItemSchema":{"type":"object","properties":{"_id":{"type":"string"},"definition_id":{"type":"string"},"status":{"type":"string"},"updated_at":{"type":"string","format":"date-time"},"display_name":{"type":"string"},"definition":{"$ref":"#/components/schemas/CustomObjectListItemDefinationSchema"},"references":{"type":"integer"}}},"CustomObjectsSchema":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/CustomObjectListItemSchema"}},"page":{"$ref":"#/components/schemas/Page"}}},"CustomObjectFieldSchema":{"type":"object","properties":{"_id":{"type":"string"},"key":{"type":"string"},"value":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"integer"},{"type":"boolean"},{"type":"object"}]}},"type":{"type":"string"},"definition_id":{"type":"string"}}},"CustomObjectByIdSchema":{"type":"object","properties":{"_id":{"type":"string"},"status":{"type":"string"},"display_name":{"type":"string"},"definition":{"$ref":"#/components/schemas/CustomObjectListItemDefinationSchema"},"references":{"type":"array","items":{}},"fields":{"type":"array","items":{"$ref":"#/components/schemas/CustomObjectFieldSchema"}}}},"CustomObjectBulkEntryInitiateDownload":{"type":"object","properties":{"message":{"type":"string"},"task_id":{"type":"string"}}},"CustomObjectMetaSchema":{"type":"object","properties":{"mo_total_count":{"type":"integer"},"mo_success_count":{"type":"integer"},"mo_error_count":{"type":"integer"},"mo_defintion_type":{"type":"string"}}},"CustomObjectJobSchema":{"type":"object","properties":{"_id":{"type":"string"},"jobs":{"type":"array","items":{"type":"string"}},"finished_jobs":{"type":"array","items":{"type":"string"}},"error_jobs":{"type":"array","items":{"type":"string"}},"errors_occured":{"type":"array","items":{"type":"string"}},"company_id":{"type":"string"},"creator":{"type":"string"},"url":{"type":"string"},"status":{"type":"string"},"action_type":{"type":"string"},"entity":{"type":"string"},"error_url":{"type":"string"},"finished_count":{"type":"integer"},"error_count":{"type":"integer"},"success_count":{"type":"integer"},"total_jobs":{"type":"integer"},"meta":{"$ref":"#/components/schemas/CustomObjectMetaSchema"},"created_by":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}}},"CustomObjectBulkEntry":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/CustomObjectJobSchema"}},"page":{"$ref":"#/components/schemas/Page"}}},"CustomFieldTypeSchema":{"type":"object","properties":{"string_single_line":{"$ref":"#/components/schemas/StringSingleLine"},"string_multi_line":{"$ref":"#/components/schemas/StringMultiLine"},"dropdown":{"$ref":"#/components/schemas/Dropdown"},"integer":{"$ref":"#/components/schemas/Integer"},"float_type":{"$ref":"#/components/schemas/FloatType"},"boolean_type":{"$ref":"#/components/schemas/BooleanType"},"date":{"$ref":"#/components/schemas/Date"},"datetime":{"$ref":"#/components/schemas/Datetime"},"json":{"$ref":"#/components/schemas/Json"},"file":{"$ref":"#/components/schemas/File"},"url":{"$ref":"#/components/schemas/Url"},"metaobject":{"$ref":"#/components/schemas/Metaobject"},"product":{"$ref":"#/components/schemas/Product"}}},"SupportedValidationsMetaExampleSchema":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}},"SupportedValidationsMetaSchema":{"type":"object","properties":{"examples":{"type":"array","items":{"$ref":"#/components/schemas/SupportedValidationsMetaExampleSchema"}}}},"SupportedValidationsSchema":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"display":{"type":"string"},"required":{"type":"boolean"},"meta":{"$ref":"#/components/schemas/SupportedValidationsMetaSchema"}}},"StringSingleLine":{"type":"object","properties":{"name":{"type":"string"},"list_enabled":{"type":"boolean"},"category":{"type":"string"},"type":{"type":"string"},"supported_validations":{"type":"array","items":{"$ref":"#/components/schemas/SupportedValidationsSchema"}}}},"StringMultiLine":{"type":"object","properties":{"name":{"type":"string"},"list_enabled":{"type":"boolean"},"category":{"type":"string"},"type":{"type":"string"},"supported_validations":{"type":"array","items":{"$ref":"#/components/schemas/SupportedValidationsSchema"}}}},"Dropdown":{"type":"object","properties":{"name":{"type":"string"},"list_enabled":{"type":"boolean"},"category":{"type":"string"},"type":{"type":"string"},"supported_validations":{"type":"array","items":{"$ref":"#/components/schemas/SupportedValidationsSchema"}}}},"Integer":{"type":"object","properties":{"name":{"type":"string"},"list_enabled":{"type":"boolean"},"type":{"type":"string"},"category":{"type":"string"},"supported_validations":{"type":"array","items":{"$ref":"#/components/schemas/SupportedValidationsSchema"}}}},"FloatType":{"type":"object","properties":{"name":{"type":"string"},"list_enabled":{"type":"boolean"},"type":{"type":"string"},"category":{"type":"string"},"supported_validations":{"type":"array","items":{"$ref":"#/components/schemas/SupportedValidationsSchema"}}}},"BooleanType":{"type":"object","properties":{"name":{"type":"string"},"category":{"type":"string"},"list_enabled":{"type":"boolean"},"type":{"type":"string"},"supported_validations":{"type":"array","items":{"$ref":"#/components/schemas/SupportedValidationsSchema"}}}},"Date":{"type":"object","properties":{"name":{"type":"string"},"list_enabled":{"type":"boolean"},"category":{"type":"string"},"type":{"type":"string"},"supported_validations":{"type":"array","items":{"$ref":"#/components/schemas/SupportedValidationsSchema"}}}},"Datetime":{"type":"object","properties":{"name":{"type":"string"},"category":{"type":"string"},"list_enabled":{"type":"boolean"},"type":{"type":"string"},"supported_validations":{"type":"array","items":{"$ref":"#/components/schemas/SupportedValidationsSchema"}}}},"Json":{"type":"object","properties":{"name":{"type":"string"},"list_enabled":{"type":"boolean"},"category":{"type":"string"},"type":{"type":"string"},"supported_validations":{"type":"array","items":{"$ref":"#/components/schemas/SupportedValidationsSchema"}}}},"File":{"type":"object","properties":{"name":{"type":"string"},"category":{"type":"string"},"list_enabled":{"type":"boolean"},"type":{"type":"string"},"supported_validations":{"type":"array","items":{"$ref":"#/components/schemas/SupportedValidationsSchema"}}}},"Url":{"type":"object","properties":{"url":{"type":"string","format":"uri","description":"The URL of the uploaded report file."},"name":{"type":"string","description":"The name of the uploaded report file."}}},"Metaobject":{"type":"object","properties":{"name":{"type":"string"},"list_enabled":{"type":"boolean"},"category":{"type":"string"},"type":{"type":"string"},"supported_validations":{"type":"array","items":{"$ref":"#/components/schemas/SupportedValidationsSchema"}}}},"CustomObjectEntry":{"type":"object","properties":{"_id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"updated_at":{"type":"string","format":"date-time"},"entries_count":{"type":"integer"},"fields_count":{"type":"integer"}}},"CustomObjectDefinitionsSchema":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/CustomObjectEntry"}},"page":{"$ref":"#/components/schemas/Page"}}},"CustomObjectEntryFieldSchema":{"type":"object","properties":{"definition_id":{"type":"string"},"value":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"integer"},{"type":"boolean"},{"type":"object"}]}}}},"CustomObjectRequestSchema":{"type":"object","properties":{"status":{"type":"string"},"definition_id":{"type":"string"},"fields":{"type":"array","items":{"$ref":"#/components/schemas/CustomObjectEntryFieldSchema"}}}},"CustomObjectBulkSchema":{"type":"object","properties":{"url":{"type":"string"},"total_records":{"type":"integer"}}},"ValidityObject":{"type":"object","required":["start","end"],"properties":{"start":{"type":"string","format":"date-time"},"end":{"type":"string","format":"date-time"}},"example":{"start":"2021-04-07T08:19:12.007Z","end":"2021-04-11T08:19:12.007Z"}},"CreateUpdateDiscount":{"type":"object","required":["name","job_type","discount_type","discount_level","company_id","app_ids","validity","is_active"],"properties":{"name":{"type":"string"},"company_id":{"type":"integer"},"is_active":{"type":"boolean"},"app_ids":{"type":"array","items":{"type":"string"}},"extension_ids":{"type":"array","items":{"type":"string"}},"job_type":{"type":"string","enum":["app","app|brand","app|store","app|brand|store","app|brand|product","app|brand|store|product","app|brand|inventory","app|brand|store|inventory"]},"discount_type":{"type":"string","enum":["flat","percentage"]},"discount_level":{"type":"string","enum":["application"]},"value":{"type":"integer"},"file_path":{"type":"string"},"brand_ids":{"type":"array","items":{"type":"integer"}},"store_ids":{"type":"array","items":{"type":"integer"}},"zone_ids":{"type":"array","items":{"type":"string"}},"validity":{"$ref":"#/components/schemas/ValidityObject"},"discount_meta":{"$ref":"#/components/schemas/DiscountMeta"}},"example":{"name":"Discount Name","company_id":0,"is_active":true,"app_ids":["xxx","yyy","zzz"],"extension_ids":["xxx","yyy","zzz"],"job_type":"app","discount_type":"flat","discount_level":"application","value":10,"file_path":"http://xxx.xxx.xxx/file.csv","brand_ids":[0],"store_ids":[0],"discount_meta":{"timer":true,"hours":20,"minutes":35},"validity":{"start":"2021-04-07T08:19:12.007Z","end":"2021-04-10T08:19:12.007Z"},"created_on":"2021-04-07T08:19:12.007Z","modified_on":"2021-04-10T08:19:12.007Z","created_by":{"username":"narutouzumaki","user_id":"0"},"modified_by":{"username":"narutouzumaki","user_id":"0"}}},"DiscountMeta":{"type":"object","description":"Holds information about the discount countdown timer.","required":["timer"],"properties":{"timer":{"type":"boolean","description":"Determines whether the discount countdown is visible or not.","example":true},"hours":{"type":"number","description":"The time in hours before the discount ends when the countdown timer should start.","example":2},"minutes":{"type":"number","description":"The time in minutes before the discount ends when the countdown timer should start.","example":35}},"example":{"timer":true,"hours":20,"minutes":35}},"DiscountJob":{"type":"object","required":["_id","name","company_id","is_active","validity","created_on","modified_on","created_by","modified_by"],"properties":{"_id":{"type":"string"},"name":{"type":"string"},"company_id":{"type":"integer"},"is_active":{"type":"boolean"},"app_ids":{"type":"array","items":{"type":"string"}},"job_type":{"type":"string"},"discount_type":{"type":"string"},"discount_level":{"type":"string"},"value":{"type":"integer"},"file_path":{"type":"string"},"brand_ids":{"type":"array","items":{"type":"integer"}},"store_ids":{"type":"array","items":{"type":"integer"}},"zone_ids":{"type":"array","items":{"type":"string"}},"discount_meta":{"$ref":"#/components/schemas/DiscountMeta"},"validity":{"$ref":"#/components/schemas/ValidityObject"},"created_on":{"type":"string"},"modified_on":{"type":"string"},"created_by":{"$ref":"#/components/schemas/UserDetails"},"modified_by":{"$ref":"#/components/schemas/UserDetails"},"meta":{"type":"object"}}},"FileJobBody":{"type":"object","properties":{"name":{"type":"string"},"company_id":{"type":"integer"},"is_active":{"type":"boolean"},"app_ids":{"type":"array","items":{"type":"string"}},"job_type":{"type":"string"},"discount_type":{"type":"string"},"discount_level":{"type":"string"},"value":{"type":"integer"},"file_path":{"type":"string"},"brand_ids":{"type":"array","items":{"type":"integer"}},"store_ids":{"type":"array","items":{"type":"integer"}},"extension_ids":{"type":"array","items":{"type":"string"}},"zone_ids":{"type":"array","items":{"type":"string"}},"discount_meta":{"$ref":"#/components/schemas/DiscountMeta"},"validity":{"$ref":"#/components/schemas/ValidityObject"},"created_on":{"type":"string"},"modified_on":{"type":"string"},"created_by":{"$ref":"#/components/schemas/UserDetails"},"modified_by":{"$ref":"#/components/schemas/UserDetails"},"meta":{"type":"object"}},"example":{"_id":"xxxxxxxxxxxx","name":"Discount Name","company_id":0,"is_active":true,"app_ids":["xxx","yyy","zzz"],"job_type":"app","discount_type":"flat","discount_level":"application","value":10,"file_path":"http://xxx.xxx.xxx/file.csv","brand_ids":[0],"store_ids":[0],"discount_meta":{"timer":true,"hours":20,"minutes":35},"validity":{"start":"2021-04-07T08:19:12.007Z","end":"2021-04-10T08:19:12.007Z"},"created_on":"2021-04-07T08:19:12.007Z","modified_on":"2021-04-10T08:19:12.007Z","created_by":{"username":"narutouzumaki","user_id":"0"},"modified_by":{"username":"narutouzumaki","user_id":"0"}}},"ListOrCalender":{"type":"object","required":["items","page"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/DiscountJob"}},"page":{"$ref":"#/components/schemas/Page"}},"example":{"items":[{"is_active":false,"app_ids":["xxx","yyy"],"_id":"xxxxxxxxxxxx","name":"Discount","job_type":"app","discount_type":"percentage","discount_level":"application","company_id":0,"validity":{"start":"2021-04-06T08:25:34.110Z","end":"2021-04-22T18:30:00.000Z"},"value":0,"file_path":"https://xxx.xxx.xxx/file.xlsx","created_by":{"username":"narutouzumaki","user_id":"0"},"modified_by":{"username":"narutouzumaki","user_id":"0"},"created_on":"2021-04-06T08:10:16.609Z","modified_on":"2021-04-07T08:19:12.007Z","brand_ids":[4],"store_ids":[4]}],"page":{"current":1,"item_total":1,"type":"number","size":1,"has_previous":true,"has_next":false}}},"DiscountItems":{"type":"object","required":["discount_type","value"],"properties":{"item_code":{"type":"string"},"brand_name":{"type":"string"},"seller_identifier":{"type":"string"},"discount_type":{"type":"string","enum":["flat","percentage"]},"value":{"type":"number"},"discount_meta":{"$ref":"#/components/schemas/DiscountMeta"}},"example":{"value":10,"item_code":"ITEMCODE-1","brand_uid":9,"discount_type":"flat","discount_meta":{"timer":true,"hours":20,"minutes":35}}},"BulkDiscount":{"type":"object","required":["items","company_id"],"properties":{"company_id":{"type":"integer"},"items":{"type":"array","items":{"$ref":"#/components/schemas/DiscountItems"}}},"example":{"items":[{"value":1000,"item_code":"ITEMCODE-1","brand_name":"Contract Being Human","discount_type":"flat","discount_meta":{"timer":true,"hours":20,"minutes":35}}],"company_id":1}},"FileJobResponse":{"type":"object","required":["stage","total","failed","company_id","type","_id"],"properties":{"stage":{"type":"string"},"total":{"type":"integer"},"failed":{"type":"integer"},"company_id":{"type":"integer"},"body":{"$ref":"#/components/schemas/FileJobBody"},"type":{"type":"string","enum":["download","validate"]},"file_type":{"type":"string","enum":["product","inventory"]},"_id":{"type":"string","description":"A unique identifier to distinguish and identify a job.","example":"63061e90caf46a6731ce6d6a"},"file_path":{"type":"string"},"progress":{"type":"integer"},"extension_ids":{"type":"array","items":{"type":"string"}},"zone_ids":{"type":"array","items":{"type":"string"}},"created_on":{"type":"string"},"modified_on":{"type":"string"},"created_by":{"$ref":"#/components/schemas/UserDetails"}},"example":{"_id":"xxxxxxxxxxxx","stage":"processing","total":10,"failed":0,"company_id":0,"file_path":"https://xxx.xxx.xxx/file.xlsx","body":{"is_active":false,"app_ids":["xxx","yyy"],"_id":"xxxxxxxxxxxx","name":"Discount","job_type":"app","discount_type":"percentage","discount_level":"application","company_id":0,"file_path":"https://xxx.xxx.xxx/file.xlsx","validity":{"start":"2021-04-06T08:25:34.110Z","end":"2021-04-22T18:30:00.000Z"},"value":null,"created_by":{"username":"narutouzumaki","user_id":"0"},"modified_by":{"username":"narutouzumaki","user_id":"0"},"created_on":"2021-04-06T08:10:16.609Z","modified_on":"2021-04-07T08:19:12.007Z","brand_ids":[4],"store_ids":[4]},"type":"download","file_type":"product"}},"FileJobRequest":{"type":"object","required":["name","company_id","is_active","validity"],"properties":{"name":{"type":"string"},"is_active":{"type":"boolean"},"company_id":{"type":"integer"},"app_ids":{"type":"array","items":{"type":"string"}},"job_type":{"type":"string"},"discount_type":{"type":"string"},"discount_level":{"type":"string"},"file_path":{"type":"string"},"brand_ids":{"type":"array","items":{"type":"integer"}},"store_ids":{"type":"array","items":{"type":"integer"}},"validity":{"$ref":"#/components/schemas/ValidityObject"},"meta":{"type":"object"}},"example":{"name":"Discount Name","is_active":true,"company_id":1,"app_ids":["xxx","yyy","zzz"],"job_type":"app","discount_type":"flat","discount_level":"application","file_path":"http://xxx.xxx.xxx/file.csv","brand_ids":[0],"store_ids":[0],"validity":{"start":"2021-04-07T08:19:12.007Z","end":"2021-04-10T08:19:12.007Z"}}},"DownloadFileJob":{"type":"object","properties":{"brand_ids":{"type":"array","items":{"type":"integer"}},"store_ids":{"type":"array","items":{"type":"integer"}}},"example":{"brand_ids":[0],"store_ids":[0]}},"CancelJobResponse":{"type":"object","required":["success"],"properties":{"success":{"type":"boolean"}},"example":{"success":true}},"UserDetails":{"type":"object","nullable":true,"properties":{"user_oid":{"type":"string","nullable":true},"external_customer_id":{"type":"string","nullable":true},"first_name":{"type":"string","nullable":true},"last_name":{"type":"string","nullable":true},"mobile":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"is_anonymous_user":{"type":"boolean","nullable":true},"gender":{"type":"string","nullable":true},"mongo_user_id":{"type":"string","nullable":true},"meta":{"type":"object","nullable":true}}},"BadRequestObject":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}},"example":{"message":"Error"}},"BadRequestData":{"type":"object","properties":{"message":{"type":"string"}}},"BadRequestObjectGet":{"type":"object","properties":{"message":{"type":"string"},"error":{"type":"string"},"data":{"$ref":"#/components/schemas/BadRequestData"}},"example":{"message":"Error"}},"FailedResponse":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}},"CDN":{"type":"object","required":["url","absolute_url","relative_url"],"properties":{"url":{"type":"string"},"absolute_url":{"type":"string"},"relative_url":{"type":"string"}},"example":{"url":"https://xxx.xxx.xxx/products/pictures/free/original/qwertyuiop-shirt.png","absolute_url":"https://xxx.xxx.xxx/products/pictures/free/original/qwertyuiop-shirt.png","relative_url":"x5/products/pictures/free/original/qwertyuiop-shirt.png"}},"Upload":{"type":"object","required":["expiry","url"],"properties":{"expiry":{"type":"integer"},"url":{"type":"string"}},"example":{"expiry":5000,"url":"https://xxx.xxx.xxx/products/pictures/free/original/qwertyuiop-shirt.png?AWSAccessKeyId=xxx&Content-Type=image%2Fpng&Expires=5000&Signature=xxx&x-amz-acl=public-read"}},"StartResponse":{"type":"object","required":["file_name","file_path","content_type","namespace","operation","size","upload","cdn"],"properties":{"file_name":{"type":"string"},"file_path":{"type":"string"},"content_type":{"type":"string"},"method":{"type":"string"},"namespace":{"type":"string"},"operation":{"type":"string"},"size":{"type":"integer"},"upload":{"$ref":"#/components/schemas/Upload"},"cdn":{"$ref":"#/components/schemas/CDN"},"tags":{"type":"array","items":{"type":"string"}}}},"StartRequest":{"type":"object","required":["file_name","content_type","size"],"properties":{"file_name":{"type":"string"},"content_type":{"type":"string"},"size":{"type":"integer"},"tags":{"type":"array","items":{"type":"string"}},"params":{"type":"object","additionalProperties":true}}},"CompleteResponse":{"type":"object","required":["_id","file_name","file_path","content_type","namespace","operation","size","upload","cdn","success","created_on","modified_on","company_id"],"properties":{"_id":{"type":"string"},"file_name":{"type":"string"},"file_path":{"type":"string"},"content_type":{"type":"string"},"namespace":{"type":"string"},"operation":{"type":"string"},"company_id":{"type":"number"},"size":{"type":"integer"},"upload":{"$ref":"#/components/schemas/Upload"},"cdn":{"$ref":"#/components/schemas/CDN"},"success":{"type":"boolean"},"tags":{"type":"array","items":{"type":"string"}},"created_on":{"type":"string"},"modified_on":{"type":"string"},"created_by":{"$ref":"#/components/schemas/CreatedBy"}}},"DestinationNamespace":{"type":"object","properties":{"namespace":{"type":"string"}}},"CopyFiles":{"type":"object","required":["destination"],"properties":{"urls":{"type":"array","items":{"type":"string"}},"destination":{"$ref":"#/components/schemas/DestinationNamespace"}}},"Urls":{"type":"object","required":["url","signed_url","expiry"],"properties":{"url":{"type":"string"},"signed_url":{"type":"string"},"expiry":{"type":"integer"}},"example":{"url":"https://some-domain.com/image.png","signed_url":"https://some-domain.com/image.png?AWSAccessKeyId=xxx&Expires=16134069&Signature=xxxx","expiry":5000}},"SignUrlResponse":{"type":"object","required":["urls"],"properties":{"urls":{"type":"array","items":{"$ref":"#/components/schemas/Urls"}}}},"SignUrlRequest":{"type":"object","required":["expiry","urls"],"properties":{"expiry":{"type":"integer"},"urls":{"type":"array","items":{"type":"string"}}}},"InvoiceTypesDataResponse":{"type":"object","required":["_id","pdf_type_id","name","format","__v","visibility","country_code"],"properties":{"status":{"type":"boolean"},"_id":{"type":"string"},"pdf_type_id":{"type":"integer","format":"int32"},"name":{"type":"string"},"format":{"type":"array","items":{"type":"string"}},"__v":{"type":"integer"},"visibility":{"type":"boolean"},"country_code":{"type":"string"}}},"InvoiceTypesResponse":{"type":"object","required":["data","success"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/InvoiceTypesDataResponse"}},"success":{"type":"boolean"}}},"ConversionRate":{"type":"object","properties":{"base":{"type":"string"},"rates":{"type":"object"}}},"DeliveryPartnerDetail":{"type":"object","properties":{"name":{"type":"string"},"awb_number_barcode":{"type":"string"},"awb_number":{"type":"string"},"origin":{"type":"string"},"destination":{"type":"string"},"eway_bill_number":{"type":"string","nullable":true}}},"PaymentData":{"type":"object","properties":{"payment_type":{"type":"string"},"amount":{"type":"number"},"date":{"type":"string"},"transaction_id":{"type":"string"},"time":{"type":"string"},"mode":{"type":"string"},"name":{"type":"string"},"meta":{"type":"object","additionalProperties":true}}},"InvoiceDetail":{"type":"object","properties":{"invoice_id":{"type":"string"},"invoice_date":{"type":"string"},"irn":{"type":"string"},"external_order_id":{"type":"string"},"shipment_id":{"type":"string"},"signed_qrcode":{"type":"string"},"upi_qrcode":{"type":"string"},"device_id":{"type":"string"},"marketplace_invoice_id":{"type":"string"},"marketplace_shipment_id":{"type":"string"},"channel_order_id":{"type":"string"}}},"CompanyDetail":{"type":"object","properties":{"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"country":{"type":"string"},"zip_code":{"type":"number"},"state_code":{"type":"string"},"country_code":{"type":"string"},"gstin":{"type":"string"},"pan":{"type":"string","nullable":true},"phone_no":{"type":"string"},"cin":{"type":"string"},"website_url":{"type":"string"},"email":{"type":"string"},"display_address":{"type":"string"},"sector":{"type":"string"},"phone":{"type":"object","additionalProperties":true},"trn":{"type":"string"},"vat":{"type":"string"},"business_country_timezone":{"type":"string"},"business_country_currency":{"type":"object","additionalProperties":true}}},"CustomerBillingDetail":{"type":"object","properties":{"name":{"type":"string"},"phone_no":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"country":{"type":"string"},"country_code":{"type":"string"},"zip_code":{"type":"string"},"state_code":{"type":"string"},"gstin":{"type":"string","nullable":true},"display_address":{"type":"string"},"sector":{"type":"string"},"email":{"type":"string"}}},"CustomerShippingDetail":{"type":"object","properties":{"name":{"type":"string"},"phone_no":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"country":{"type":"string"},"country_code":{"type":"string"},"zip_code":{"type":"string"},"state_code":{"type":"string"},"gstin":{"type":"string","nullable":true},"display_address":{"type":"string"},"sector":{"type":"string"}}},"ReturnDetail":{"type":"object","properties":{"address":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"country":{"type":"string"},"country_code":{"type":"string","nullable":true},"zip_code":{"type":"string"},"state_code":{"type":"string"},"gstin":{"type":"string","nullable":true},"display_address":{"type":"string"},"sector":{"type":"string"}}},"Cgst":{"type":"object","properties":{"value":{"type":"number"},"percent":{"type":"number"}}},"Sgst":{"type":"object","properties":{"value":{"type":"number"},"percent":{"type":"number"}}},"Igst":{"type":"object","properties":{"value":{"type":"number"},"percent":{"type":"number"}}},"Tax":{"type":"object","properties":{"name":{"type":"string"},"rate":{"type":"number","format":"float"},"breakup":{"type":"array","items":{"type":"object"}},"amount":{"type":"object"}},"required":["amount","name","rate"]},"ItemsProductTable":{"type":"object","properties":{"name":{"type":"string"},"seller_identifier":{"type":"string"},"total":{"type":"number"},"brand":{"$ref":"#/components/schemas/Brand"},"hsn_code":{"type":"string"},"item_code":{"type":"string"},"total_units":{"type":"number"},"size":{"type":"string"},"mrp":{"type":"number"},"discount":{"type":"number"},"taxable_amount":{"type":"number"},"total_taxable_amount":{"type":"number"},"tax":{"$ref":"#/components/schemas/Tax"},"meta":{"type":"object","additionalProperties":true},"country_of_origin":{"type":"string"}}},"ProductTable":{"type":"object","properties":{"total_items":{"type":"number"},"products":{"type":"array","items":{"$ref":"#/components/schemas/ItemsProductTable"}},"grand_total":{"type":"number"},"delivery_charges":{"type":"number"},"delivery_charge_text":{"type":"string"},"cod_charges":{"type":"number"},"fynd_discounts":{"type":"number"},"total_in_words":{"type":"string"},"gift_price":{"type":"number"},"total_quantity":{"type":"number"},"sub_total":{"type":"number"},"discount":{"type":"number"},"promotion":{"type":"number"},"coupon":{"type":"number"},"reward":{"type":"number"},"round_off":{"type":"number"},"total_value_of_goods":{"type":"number"}}},"Taxes":{"type":"object","properties":{"hsn_code":{"type":"string"},"tax":{"$ref":"#/components/schemas/Tax"},"total_tax_value":{"type":"number"}}},"TaxTable":{"type":"object","properties":{"taxes":{"type":"array","items":{"$ref":"#/components/schemas/Taxes"}},"total_tax":{"type":"number"},"tax_in_words":{"type":"string"}}},"RegisteredCompanyDetail":{"type":"object","properties":{"address":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"country":{"type":"string"},"country_code":{"type":"string"},"zip_code":{"type":"number"},"state_code":{"type":"string"},"display_address":{"type":"string"},"sector":{"type":"string"}}},"Kwargs":{"type":"object","properties":{"value":{"type":"string"}}},"ShipmentIdBarcodeGenerator":{"type":"object","properties":{"method":{"type":"string"},"kwargs":{"$ref":"#/components/schemas/Kwargs"}}},"SignedQrcodeGenerator":{"type":"object","properties":{"method":{"type":"string"},"kwargs":{"$ref":"#/components/schemas/Kwargs"}}},"KwargsUpiQrcode":{"type":"object","properties":{"qr_data":{"type":"string"},"qr_url":{"type":"string"}}},"UpiQrcodeGenerator":{"type":"object","properties":{"method":{"type":"string"},"kwargs":{"$ref":"#/components/schemas/KwargsUpiQrcode"}}},"DigitalsignatureGenerator":{"type":"object","properties":{"method":{"type":"string"},"kwargs":{"$ref":"#/components/schemas/Kwargs"}}},"KwargsAwbNumber":{"type":"object","properties":{"value":{"type":"array","items":{"type":"object"}}}},"AwbNumberLabelBarcodeGenerator":{"type":"object","properties":{"method":{"type":"string"},"kwargs":{"$ref":"#/components/schemas/KwargsAwbNumber"}}},"AwbNumberBarcodeGenerator":{"type":"object","properties":{"method":{"type":"string"},"kwargs":{"$ref":"#/components/schemas/Kwargs"}}},"MetaProperty":{"type":"object","properties":{"shipment_id_barcode_generator":{"$ref":"#/components/schemas/ShipmentIdBarcodeGenerator"},"signed_qrcode_generator":{"$ref":"#/components/schemas/SignedQrcodeGenerator"},"upi_qrcode_generator":{"$ref":"#/components/schemas/UpiQrcodeGenerator"},"digitalsignature_generator":{"$ref":"#/components/schemas/DigitalsignatureGenerator"},"awb_number_label_barcode_generator":{"$ref":"#/components/schemas/AwbNumberLabelBarcodeGenerator"},"awb_number_barcode_generator":{"$ref":"#/components/schemas/AwbNumberBarcodeGenerator"}}},"DummyTemplateDataPayload":{"type":"object","properties":{"is_export":{"type":"boolean"},"is_export_shipment":{"type":"boolean"},"app_domain_name":{"type":"string"},"txn_id":{"type":"string"},"utr":{"type":"string"},"po_number":{"type":"string"},"credit_note_id":{"type":"string","nullable":true},"current_date":{"type":"string"},"total_value_of_goods":{"type":"number"},"b2b_buyer_details":{"type":"object","additionalProperties":true},"is_qwik":{"type":"object","additionalProperties":true},"order_type":{"type":"string"},"conversion_rate":{"$ref":"#/components/schemas/ConversionRate"},"currency_code":{"type":"string"},"shipment_id":{"type":"string"},"delivery_partner_detail":{"$ref":"#/components/schemas/DeliveryPartnerDetail"},"image":{"$ref":"#/components/schemas/Image"},"payments":{"type":"array","items":{"$ref":"#/components/schemas/PaymentData"}},"invoice_detail":{"$ref":"#/components/schemas/InvoiceDetail"},"company_detail":{"$ref":"#/components/schemas/CompanyDetail"},"store_detail":{"$ref":"#/components/schemas/StoreDetail"},"customer_billing_detail":{"$ref":"#/components/schemas/CustomerBillingDetail"},"customer_shipping_detail":{"$ref":"#/components/schemas/CustomerShippingDetail"},"return_detail":{"$ref":"#/components/schemas/ReturnDetail"},"product_table":{"$ref":"#/components/schemas/ProductTable"},"tax_table":{"$ref":"#/components/schemas/TaxTable"},"declaration_texts":{"type":"array","items":{"type":"string"}},"registered_company_detail":{"$ref":"#/components/schemas/RegisteredCompanyDetail"},"disclaimer":{"type":"string"},"meta":{"$ref":"#/components/schemas/Meta"},"is_self_ship":{"type":"boolean"},"mode":{"type":"string"},"is_self_pickup":{"type":"boolean"},"platform_name":{"type":"string"},"amount_to_be_collected":{"type":"number"},"amount_paid":{"type":"number"},"waybills":{"type":"array","items":{"type":"object"}},"total_items":{"type":"number"},"brand_logo":{"type":"string"},"shipment_id_barcode":{"type":"string"},"signed_qrcode":{"type":"string"},"upi_qrcode":{"type":"string"},"digitalsignature":{"type":"string"},"awb_number_barcode":{"type":"string"},"uid":{"type":"string"}}},"DummyTemplateData":{"type":"object","required":["payload"],"properties":{"_id":{"type":"string"},"pdf_type_id":{"type":"number"},"payload":{"$ref":"#/components/schemas/DummyTemplateDataPayload"},"country_code":{"type":"string"},"__v":{"type":"integer"}}},"DummyTemplateDataItems":{"type":"object","required":["data","success"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/DummyTemplateData"}},"success":{"type":"boolean"}}},"PdfConfig":{"type":"object","properties":{"format":{"type":"string","enum":["A4","A6","POS"],"description":"This is invoice document format such as A4, A6, POS"},"template":{"type":"string","description":"This is html template string"},"pdf_type_id":{"type":"integer"}}},"PdfConfigSuccessData":{"type":"object","properties":{"_id":{"type":"string"},"company_id":{"type":"integer"},"application_id":{"type":"string"},"pdf_type_id":{"type":"integer"},"format":{"type":"string","enum":["A4","A6","POS"]},"template":{"type":"string"},"__v":{"type":"integer"},"country_code":{"type":"string"}}},"PdfConfigSuccess":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PdfConfigSuccessData"}},"success":{"type":"boolean"}}},"PdfConfigSaveSuccessData":{"type":"object","properties":{"_id":{"type":"string"},"company_id":{"type":"integer"},"application_id":{"type":"string"},"pdf_type_id":{"type":"integer"},"format":{"type":"string","enum":["A4","A6","POS"]},"template":{"type":"string"},"__v":{"type":"integer"}}},"PdfConfigSaveSuccess":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PdfConfigSaveSuccessData"},"success":{"type":"boolean"}}},"PdfDefaultTemplateSuccess":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Document"}},"success":{"type":"boolean","description":"Indicates if the request was successful."}}},"PaymentReceiptRequestBody":{"type":"object","properties":{"payload":{"$ref":"#/components/schemas/PaymentReceiptPayload"},"meta":{"$ref":"#/components/schemas/PaymentReceiptMeta"}}},"PaymentReceiptOrderDetails":{"type":"object","properties":{"jiomart_order_id":{"type":"string"},"total_items":{"type":"number"},"final_amount":{"type":"number"},"final_amount_in_words":{"type":"string"},"order_created_date":{"type":"string"},"order_created_time":{"type":"string"},"prm_id":{"type":"string"},"receipt_no":{"type":"string"},"taxes":{"$ref":"#/components/schemas/PaymentReceiptTaxes"}}},"PaymentReceiptCustomerDetails":{"type":"object","properties":{"id":{"type":"string"},"email_id":{"type":"string"},"last_name":{"type":"string"},"first_name":{"type":"string"},"mobile_number":{"type":"string"}}},"PaymentReceiptPayments":{"type":"object","properties":{"payment_desc":{"type":"string"},"txn_date":{"type":"string"}}},"PaymentReceiptFormat":{"type":"object","properties":{"payment_receipt":{"type":"array","items":{"type":"string"}}}},"PaymentReceiptService":{"type":"object","properties":{"name":{"type":"string"}}},"PaymentReceiptTaxes":{"type":"object","properties":{"gstin":{"type":"string"},"pancard":{"type":"string"}}},"PaymentReceiptPayload":{"type":"object","properties":{"uid":{"type":"string"},"order_detail":{"$ref":"#/components/schemas/PaymentReceiptOrderDetails"},"customer_detail":{"$ref":"#/components/schemas/PaymentReceiptCustomerDetails"},"payments":{"type":"array","items":{"$ref":"#/components/schemas/PaymentReceiptPayments"}}}},"PaymentReceiptMeta":{"type":"object","properties":{"job_type":{"type":"string"},"action":{"type":"string"},"event":{"type":"object"},"organizaton_id":{"type":"string"},"company_id":{"type":"number"},"application_id":{"type":"array","items":{"type":"string"}},"format":{"$ref":"#/components/schemas/PaymentReceiptFormat"},"trace_id":{"type":"array","items":{"type":"string"}},"created_timestamp":{"type":"number"},"service":{"$ref":"#/components/schemas/PaymentReceiptService"},"event_trace_info":{"type":"object"},"trace":{"type":"string"}}},"ExtensionSlug":{"type":"object","properties":{"extension_slug":{"type":"string"}}},"GenerateReportMeta":{"type":"object","properties":{"brand":{"type":"string"},"company":{"type":"string"},"channel":{"type":"string"}}},"GenerateReportFilters":{"type":"object","properties":{"brand":{"type":"array","items":{"type":"string"}},"company":{"type":"array","items":{"type":"string"}},"channel":{"type":"array","items":{"type":"string"}}}},"GenerateReportPlatform":{"type":"object","properties":{"start_date":{"type":"string"},"end_date":{"type":"string"},"meta":{"$ref":"#/components/schemas/GenerateReportMeta"},"report_id":{"type":"string"},"filters":{"$ref":"#/components/schemas/GenerateReportFilters"}}},"GenerateReportRequest":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/GenerateReportPlatform"}}},"GenerateReportJson":{"type":"object","properties":{"items":{"type":"array","items":{"type":"array","items":{"type":"string"}}},"page":{"$ref":"#/components/schemas/Page"},"end_date":{"type":"string"},"headers":{"type":"array","items":{"type":"string"}},"start_date":{"type":"string"},"item_count":{"type":"integer"}}},"Error":{"type":"object","properties":{"error":{"type":"string","description":"Error message describing the reason for the failure."}}},"DownloadReport":{"type":"object","properties":{"page":{"type":"integer"},"pagesize":{"type":"integer"},"start_date":{"type":"string"},"end_date":{"type":"string"}}},"DownloadReportItems":{"type":"object","properties":{"start_date":{"type":"string"},"end_date":{"type":"string"},"meta":{"$ref":"#/components/schemas/GenerateReportMeta"},"report_id":{"type":"string"},"filters":{"$ref":"#/components/schemas/GenerateReportFilters"},"type_of_request":{"type":"string"}}},"DownloadReportList":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/DownloadReportItems"}},"page":{"$ref":"#/components/schemas/Page"},"item_count":{"type":"integer"}}},"GetEngineData":{"type":"object","properties":{"table_name":{"type":"string"},"project":{"type":"array","items":{"type":"string"}},"filters":{"type":"object"}}},"GetEngineRequest":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/GetEngineData"}}},"GetEngineResponse":{"type":"object","properties":{"success":{"type":"boolean"},"items":{"type":"array","items":{"type":"object"}},"page":{"$ref":"#/components/schemas/Page"},"item_count":{"type":"integer"}}},"GetReason":{"type":"object","properties":{"reason_type":{"type":"string"}}},"GetReasonRequest":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/GetReason"}}},"ReasonItem":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"display_name":{"type":"string"}}},"GetReasonResponse":{"type":"object","properties":{"success":{"type":"boolean"},"item_list":{"type":"array","items":{"$ref":"#/components/schemas/ReasonItem"}},"item_count":{"type":"integer"},"page":{"$ref":"#/components/schemas/Page"}}},"GetReportListData":{"type":"object","properties":{"role_name":{"type":"string"},"listing_enabled":{"type":"boolean"}}},"GetReportListRequest":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/GetReportListData"}}},"GetAffiliate":{"type":"object","properties":{"company_id":{"type":"integer"}}},"GetReportListResponse":{"type":"object","properties":{"success":{"type":"boolean"},"items":{"type":"array","items":{"$ref":"#/components/schemas/ReportItem"}},"page":{"$ref":"#/components/schemas/Page"},"total_count":{"type":"integer"}}},"ReportItem":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"allowed_filters":{"type":"array","items":{"type":"string"}},"config_meta":{"type":"object"},"report_type":{"type":"string"},"display_date":{"type":"string","nullable":true}}},"GetAffiliateResponse":{"type":"object","properties":{"success":{"type":"boolean"},"docs":{"type":"array","items":{"type":"object"}}}},"DownloadCreditDebitNote":{"type":"object","properties":{"note_id":{"type":"array","items":{"type":"string"}}}},"DownloadCreditDebitNoteRequest":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/DownloadCreditDebitNote"}}},"DownloadCreditDebitNoteResponseData":{"type":"object","properties":{"id":{"type":"string"},"pdf_s3_url":{"type":"string"}}},"DownloadCreditDebitNoteResponse":{"type":"object","properties":{"success":{"type":"boolean"},"data":{"type":"array","items":{"$ref":"#/components/schemas/DownloadCreditDebitNoteResponseData"}}}},"PaymentProcessPayload":{"type":"object","properties":{"platform":{"type":"string"},"amount":{"type":"string"},"transaction_type":{"type":"string"},"source_reference":{"type":"string"},"total_amount":{"type":"string"},"meta":{"type":"object"},"currency":{"type":"string"},"seller_id":{"type":"string"},"mode_of_payment":{"type":"string"},"invoice_number":{"type":"string"}}},"PaymentProcessRequest":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PaymentProcessPayload"}}},"PaymentProcessResponse":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"meta":{"type":"object"},"transaction_id":{"type":"string"},"redirect_url":{"type":"string"}}},"CreditlineDataPlatformPayload":{"type":"object","properties":{"page":{"type":"integer"},"seller_id":{"type":"string"},"end_end":{"type":"string"},"start_end":{"type":"string"},"pagesize":{"type":"integer"}}},"CreditlineDataPlatformRequest":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CreditlineDataPlatformPayload"}}},"CreditlineDataPlatformResponse":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object"}},"code":{"type":"integer"},"show_mr":{"type":"boolean"},"page":{"$ref":"#/components/schemas/Page"},"message":{"type":"string"},"headers":{"type":"array","items":{"type":"string"}},"item_count":{"type":"integer"}}},"IsCreditlinePayload":{"type":"object","properties":{"seller_id":{"type":"string"}}},"IsCreditlinePlatformRequest":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/IsCreditlinePayload"}}},"IsCreditlinePlatformResponse":{"type":"object","properties":{"is_creditline_opted":{"type":"boolean"},"code":{"type":"integer"}}},"InvoiceTypePayloadData":{"type":"object","properties":{"is_active":{"type":"boolean"}}},"InvoiceTypeRequest":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/InvoiceTypePayloadData"}}},"InvoiceTypeResponseItems":{"type":"object","properties":{"text":{"type":"string"},"value":{"type":"string"}}},"InvoiceTypeResponse":{"type":"object","properties":{"success":{"type":"boolean"},"invoice_type_list":{"type":"array","items":{"$ref":"#/components/schemas/InvoiceTypeResponseItems"}},"payment_status_list":{"type":"array","items":{"$ref":"#/components/schemas/InvoiceTypeResponseItems"}}}},"InoviceListingPayloadDataFilters":{"type":"object","properties":{"payment_status":{"type":"array","items":{"type":"string"}},"invoice_type":{"type":"array","items":{"type":"string"}},"company_id":{"type":"array","items":{"type":"string"}}}},"InvoiceListingPayloadData":{"type":"object","properties":{"page_size":{"type":"integer"},"page":{"type":"integer"},"start_date":{"type":"string"},"end_date":{"type":"string"},"search":{"type":"string"},"filters":{"$ref":"#/components/schemas/InoviceListingPayloadDataFilters"}}},"InvoiceListingRequest":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/InvoiceListingPayloadData"}}},"UnpaidInvoiceDataItems":{"type":"object","properties":{"total_unpaid_invoice_count":{"type":"integer"},"currency":{"type":"string"},"total_unpaid_amount":{"type":"number"}}},"InvoiceListingResponseItems":{"type":"object","properties":{"amount":{"type":"string"},"company":{"type":"string"},"status":{"type":"string"},"due_date":{"type":"string"},"invoice_date":{"type":"string"},"invoice_type":{"type":"string"},"period":{"type":"string"},"invoice_number":{"type":"string"},"is_downloadable":{"type":"boolean"},"invoice_id":{"type":"string"},"currency":{"$ref":"#/components/schemas/Currency"}}},"InvoiceListingResponse":{"type":"object","properties":{"unpaid_invoice_data":{"$ref":"#/components/schemas/UnpaidInvoiceDataItems"},"items":{"type":"array","items":{"$ref":"#/components/schemas/InvoiceListingResponseItems"}},"page":{"$ref":"#/components/schemas/Page"},"item_count":{"type":"integer"}}},"InvoicePdfPayloadData":{"type":"object","properties":{"invoice_number":{"type":"array","items":{"type":"string"}}}},"InvoicePdfRequest":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/InvoicePdfPayloadData"}}},"InvoicePdfResponse":{"type":"object","properties":{"success":{"type":"boolean"},"data":{"type":"array","items":{"type":"string"}},"error":{"type":"array","items":{"type":"string"}}}},"IsCnRefundMethodData":{"type":"object","properties":{"affiliate_id":{"type":"string"},"toggle_edit_required":{"type":"boolean"},"seller_id":{"type":"integer"}}},"IsCnRefundMethodRequest":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/IsCnRefundMethodData"}}},"IsCnRefundMethodResponseData":{"type":"object","properties":{"is_first_time_user":{"type":"boolean"}}},"IsCnRefundMethodResponse":{"type":"object","properties":{"success":{"type":"boolean"},"data":{"$ref":"#/components/schemas/IsCnRefundMethodResponseData"}}},"CreditNoteConfigNotificationEvents":{"type":"object","properties":{"expiration_reminder_to_customer":{"type":"integer"}}},"CreateSellerCreditNoteConfig":{"type":"object","properties":{"is_cn_as_refund_method":{"type":"boolean"},"affiliate_id":{"type":"string"},"source_channel":{"type":"array","items":{"type":"string"}},"seller_id":{"type":"integer"},"notification_events":{"$ref":"#/components/schemas/CreditNoteConfigNotificationEvents"},"sales_channel_name":{"type":"string"},"ordering_channel":{"type":"array","items":{"type":"string"}},"validity":{"type":"integer"},"currency_type":{"type":"string"},"slug_values":{"type":"array","items":{"type":"string"}}}},"CreateSellerCreditNoteConfigRequest":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CreateSellerCreditNoteConfig"}}},"CreateSellerCreditNoteConfigResponse":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}},"DeleteConfig":{"type":"object","properties":{"affiliate_id":{"type":"string"},"slug_values":{"type":"array","items":{"type":"string"}},"seller_id":{"type":"integer"}}},"DeleteConfigRequest":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/DeleteConfig"}}},"DeleteConfigResponse":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}},"ChannelDisplayName":{"type":"object","properties":{"platform_pos":{"type":"string"}}},"ChannelDisplayNameResponse":{"type":"object","properties":{"success":{"type":"boolean"},"data":{"$ref":"#/components/schemas/ChannelDisplayName"}}},"CnReferenceNumber":{"type":"object","properties":{"cn_reference_number":{"type":"string"}}},"GetPdfUrlViewRequest":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CnReferenceNumber"}}},"GetPdfUrlViewResponseData":{"type":"object","properties":{"s3_pdf_link":{"type":"string"},"cn_reference_number":{"type":"string"}}},"GetPdfUrlViewResponse":{"type":"object","properties":{"success":{"type":"boolean"},"data":{"$ref":"#/components/schemas/GetPdfUrlViewResponseData"}}},"CreditNoteDetailsRequest":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CnReferenceNumber"}}},"CnDetails":{"type":"object","properties":{"staff_id":{"type":"string"},"expiry_date":{"type":"string"},"channel_of_issuance":{"type":"string"},"order_id":{"type":"string"},"date_issued":{"type":"string"},"ordering_channel":{"type":"string"},"shipment_id":{"type":"string"},"store_id":{"type":"string"},"invoice_number":{"type":"string"}}},"RedemptionDetails":{"type":"object","properties":{"staff_id":{"type":"string"},"created_at":{"type":"string"},"order_id":{"type":"string"},"store_id":{"type":"string"},"shipment_id":{"type":"string"},"ordering_channel":{"type":"string"},"amount_debited":{"type":"integer"},"invoice_number":{"type":"string"}}},"CreditNoteDetails":{"type":"object","properties":{"cn_status":{"type":"string"},"customer_mobile_number":{"type":"string"},"cn_reference_number":{"type":"string"},"cn_details":{"$ref":"#/components/schemas/CnDetails"},"redemption_details":{"type":"array","items":{"$ref":"#/components/schemas/RedemptionDetails"}},"remaining_cn_amount":{"type":"integer"},"available_cn_balance":{"type":"integer"},"cn_amount":{"type":"integer"}}},"CreditNoteDetailsResponse":{"type":"object","properties":{"success":{"type":"boolean"},"data":{"$ref":"#/components/schemas/CreditNoteDetails"}}},"GetCustomerCreditBalance":{"type":"object","properties":{"affiliate_id":{"type":"string"},"seller_id":{"type":"integer"},"customer_mobile_number":{"type":"string"}}},"GetCustomerCreditBalanceRequest":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/GetCustomerCreditBalance"}}},"GetCustomerCreditBalanceResponseData":{"type":"object","properties":{"customer_mobile_number":{"type":"string"},"total_credited_balance":{"type":"integer"}}},"GetCustomerCreditBalanceResponse":{"type":"object","properties":{"success":{"type":"boolean"},"data":{"$ref":"#/components/schemas/GetCustomerCreditBalanceResponseData"}}},"GetCnConfigRequest":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/DeleteConfig"}}},"GetCnConfigResponseMeta":{"type":"object","properties":{"reason":{"type":"string"},"source_channel":{"type":"array","items":{"type":"string"}}}},"GetCnConfigResponseData":{"type":"object","properties":{"is_cn_as_refund_method":{"type":"boolean"},"affiliate_id":{"type":"string"},"meta":{"$ref":"#/components/schemas/GetCnConfigResponseMeta"},"seller_id":{"type":"integer"},"notification_events":{"$ref":"#/components/schemas/CreditNoteConfigNotificationEvents"},"validity":{"type":"integer"},"redemption_ordering_channel":{"type":"array","items":{"type":"string"}},"currency_type":{"type":"string"}}},"GetCnConfigResponse":{"type":"object","properties":{"success":{"type":"boolean"},"data":{"$ref":"#/components/schemas/GetCnConfigResponseData"}}},"CnGenerateReportFilters":{"type":"object","properties":{"staff_id":{"type":"array","items":{"type":"string"}},"channel_of_issuance":{"type":"array","items":{"type":"string"}},"utilisation":{"type":"array","items":{"type":"string"}},"ordering_channel":{"type":"array","items":{"type":"string"}},"store_id":{"type":"array","items":{"type":"integer"}},"types_of_transaction":{"type":"array","items":{"type":"string"}}}},"CnGenerateReport":{"type":"object","properties":{"page":{"type":"integer"},"end_date":{"type":"string"},"pagesize":{"type":"integer"},"filters":{"$ref":"#/components/schemas/CnGenerateReportFilters"},"affiliate_id":{"type":"string"},"meta":{"$ref":"#/components/schemas/GenerateReportFilters"},"search":{"type":"string"},"report_id":{"type":"string"},"search_type":{"type":"string"},"start_date":{"type":"string"}}},"GenerateReportCustomerCnRequest":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CnGenerateReport"}}},"CnGenerateReportItems":{"type":"object","properties":{"expiry_date":{"type":"string"},"status":{"type":"string"},"total_amount":{"type":"integer"},"order_id":{"type":"string"},"date_issued":{"type":"string"},"shipment_id":{"type":"string"},"invoice_number":{"type":"string"},"credit_note_number":{"type":"string"}}},"GenerateReportCustomerCnResponseData":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/CnGenerateReportItems"}},"row_header_display_order":{"type":"object"},"end_date":{"type":"string"},"page":{"$ref":"#/components/schemas/Page"},"headers":{"type":"array","items":{"type":"string"}},"primary_headers":{"type":"array","items":{"type":"string"}},"allowed_filters":{"type":"array","items":{"type":"string"}},"start_date":{"type":"string"},"item_count":{"type":"integer"}}},"GenerateReportCustomerCnResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/GenerateReportCustomerCnResponseData"}}},"CnDownloadReport":{"type":"object","properties":{"page":{"type":"integer"},"start_date":{"type":"string"},"end_date":{"type":"string"},"affiliate_id":{"type":"string"},"search":{"type":"string"},"status":{"type":"array","items":{"type":"string"}},"search_type":{"type":"string"},"pagesize":{"type":"integer"}}},"DownloadReportCustomerCnRequest":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CnDownloadReport"}}},"DownloadReportResponseData":{"type":"object","properties":{"report_config_id":{"type":"string"},"full_name":{"type":"string"},"requested_by":{"type":"string"},"start_date":{"type":"string"},"end_date":{"type":"string"},"request_dict":{"type":"object"},"download_link":{"type":"string"},"created_at":{"type":"string"},"meta":{"type":"object"},"msg":{"type":"string"},"report_name":{"type":"string"},"status":{"type":"string"},"display_name":{"type":"string"},"filters":{"type":"object"}}},"DownloadReportCustomerCnResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/DownloadReportResponseData"}}}},"GetReportingFilters":{"type":"object","properties":{"text":{"type":"string"},"type":{"type":"string"},"options":{"type":"array","items":{"type":"object"}},"value":{"type":"string"}}},"GetReportingNestedFilters":{"type":"object","properties":{"text":{"type":"string"},"options":{"type":"array","items":{"type":"object"}},"required":{"type":"boolean"},"placeholder_text":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}}},"GetReportingFiltersResponse":{"type":"object","properties":{"search":{"$ref":"#/components/schemas/GetReportingFilters"},"filters":{"type":"array","items":{"$ref":"#/components/schemas/GetReportingNestedFilters"}},"status":{"$ref":"#/components/schemas/GetReportingFilters"}}},"PaymentDetail":{"type":"object","properties":{"display_name":{"type":"string"},"value":{"type":"string"}}},"PaidInvoicePaymentDetail":{"type":"object","properties":{"payment_details":{"type":"array","items":{"$ref":"#/components/schemas/PaymentDetail"}},"date_of_payment":{"type":"string"},"amount":{"type":"number"}}},"InvoicePaymentDetailsResponseData":{"type":"object","properties":{"paid_invoice_payment_details":{"type":"array","items":{"$ref":"#/components/schemas/PaidInvoicePaymentDetail"}},"failed_attempts_details":{"type":"array","items":{"type":"object"}}}},"InvoicePaymentDetailsResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/InvoicePaymentDetailsResponseData"},"success":{"type":"boolean"},"payment_details_visible":{"type":"boolean"}}},"InvoiceActivityLogsResponseData":{"type":"object","properties":{"performed_by":{"type":"string"},"status":{"type":"string"},"reason":{"type":"string"},"is_resolved":{"type":"boolean"},"retry_attempts":{"type":"number"},"max_retry_attempts":{"type":"number"}}},"InvoiceActivityLogsResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/InvoiceActivityLogsResponseData"}}}},"InvoiceActivityLogError":{"type":"object","properties":{"reason":{"type":"string"}}},"UnlockCreditNoteRequestData":{"type":"object","properties":{"seller_id":{"type":"string"},"locked_credit_notes":{"type":"array","items":{"type":"string"}},"unlock_reason":{"type":"string"},"description":{"type":"string"}}},"UnlockCreditNoteRequest":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/UnlockCreditNoteRequestData"}}},"UnlockCreditNoteResponseData":{"type":"object","properties":{"is_cn_unlocked":{"type":"boolean"},"status":{"type":"string"}}},"UnlockCreditNoteResponse":{"type":"object","properties":{"success":{"type":"boolean"},"data":{"$ref":"#/components/schemas/UnlockCreditNoteResponseData"}}},"DataTresholdDTO":{"type":"object","properties":{"min_price":{"type":"number","format":"double"},"safe_stock":{"type":"integer","format":"int32"},"period_threshold":{"type":"integer","format":"int32"},"period_threshold_type":{"type":"string","enum":["DAYS","HOURS","WEEKS","MONTHS"]},"period_type_list":{"type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/GenericDTO"}}}},"GenericDTO":{"type":"object","properties":{"text":{"type":"string"},"value":{"type":"object"}}},"JobConfigDTO":{"required":["company_id","integration"],"type":"object","properties":{"integration_data":{"type":"object","additionalProperties":{"type":"object"}},"company_name":{"type":"string"},"integration":{"type":"string","writeOnly":true},"company_id":{"type":"integer","format":"int32"},"task_details":{"$ref":"#/components/schemas/TaskDTO"},"threshold_details":{"$ref":"#/components/schemas/DataTresholdDTO"},"job_code":{"type":"string"},"alias":{"type":"string"}}},"TaskDTO":{"type":"object","properties":{"type":{"type":"integer","format":"int32"},"group_list":{"type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/GenericDTO"}}}},"ResponseEnvelopeString":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time"},"status":{"type":"integer","format":"int32"},"error":{"type":"string"},"exception":{"type":"string"},"message":{"type":"string"},"total_time_taken_in_millis":{"type":"integer","format":"int64"},"http_status":{"type":"string","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]},"items":{"type":"string"},"payload":{"type":"string"},"trace_id":{"type":"string"},"page":{"$ref":"#/components/schemas/Page"}}},"KafkaMetaModel":{"type":"object","properties":{"job_type":{"type":"string"},"batch_id":{"type":"integer","format":"int32"},"action":{"type":"string"},"trace":{"type":"array","items":{"type":"string"}},"created_on":{"type":"string"},"created_timestamp":{"type":"integer","format":"int64"}}},"SuppressStoreModel":{"type":"object","properties":{"stores":{"type":"array","items":{"type":"integer","format":"int32"}}}},"SuppressStorePayload":{"type":"object","properties":{"payload":{"type":"array","items":{"$ref":"#/components/schemas/SuppressStoreModel"}},"meta":{"$ref":"#/components/schemas/KafkaMetaModel"}}},"KafkaResponse":{"type":"object","properties":{"offset":{"type":"integer","format":"int64"},"partition":{"type":"integer","format":"int32"}}},"ResponseEnvelopeKafkaResponse":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time"},"status":{"type":"integer","format":"int32"},"error":{"type":"string"},"exception":{"type":"string"},"message":{"type":"string"},"total_time_taken_in_millis":{"type":"integer","format":"int64"},"http_status":{"type":"string","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]},"items":{"$ref":"#/components/schemas/KafkaResponse"},"payload":{"$ref":"#/components/schemas/KafkaResponse"},"trace_id":{"type":"string"},"page":{"$ref":"#/components/schemas/Page"}}},"GCompany":{"type":"object","properties":{"_id":{"type":"string"},"integration":{"type":"string"},"level":{"type":"string"},"uid":{"type":"integer","format":"int32"},"opted":{"type":"boolean"},"permissions":{"type":"array","items":{"type":"string"}},"token":{"type":"string"},"name":{"type":"string"},"stores":{"type":"array","items":{"$ref":"#/components/schemas/GStore"}}}},"GStore":{"type":"object","properties":{"_id":{"type":"string"},"integration":{"type":"string"},"level":{"type":"string"},"uid":{"type":"integer","format":"int32"},"opted":{"type":"boolean"},"permissions":{"type":"array","items":{"type":"string"}},"token":{"type":"string"},"code":{"type":"string"},"name":{"type":"string"},"data":{"$ref":"#/components/schemas/StoreData"}}},"Metum":{"type":"object","properties":{"_id":{"type":"string"},"name":{"type":"string"},"value":{"type":"string"}}},"ResponseEnvelopeListSlingshotConfigurationDetail":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time"},"status":{"type":"integer","format":"int32"},"error":{"type":"string"},"exception":{"type":"string"},"message":{"type":"string"},"total_time_taken_in_millis":{"type":"integer","format":"int64"},"http_status":{"type":"string","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]},"items":{"type":"array","items":{"$ref":"#/components/schemas/SlingshotConfigurationDetail"}},"payload":{"type":"array","items":{"$ref":"#/components/schemas/SlingshotConfigurationDetail"}},"trace_id":{"type":"string"},"page":{"$ref":"#/components/schemas/Page"}}},"SlingshotConfigurationDetail":{"type":"object","properties":{"integration":{"$ref":"#/components/schemas/SlingshotIntegration"},"companies":{"type":"array","items":{"$ref":"#/components/schemas/GCompany"}}}},"SlingshotIntegration":{"type":"object","properties":{"_id":{"type":"string"},"description":{"type":"string"},"name":{"type":"string"},"slug":{"type":"string"},"meta":{"type":"array","items":{"$ref":"#/components/schemas/Metum"}}}},"StoreData":{"type":"object","properties":{"location_id":{"type":"string"}}},"AWSS3config":{"type":"object","properties":{"bucket":{"type":"string"},"region":{"type":"string"},"dir":{"type":"string"},"access_key":{"type":"string"},"secret_key":{"type":"string"},"local_file_path":{"type":"string"},"archive_path":{"type":"string"},"archive":{"type":"boolean"},"delete":{"type":"boolean"},"unzip":{"type":"boolean"},"zip_format":{"type":"string"},"file_regex":{"type":"string"},"archive_config":{"$ref":"#/components/schemas/ArchiveConfig"}}},"ArchiveConfig":{"type":"object","properties":{"delete":{"type":"boolean"},"archive":{"type":"boolean"},"archive_dir":{"type":"string"}}},"Audit":{"type":"object","properties":{"created_by":{"type":"string"},"modified_by":{"type":"string"},"created_on":{"type":"string"},"modified_on":{"type":"string"}}},"CatalogMasterConfig":{"type":"object","properties":{"source_slug":{"type":"string"}}},"CompanyConfig":{"type":"object","properties":{"rule_ids":{"type":"array","items":{"type":"string"}},"sort":{"type":"array","items":{"type":"string","enum":["fastest"]}},"logistics_as_actual":{"type":"boolean"}},"required":["rule_ids","sort"]},"DBConfig":{"type":"object","properties":{"vendor":{"type":"string"},"host":{"type":"string"},"port":{"type":"integer","format":"int32"},"username":{"type":"string"},"password":{"type":"string"},"dbname":{"type":"string"},"query":{"type":"string"},"procedure":{"type":"boolean"},"driver_class":{"type":"string"},"jdbc_url":{"type":"string"},"optional_properties":{"type":"object","additionalProperties":{"type":"string"}}}},"DBConnectionProfile":{"type":"object","properties":{"inventory":{"type":"string"}}},"DBParamConfig":{"type":"object","properties":{"params":{"type":"object","additionalProperties":{"type":"object"}}}},"DefaultHeadersDTO":{"type":"object","properties":{"store":{"$ref":"#/components/schemas/PropBeanDTO"},"intf_article_id":{"$ref":"#/components/schemas/PropBeanDTO"},"price_effective":{"$ref":"#/components/schemas/PropBeanDTO"},"quantity":{"$ref":"#/components/schemas/PropBeanDTO"}}},"DocMappingConfig":{"type":"object","properties":{"properties":{"type":"object","additionalProperties":{"type":"object"}},"junk_data_threshold_count":{"type":"integer","format":"int32"},"prop_bean_configs":{"type":"array","items":{"$ref":"#/components/schemas/PropBeanConfig"}},"unwind_field":{"type":"string"},"default_headers":{"$ref":"#/components/schemas/DefaultHeadersDTO"}}},"EmailConfig":{"type":"object","properties":{"recepient":{"type":"string"},"host":{"type":"string"},"username":{"type":"string"},"password":{"type":"string"},"unzip":{"type":"boolean"},"read_from_content":{"type":"boolean"},"filter_based_on_recepients":{"type":"boolean"},"pcol":{"type":"string"},"subject_line_regex":{"type":"string"},"sender_address":{"type":"string"},"local_dir":{"type":"string"},"folder_name_hierarchies":{"type":"array","items":{"type":"string"}},"attachment_regex":{"type":"string"},"body_content_regex":{"type":"string"},"password_protected":{"type":"boolean"},"zip_format":{"type":"string"},"attachment_mandate":{"type":"boolean"},"filter_files_after_extraction":{"type":"boolean"},"archive_config":{"$ref":"#/components/schemas/ArchiveConfig"},"read_all_unread_mails":{"type":"boolean"},"content_type":{"type":"string"},"downloadable_link":{"type":"boolean"},"properties":{"type":"object","additionalProperties":{"type":"string"}}}},"FTPConfig":{"type":"object","properties":{"host":{"type":"string"},"port":{"type":"integer","format":"int32"},"username":{"type":"string"},"password":{"type":"string"},"unzip":{"type":"boolean"},"retries":{"type":"integer","format":"int32"},"interval":{"type":"integer","format":"int64"},"local_dir":{"type":"string"},"remote_dir":{"type":"string"},"zip_file_regex":{"type":"string"},"archive_config":{"$ref":"#/components/schemas/ArchiveConfig"},"file_regex":{"type":"string"},"zip_format":{"type":"string"},"read_all_files":{"type":"boolean"}}},"FileConfig":{"type":"object","properties":{"delimiter":{"type":"string"},"charset":{"type":"string"},"properties":{"type":"object","additionalProperties":{"type":"object"}},"file_has_header":{"type":"boolean"},"header_index":{"type":"integer","format":"int32"},"header_array":{"type":"array","items":{"type":"string"}},"data_start_index":{"type":"integer","format":"int32"},"prop_bean_configs":{"type":"array","items":{"$ref":"#/components/schemas/PropBeanConfig"}},"junk_data_threshold_count":{"type":"integer","format":"int32"},"file_type":{"type":"string","enum":["EXCEL","CSV","XML","TEXT_RESTLESS","GOOGLE_SPREADSHEET","HTML","TEXT"]},"line_validity_check":{"type":"boolean"},"sheet_names":{"type":"array","items":{"type":"string"}},"read_all_sheets":{"type":"boolean"},"quote_char":{"type":"string"},"escape_char":{"type":"string"},"default_headers":{"$ref":"#/components/schemas/DefaultHeadersDTO"}}},"GoogleSpreadSheetConfig":{"type":"object","properties":{"range":{"type":"string"},"sheet_id":{"type":"string"},"client_secret_location":{"type":"string"},"cred_storage_directory":{"type":"string"},"local_dir":{"type":"string"},"archive_config":{"$ref":"#/components/schemas/ArchiveConfig"}}},"HttpConfig":{"type":"object","properties":{"hosturl":{"type":"string"},"username":{"type":"string"},"password":{"type":"string"},"request_params":{"type":"object","additionalProperties":{"type":"string"}},"http_method":{"type":"string"},"request_payload":{"type":"string"},"local_path":{"type":"string"},"archive_config":{"$ref":"#/components/schemas/ArchiveConfig"}}},"JobConfig":{"type":"object","properties":{"_id":{"type":"integer","format":"int32"},"job_code":{"type":"string"},"task_type":{"type":"string","enum":["FILE","SFTP","S3","EMAIL","WEBSERVICE","MONGODB","ONOMIK","GOOGLE_SPREADSHEET","WEBLINK","DEXI","WEBHOOK"]},"sync_delay":{"type":"integer","format":"int32"},"cron_expression":{"type":"string"},"store_filter":{"$ref":"#/components/schemas/StoreFilter"},"process_config":{"$ref":"#/components/schemas/ProcessConfig"},"store_config":{"type":"array","items":{"$ref":"#/components/schemas/StoreConfig"}},"properties":{"type":"object","additionalProperties":{"type":"string"}},"immediate_first_run":{"type":"boolean"},"disable":{"type":"boolean"},"dependent_job_codes":{"type":"array","items":{"type":"string"}},"company_config":{"type":"array","items":{"$ref":"#/components/schemas/CompanyConfig"}},"company_ids":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"tax_identifiers":{"type":"array","items":{"type":"string"}},"priority":{"type":"string","enum":["low","high"]},"period_threshold":{"type":"integer","format":"int32"},"period_threshold_type":{"type":"string","enum":["DAYS","HOURS","WEEKS","MONTHS"]},"db_connection_profile":{"$ref":"#/components/schemas/DBConnectionProfile"},"params":{"type":"object","additionalProperties":{"type":"object"}},"open_tags":{"type":"object","additionalProperties":{"type":"object"}},"delete_quantity_threshold":{"type":"integer","format":"int32"},"catalog_master_config":{"$ref":"#/components/schemas/CatalogMasterConfig"},"aggregator_types":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"integration_type":{"type":"string"},"min_price":{"type":"number","format":"double"},"audit":{"$ref":"#/components/schemas/Audit"},"version":{"type":"integer","format":"int32","readOnly":true},"alias":{"type":"string"}}},"JobConfigRawDTO":{"required":["company_id","company_name","integration"],"type":"object","properties":{"company_name":{"type":"string"},"integration":{"type":"string","writeOnly":true},"company_id":{"type":"integer","format":"int32"},"data":{"$ref":"#/components/schemas/JobConfig"}}},"JsonDocConfig":{"type":"object","properties":{"prop_bean_configs":{"type":"array","items":{"$ref":"#/components/schemas/PropBeanConfig"}}}},"LocalFileConfig":{"type":"object","properties":{"retries":{"type":"integer","format":"int32"},"interval":{"type":"integer","format":"int64"},"local_dir":{"type":"string"},"working_dir":{"type":"string"},"unzip":{"type":"boolean"},"zip_file_regex":{"type":"string"},"file_regex":{"type":"string"},"zip_format":{"type":"string"},"archive_config":{"$ref":"#/components/schemas/ArchiveConfig"},"read_all_files":{"type":"boolean"}}},"MongoDocConfig":{"type":"object","properties":{"collection_name":{"type":"string"},"find_query":{"type":"object","additionalProperties":{"type":"object"}},"projection_query":{"type":"object","additionalProperties":{"type":"object"}},"prop_bean_configs":{"type":"array","items":{"$ref":"#/components/schemas/PropBeanConfig"}},"aggregate_pipeline":{"type":"array","items":{"type":"object","additionalProperties":{"type":"object"}}},"skip_save":{"type":"boolean"}}},"OAuthConfig":{"type":"object","properties":{"limit":{"type":"integer","format":"int32"},"pages":{"type":"integer","format":"int32"},"interval":{"type":"integer","format":"int64"},"consumer_key":{"type":"string"},"consumer_secret":{"type":"string"},"token":{"type":"string"},"token_secret":{"type":"string"},"rest_url":{"type":"string"},"rest_base_url":{"type":"string"},"function_name":{"type":"string"}}},"ProcessConfig":{"type":"object","properties":{"db_config":{"$ref":"#/components/schemas/DBConfig"},"db_param_config":{"$ref":"#/components/schemas/DBParamConfig"},"sftp_config":{"$ref":"#/components/schemas/SFTPConfig"},"aws_s3_config":{"$ref":"#/components/schemas/AWSS3config"},"mongo_doc_config":{"$ref":"#/components/schemas/MongoDocConfig"},"ftp_config":{"$ref":"#/components/schemas/FTPConfig"},"email_config":{"$ref":"#/components/schemas/EmailConfig"},"file_config":{"$ref":"#/components/schemas/FileConfig"},"json_doc_config":{"$ref":"#/components/schemas/JsonDocConfig"},"doc_mapping_config":{"$ref":"#/components/schemas/DocMappingConfig"},"task_step_config":{"$ref":"#/components/schemas/TaskStepConfig"},"http_config":{"$ref":"#/components/schemas/HttpConfig"},"local_file_config":{"$ref":"#/components/schemas/LocalFileConfig"},"oauth_config":{"$ref":"#/components/schemas/OAuthConfig"},"google_spreadsheet_config":{"$ref":"#/components/schemas/GoogleSpreadSheetConfig"}}},"PropBeanConfig":{"type":"object","properties":{"required":{"type":"boolean"},"optional":{"type":"boolean"},"send":{"$ref":"#/components/schemas/Send"},"validations":{"type":"array","items":{"type":"object","additionalProperties":{"type":"object"}}},"values":{"type":"array","items":{"type":"string"}},"include":{"type":"boolean"},"source_field":{"type":"string"},"source_fields":{"type":"array","items":{"type":"string"}},"destination_field":{"type":"string"},"data_type":{"type":"string","enum":["OBJECT","STRING","INTEGER","DOUBLE","LONG","FLOAT","DATE","BOOLEAN"]},"default_value":{"type":"object"},"const_value":{"type":"object"},"concat_str":{"type":"string"},"function_name":{"type":"string"},"transformer_name":{"type":"string"},"all_param_function_name":{"type":"string"},"sub_separator":{"type":"string"},"index_field":{"type":"string"},"ignore_if_not_exists":{"type":"boolean"},"identifier_type":{"type":"string","enum":["sku_code","ean","upc","alu","gtin","barcode"]},"projection_query":{"type":"object","additionalProperties":{"type":"object"}},"enrich_from_master":{"type":"boolean"}}},"PropBeanDTO":{"type":"object","properties":{"required":{"type":"boolean"},"optional":{"type":"boolean"},"include":{"type":"boolean"},"source_field":{"type":"string"},"source_fields":{"type":"array","items":{"type":"string"}},"destination_field":{"type":"string"},"data_type":{"type":"string","enum":["OBJECT","STRING","INTEGER","DOUBLE","LONG","FLOAT","DATE","BOOLEAN"]},"default_value":{"type":"object"},"const_value":{"type":"object"},"concat_str":{"type":"string"},"function_name":{"type":"string"},"transformer_name":{"type":"string"},"all_param_function_name":{"type":"string"},"sub_separator":{"type":"string"},"index_field":{"type":"string"},"ignore_if_not_exists":{"type":"boolean"},"identifier_type":{"type":"string","enum":["sku_code","ean","upc","alu","gtin","barcode"]},"projection_query":{"type":"object","additionalProperties":{"type":"object"}},"enrich_from_master":{"type":"boolean"}}},"ResponseEnvelopeListJobConfigRawDTO":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time"},"status":{"type":"integer","format":"int32"},"error":{"type":"string"},"exception":{"type":"string"},"message":{"type":"string"},"total_time_taken_in_millis":{"type":"integer","format":"int64"},"http_status":{"type":"string","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]},"items":{"type":"array","items":{"$ref":"#/components/schemas/JobConfigRawDTO"}},"payload":{"type":"array","items":{"$ref":"#/components/schemas/JobConfigRawDTO"}},"trace_id":{"type":"string"},"page":{"$ref":"#/components/schemas/Page"}}},"SFTPConfig":{"type":"object","properties":{"host":{"type":"string"},"port":{"type":"integer","format":"int32"},"username":{"type":"string"},"password":{"type":"string"},"unzip":{"type":"boolean"},"retries":{"type":"integer","format":"int32"},"interval":{"type":"integer","format":"int64"},"private_key_path":{"type":"string"},"strict_host_key_checking":{"type":"boolean"},"local_dir":{"type":"string"},"remote_dir":{"type":"string"},"password_protected":{"type":"boolean"},"zip_file_regex":{"type":"string"},"file_regex":{"type":"string"},"zip_format":{"type":"string"},"archive_config":{"$ref":"#/components/schemas/ArchiveConfig"},"read_all_files":{"type":"boolean"}}},"Send":{"type":"object","properties":{"raw":{"type":"boolean"},"processed":{"type":"boolean"}}},"StoreConfig":{"type":"object","properties":{"job_code":{"type":"string"},"storeid":{"type":"string"},"store_alias":{"type":"string"},"store_file_regex":{"type":"string"},"store_file_name":{"type":"string"},"process_config":{"$ref":"#/components/schemas/ProcessConfig"},"properties":{"type":"object","additionalProperties":{"type":"string"}}}},"StoreFilter":{"type":"object","properties":{"include_tags":{"type":"array","items":{"type":"string"}},"exclude_tags":{"type":"array","items":{"type":"string"}},"query":{"type":"object","additionalProperties":{"type":"object"}}}},"TaskConfig":{"type":"object","properties":{"name":{"type":"string"},"task_config_id":{"type":"integer","format":"int32"},"task_params":{"type":"array","items":{"$ref":"#/components/schemas/TaskParam"}}}},"TaskParam":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"object"}}},"TaskStepConfig":{"type":"object","properties":{"task_configs":{"type":"array","items":{"$ref":"#/components/schemas/TaskConfig"}},"task_config_ids":{"type":"array","items":{"type":"integer","format":"int32"}},"task_config_group_ids":{"type":"array","items":{"type":"integer","format":"int32"}}}},"JobStepsDTO":{"type":"object","properties":{"step_name":{"type":"string"},"type":{"type":"string"},"step_execution_time":{"type":"integer","format":"int64"},"start_count":{"type":"integer","format":"int32"},"end_count":{"type":"integer","format":"int32"},"deleted_count":{"type":"integer","format":"int32"},"processed_start_time":{"type":"string"},"processed_at":{"type":"string"}}},"ResponseEnvelopeListJobStepsDTO":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time"},"status":{"type":"integer","format":"int32"},"error":{"type":"string"},"exception":{"type":"string"},"message":{"type":"string"},"total_time_taken_in_millis":{"type":"integer","format":"int64"},"http_status":{"type":"string","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]},"items":{"type":"array","items":{"$ref":"#/components/schemas/JobStepsDTO"}},"payload":{"type":"array","items":{"$ref":"#/components/schemas/JobStepsDTO"}},"trace_id":{"type":"string"},"page":{"$ref":"#/components/schemas/Page"}}},"ResponseEnvelopeListJobConfigDTO":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time"},"status":{"type":"integer","format":"int32"},"error":{"type":"string"},"exception":{"type":"string"},"message":{"type":"string"},"total_time_taken_in_millis":{"type":"integer","format":"int64"},"http_status":{"type":"string","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]},"items":{"type":"array","items":{"$ref":"#/components/schemas/JobConfigDTO"}},"payload":{"type":"array","items":{"$ref":"#/components/schemas/JobConfigDTO"}},"trace_id":{"type":"string"},"page":{"$ref":"#/components/schemas/Page"}}},"ResponseEnvelopeJobConfigDTO":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time"},"status":{"type":"integer","format":"int32"},"error":{"type":"string"},"exception":{"type":"string"},"message":{"type":"string"},"total_time_taken_in_millis":{"type":"integer","format":"int64"},"http_status":{"type":"string","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]},"items":{"$ref":"#/components/schemas/JobConfigDTO"},"payload":{"$ref":"#/components/schemas/JobConfigDTO"},"trace_id":{"type":"string"},"page":{"$ref":"#/components/schemas/Page"}}},"JobHistoryDto":{"type":"object","properties":{"total_added_count":{"type":"integer","format":"int64"},"total_updated_count":{"type":"integer","format":"int64"},"total_suppressed_count":{"type":"integer","format":"int64"},"total_initial_count":{"type":"integer","format":"int64"},"job_id":{"type":"integer","format":"int64"},"status":{"type":"string"},"job_code":{"type":"string"},"processed_on":{"type":"string"},"filename":{"type":"array","items":{"type":"string"}},"error_type":{"type":"string"},"message":{"type":"string"}}},"JobMetricsDto":{"type":"object","properties":{"job_code":{"type":"string"},"is_run_more_than_usual":{"type":"string"},"job_history":{"type":"array","items":{"$ref":"#/components/schemas/JobHistoryDto"}},"total_success_count":{"type":"integer","format":"int64"},"total_failure_count":{"type":"integer","format":"int64"},"total_warning_count":{"type":"integer","format":"int64"},"total_suppressed_count":{"type":"integer","format":"int64"},"total_job_runs":{"type":"integer","format":"int64"}}},"ResponseEnvelopeJobMetricsDto":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time"},"status":{"type":"integer","format":"int32"},"error":{"type":"string"},"exception":{"type":"string"},"message":{"type":"string"},"total_time_taken_in_millis":{"type":"integer","format":"int64"},"http_status":{"type":"string","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]},"items":{"$ref":"#/components/schemas/JobMetricsDto"},"payload":{"$ref":"#/components/schemas/JobMetricsDto"},"trace_id":{"type":"string"},"page":{"$ref":"#/components/schemas/Page"}}},"JobConfigListDTO":{"type":"object","properties":{"code":{"type":"string"},"alias":{"type":"string"},"modified_by":{"type":"string"},"created_by":{"type":"string"},"modified_on":{"type":"string","format":"date-time"},"created_on":{"type":"string","format":"date-time"},"active":{"type":"boolean"},"type":{"type":"string"}}},"ResponseEnvelopeListJobConfigListDTO":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time"},"status":{"type":"integer","format":"int32"},"error":{"type":"string"},"exception":{"type":"string"},"message":{"type":"string"},"total_time_taken_in_millis":{"type":"integer","format":"int64"},"http_status":{"type":"string","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]},"items":{"type":"array","items":{"$ref":"#/components/schemas/JobConfigListDTO"}},"payload":{"type":"array","items":{"$ref":"#/components/schemas/JobConfigListDTO"}},"trace_id":{"type":"string"},"page":{"$ref":"#/components/schemas/Page"}}},"TicketList":{"properties":{"items":{"description":"List of tickets","type":"array","items":{"$ref":"#/components/schemas/Ticket"}},"filters":{"$ref":"#/components/schemas/Filter"},"page":{"$ref":"#/components/schemas/Page"}},"required":[]},"PriorityEnum":{"type":"string","description":"Key for priority","enum":[{"name":"low","value":"low","description":"This means ticket is low priority"},{"name":"medium","value":"medium","description":"This means ticket is medium priority"},{"name":"high","value":"high","description":"This means ticket is high priority"},{"name":"urgent","value":"urgent","description":"This means ticket is of urgent priority"}]},"HistoryTypeEnum":{"description":"Type of history event","type":"string","enum":[{"name":"rating","value":"rating","description":"This means history event is a rating"},{"name":"log","value":"log","description":"This means history event is a changelog"},{"name":"comment","value":"comment","description":"This means history event is a comment"},{"name":"thread","value":"thread","description":"This means history event is a thread"}]},"TicketHistoryList":{"properties":{"items":{"description":"List of ticket history","type":"array","items":{"$ref":"#/components/schemas/TicketHistory"}},"page":{"$ref":"#/components/schemas/Page"}}},"CustomFormList":{"properties":{"items":{"description":"List of forms","type":"array","items":{"$ref":"#/components/schemas/CustomForm"}},"page":{"$ref":"#/components/schemas/Page"}}},"CreateCustomFormPayload":{"required":["slug","title","inputs","priority"],"properties":{"slug":{"type":"string","description":"Slug for the form"},"title":{"type":"string","description":"Title for the form"},"inputs":{"description":"List of all the form components","type":"array","items":{"type":"object"}},"description":{"type":"string","description":"Description of the form"},"header_image":{"type":"string","description":"Header image that is to be shown for the form"},"priority":{"$ref":"#/components/schemas/PriorityEnum"},"should_notify":{"type":"boolean","default":false,"description":"Indicates if staff should be notified when a response is received"},"success_message":{"type":"string","description":"Success message that will be shown on submission"},"poll_for_assignment":{"$ref":"#/components/schemas/PollForAssignment"}}},"EditCustomFormPayload":{"required":["title","inputs","priority"],"properties":{"title":{"type":"string","description":"Title for the form"},"inputs":{"description":"List of all the form components","type":"array","items":{"type":"object"}},"description":{"type":"string","description":"Description of the form"},"priority":{"$ref":"#/components/schemas/PriorityEnum"},"header_image":{"type":"string","description":"Header image that is to be shown for the form"},"should_notify":{"type":"boolean","description":"Indicates if staff should be notified when a response is received"},"login_required":{"type":"boolean","description":"Denotes if login is required to make a form response submission"},"success_message":{"type":"string","description":"Success message that will be shown on submission"},"poll_for_assignment":{"$ref":"#/components/schemas/PollForAssignment"}}},"EditTicketPayload":{"properties":{"content":{"$ref":"#/components/schemas/TicketContent"},"category":{"type":"string","description":"Category assigned to the ticket"},"sub_category":{"type":"string","description":"Sub-category assigned to the ticket"},"source":{"type":"string","description":"Denotes if the ticket was created at company or application level","enum":["platform_panel","sales_channel"]},"status":{"type":"string","description":"Denotes in what state is the ticket"},"priority":{"$ref":"#/components/schemas/PriorityEnum"},"assigned_to":{"$ref":"#/components/schemas/AgentChangePayload"},"tags":{"type":"array","description":"Tags relevant to ticket","items":{"type":"string"}}}},"AgentChangePayload":{"description":"Details of support staff to whom ticket is assigned","required":["agent_id"],"properties":{"agent_id":{"type":"string","description":"Agent's unique ID"}}},"CreateVideoRoomResponse":{"required":["unique_name"],"properties":{"unique_name":{"type":"string","description":"Video Room's unique name"}}},"CloseVideoRoomResponse":{"required":["success"],"properties":{"success":{"type":"boolean","description":"Denotes if operation was successfully"}}},"CreateVideoRoomPayload":{"required":["unique_name"],"properties":{"unique_name":{"type":"string","description":"Ticket id"},"notify":{"type":"array","items":{"$ref":"#/components/schemas/NotifyUser"},"description":"List of people to be notified"}}},"NotifyUser":{"required":["country_code","phone_number"],"properties":{"country_code":{"type":"string","description":"Country code"},"phone_number":{"type":"string","description":"Phone number"}}},"Filter":{"description":"All the filters available for tickets","required":["priorities","statuses","assignees"],"properties":{"priorities":{"type":"array","description":"List of possible priorities for tickets","items":{"$ref":"#/components/schemas/Priority"}},"categories":{"type":"array","description":"List of possible categories for tickets","items":{"$ref":"#/components/schemas/TicketCategory"}},"statuses":{"type":"array","description":"List of possible statuses for tickets","items":{"$ref":"#/components/schemas/Status"}},"assignees":{"type":"array","description":"List of support staff availble for tickets assignment","items":{"type":"object"}}}},"TicketHistoryPayload":{"required":["value","type"],"properties":{"value":{"type":"object","description":"Details of history event"},"type":{"$ref":"#/components/schemas/HistoryTypeEnum"}}},"GetTokenForVideoRoomResponse":{"required":["access_token"],"properties":{"access_token":{"type":"string","description":"Access token to be used for video room"}}},"GetParticipantsInsideVideoRoomResponse":{"required":["participants"],"properties":{"participants":{"type":"array","description":"List of participants of the video room","items":{"$ref":"#/components/schemas/Participant"}}}},"Participant":{"properties":{"user":{"$ref":"#/components/schemas/UserSchema"},"identity":{"type":"string","description":"Unique identifier of participant"},"status":{"type":"string","description":"Status of participant"}}},"UserSchema":{"type":"object","properties":{"application_id":{"type":"string"},"user_id":{"type":"string"},"first_name":{"type":"string"},"meta":{"type":"object","properties":{}},"last_name":{"type":"string"},"phone_numbers":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumber"}},"emails":{"type":"array","items":{"$ref":"#/components/schemas/Email"}},"gender":{"type":"string"},"dob":{"type":"string"},"active":{"type":"boolean"},"profile_pic_url":{"type":"string"},"username":{"type":"string"},"account_type":{"type":"string"},"_id":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"external_id":{"type":"string"}}},"PhoneNumber":{"type":"object","properties":{"active":{"type":"boolean"},"primary":{"type":"boolean"},"verified":{"type":"boolean"},"phone":{"type":"string"},"country_code":{"type":"integer"}}},"Email":{"type":"object","properties":{"primary":{"type":"boolean"},"verified":{"type":"boolean"},"email":{"type":"string"},"active":{"type":"boolean"}}},"Debug":{"type":"object","description":"Used for debugging","properties":{"source":{"type":"string","description":"Source of user"},"platform":{"type":"string","description":"Platform of user"}}},"TicketContext":{"required":["company_id"],"properties":{"application_id":{"type":"string","description":"Application ID related to the ticket"},"company_id":{"type":"string","description":"Company ID related to the ticket"}}},"CreatedOn":{"description":"Gives details of when the form was created","required":["user_agent"],"properties":{"user_agent":{"type":"string","description":"Useragent details"}}},"TicketAsset":{"required":["value","type"],"properties":{"display":{"type":"string","description":"Display text for asset"},"value":{"type":"string","description":"To be used for details"},"type":{"$ref":"#/components/schemas/TicketAssetTypeEnum"}}},"TicketAssetTypeEnum":{"type":"string","enum":[{"name":"image","value":"image","description":"Denotes asset is of image type"},{"name":"video","value":"video","description":"Denotes asset is of video type"},{"name":"file","value":"file","description":"Denotes asset is of file type"},{"name":"youtube","value":"youtube","description":"Denotes asset is an youtube link"},{"name":"product","value":"product","description":"Denotes asset is of product type"},{"name":"collection","value":"collection","description":"Denotes asset is of collection type"},{"name":"brand","value":"brand","description":"Denotes asset is of brand type"},{"name":"shipment","value":"shipment","description":"Denotes asset is of shipment type"},{"name":"order","value":"order","description":"Denotes asset is of order type"}]},"TicketContent":{"description":"Ticket conetent details","required":["title"],"properties":{"title":{"type":"string","description":"Title for ticket"},"description":{"type":"string","format":"base64","description":"Long description of issue"},"attachments":{"type":"array","description":"List of all attachments related to the ticket","items":{"$ref":"#/components/schemas/TicketAsset"}}}},"AddTicketPayload":{"required":["category","content"],"properties":{"created_by":{"type":"object","description":"Creator of the ticket"},"status":{"type":"string","description":"Status of the ticket"},"priority":{"$ref":"#/components/schemas/PriorityEnum"},"category":{"type":"string","description":"Category of the ticket"},"content":{"$ref":"#/components/schemas/TicketContent"},"_custom_json":{"type":"object","description":"optional custom data that needs to be sent"}}},"Priority":{"required":["key","display","color"],"properties":{"key":{"$ref":"#/components/schemas/PriorityEnum"},"display":{"type":"string","description":"Display text for priority"},"color":{"type":"string","description":"Color for priority"}}},"Status":{"required":["key","display","color"],"properties":{"key":{"type":"string","description":"Key for status"},"display":{"type":"string","description":"Display text for status"},"color":{"type":"string","description":"Color for status"}}},"TicketFeedbackList":{"properties":{"items":{"type":"array","description":"List of all ticket feedback for the ticket","items":{"$ref":"#/components/schemas/TicketFeedback"}}}},"TicketFeedbackPayload":{"properties":{"form_response":{"type":"object","description":"Key-value pairs of all the form fields and their response"}}},"SubmitButton":{"description":"Details for submit button","required":["title","title_color","background_color"],"properties":{"title":{"type":"string","description":"Title for submit button"},"title_color":{"type":"string","description":"Title color submit button"},"background_color":{"type":"string","description":"Color for submit button"}}},"PollForAssignment":{"description":"Describes how polling will be done for the tickets createds","required":["duration","message","success_message","failure_message"],"properties":{"duration":{"type":"number","description":"Duration for polling of staff"},"message":{"type":"string","description":"Message for polling"},"success_message":{"type":"string","description":"Message for successful polling"},"failure_message":{"type":"string","description":"Message if polling failed"}}},"CustomForm":{"required":["application_id","slug","title","priority","login_required","should_notify","_id","inputs"],"properties":{"application_id":{"type":"string","description":"Application ID for form"},"slug":{"type":"string","description":"Slug for the form, which is to be used for accessing the form"},"header_image":{"type":"string","description":"Form header image that will be shown to the user"},"title":{"type":"string","description":"Form title that will be shown to the user"},"description":{"type":"string","description":"Form description that will be shown to the user"},"priority":{"$ref":"#/components/schemas/Priority"},"login_required":{"type":"boolean","default":false,"description":"Denotes if login is required to make a form response submission"},"should_notify":{"type":"boolean","default":false,"description":"Denotes if new response submission for the form should be notified to the assignees"},"success_message":{"type":"string","description":"Message that is to be shown on succesfull form response submission"},"submit_button":{"$ref":"#/components/schemas/SubmitButton"},"inputs":{"type":"array","items":{"type":"object"},"description":"List of all the form fields"},"created_on":{"$ref":"#/components/schemas/CreatedOn"},"poll_for_assignment":{"$ref":"#/components/schemas/PollForAssignment"},"_id":{"type":"string","description":"Unique identifier for the form"}}},"FeedbackForm":{"description":"Support category array list details","properties":{"inputs":{"type":"object","description":"Input details for the feed back form"},"title":{"type":"string","description":"Title for the feed back form"},"timestamps":{"type":"object","description":"Gives details of category releted data"}}},"TicketCategory":{"description":"Support category array list details","required":["key","display"],"properties":{"display":{"type":"string","description":"Category display value identifier"},"key":{"type":"string","description":"Category key value identifier"},"sub_categories":{"$ref":"#/components/schemas/TicketCategory"},"group_id":{"type":"number","description":"Group id of category releted data"},"feedback_form":{"$ref":"#/components/schemas/FeedbackForm"}}},"FeedbackResponseItem":{"required":["display","key","value"],"properties":{"display":{"type":"string","description":"Question/Title of the form field"},"key":{"type":"string","description":"Key of the form field"},"value":{"type":"string","description":"User response value for the form field"}}},"TicketFeedback":{"required":["_id","ticket_id","response","company_id"],"properties":{"_id":{"type":"string","description":"Unique identifier for the feedback"},"ticket_id":{"type":"string","description":"Readable ticket number"},"company_id":{"type":"string","description":"Company id for which ticket was raised"},"response":{"type":"array","items":{"$ref":"#/components/schemas/FeedbackResponseItem"}},"category":{"type":"string","description":"Category of the ticket"},"user":{"type":"object","description":"User who submitted the feedback"},"updated_at":{"type":"string","format":"date-time","description":"Time when the feedback was last updated"},"created_at":{"type":"string","format":"date-time","description":"Time when the feedback was created"}}},"TicketHistory":{"required":["type","value","ticket_id","_id"],"properties":{"type":{"type":"string","description":"Type of the history event"},"value":{"type":"object","description":"Data of the history event"},"ticket_id":{"type":"string","description":"Readable ticket number"},"created_on":{"$ref":"#/components/schemas/CreatedOn"},"created_by":{"type":"object","description":"User who created the history event"},"_id":{"type":"string","description":"Unique identifier of the history event"},"updated_at":{"type":"string","format":"date-time","description":"Time of last update of the history event"},"created_at":{"type":"string","format":"date-time","description":"Time of creation of the history event"}}},"Ticket":{"required":["category","source","status","priority","_id"],"properties":{"context":{"$ref":"#/components/schemas/TicketContext"},"created_on":{"$ref":"#/components/schemas/CreatedOn"},"response_id":{"type":"string","description":"Details of company and application realated to the ticket"},"content":{"$ref":"#/components/schemas/TicketContent"},"category":{"$ref":"#/components/schemas/TicketCategory"},"sub_category":{"type":"string","description":"Sub-category assigned to the ticket"},"source":{"$ref":"#/components/schemas/TicketSourceEnum"},"status":{"$ref":"#/components/schemas/Status"},"priority":{"$ref":"#/components/schemas/Priority"},"created_by":{"type":"object","description":"User details of ticket creator"},"assigned_to":{"type":"object","description":"Details of support staff to whom ticket is assigned"},"tags":{"type":"array","items":{"type":"string"},"description":"Tags relevant to ticket"},"_custom_json":{"type":"object","description":"custom json relevant to the ticket"},"is_feedback_pending":{"type":"boolean","description":"Denotes if feedback submission is pending for the ticket"},"integration":{"type":"object","description":"Integration type and its details of the ticket"},"_id":{"type":"string","description":"Unique identifier for the ticket"},"updated_at":{"type":"string","format":"date-time","description":"Time when the ticket was last updated"},"created_at":{"type":"string","format":"date-time","description":"Time when the ticket was created"}}},"TicketSourceEnum":{"type":"string","enum":[{"name":"platformPanel","value":"platform_panel","description":"This means it is company level ticket"},{"name":"salesChannel","value":"sales_channel","description":"This means it is a application/sales channel level ticket"}]},"ErrorMessage":{"properties":{"message":{"type":"string"}}},"UpdateZoneConfigRequest":{"type":"object","properties":{"serviceability_type":{"type":"string"}}},"ServiceabilityErrorResponse":{"type":"object","properties":{"message":{"type":"string"},"value":{"type":"string"},"type":{"type":"string"}},"required":["message","type","value"]},"ApplicationServiceabilityConfig":{"type":"object","properties":{"channel_id":{"type":"string"},"serviceability_type":{"type":"string"},"channel_type":{"type":"string"}},"required":["channel_id","channel_type","serviceability_type"]},"ApplicationServiceabilityConfigResponse":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/ServiceabilityErrorResponse"},"data":{"$ref":"#/components/schemas/ApplicationServiceabilityConfig"},"success":{"type":"boolean"}},"required":["success"]},"EntityRegionView_Request":{"type":"object","properties":{"sub_type":{"type":"array","items":{"type":"string"}},"parent_id":{"type":"array","items":{"type":"string"}}},"required":["sub_type"]},"EntityRegionView_Error":{"type":"object","properties":{"message":{"type":"string"},"value":{"type":"string"},"type":{"type":"string"}}},"EntityRegionView_page":{"type":"object","properties":{"type":{"type":"string"},"has_next":{"type":"boolean"},"item_total":{"type":"integer"},"size":{"type":"integer"},"current":{"type":"integer"}},"required":["current","has_next","item_total","size","type"]},"getAppRegionZonesResponse":{"type":"object","properties":{"page":{"type":"array","items":{"$ref":"#/components/schemas/PageSchema"}},"items":{"type":"array","items":{"$ref":"#/components/schemas/ListViewItems"}}},"required":["items","page"]},"EntityRegionView_Items":{"type":"object","properties":{"sub_type":{"type":"string"},"uid":{"type":"string"},"name":{"type":"string"}},"required":["name","sub_type","uid"]},"EntityRegionView_Response":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/EntityRegionView_Error"},"page":{"$ref":"#/components/schemas/EntityRegionView_page"},"data":{"type":"array","items":{"$ref":"#/components/schemas/EntityRegionView_Items"}},"success":{"type":"boolean"}},"required":["data","error","page","success"]},"ListViewSummary":{"type":"object","properties":{"total_zones":{"type":"integer"},"total_pincodes_served":{"type":"integer"},"total_active_zones":{"type":"integer"}},"required":["total_active_zones","total_pincodes_served","total_zones"]},"ZoneDataItem":{"type":"object","properties":{"has_next":{"type":"boolean"},"item_total":{"type":"integer"},"size":{"type":"integer"},"current":{"type":"integer"},"type":{"type":"string"}},"required":["current","has_next","item_total","size","type"]},"ListViewProduct":{"type":"object","properties":{"count":{"type":"integer"},"type":{"type":"string"}},"required":["count","type"]},"ListViewChannels":{"type":"object","properties":{"channel_id":{"type":"string"},"channel_type":{"type":"string"}},"required":["channel_id","channel_type"]},"ListViewItems":{"type":"object","properties":{"zone_id":{"type":"string"},"name":{"type":"string"},"slug":{"type":"string"},"stores_count":{"type":"integer"},"is_active":{"type":"boolean"},"product":{"$ref":"#/components/schemas/ListViewProduct"},"regions_count":{"type":"integer"},"company_id":{"type":"integer"},"channels":{"$ref":"#/components/schemas/ListViewChannels"}},"required":["channels","company_id","is_active","name","regions_count","product","slug","stores_count","zone_id"]},"ListViewResponse":{"type":"object","properties":{"page":{"type":"array","items":{"$ref":"#/components/schemas/ZoneDataItem"}},"items":{"type":"array","items":{"$ref":"#/components/schemas/ListViewItems"}}},"required":["items","page","summary"]},"CompanyStoreView_PageItems":{"type":"object","properties":{"type":{"type":"string"},"has_next":{"type":"boolean"},"item_total":{"type":"integer"},"size":{"type":"integer"},"current":{"type":"integer"}},"required":["current","has_next","item_total","size","type"]},"CompanyStoreView_Response":{"type":"object","properties":{"page":{"type":"array","items":{"$ref":"#/components/schemas/CompanyStoreView_PageItems"}},"items":{"type":"array","items":{"type":"object"}}},"required":["page"]},"GetZoneDataViewChannels":{"type":"object","properties":{"channel_id":{"type":"string"},"channel_type":{"type":"string"}},"required":["channel_id","channel_type"]},"ZoneProductTypes":{"type":"object","properties":{"type":{"type":"string","enum":["all","explicit"]},"tags":{"type":"array","items":{"type":"string"}}},"required":["tags","type"]},"ZoneMappingType":{"type":"object","properties":{"country":{"type":"string"},"pincode":{"type":"array","items":{"type":"string"}},"state":{"type":"array","items":{"type":"string"}}},"required":["country"]},"UpdateZoneData":{"type":"object","properties":{"zone_id":{"type":"string"},"name":{"type":"string"},"slug":{"type":"string"},"company_id":{"type":"integer"},"is_active":{"type":"boolean"},"channels":{"type":"array","items":{"$ref":"#/components/schemas/GetZoneDataViewChannels"}},"product":{"$ref":"#/components/schemas/ZoneProductTypes"},"store_ids":{"type":"array","items":{"type":"integer"}},"region_type":{"type":"string","enum":["country-state","pincode"]},"mapping":{"type":"array","items":{"$ref":"#/components/schemas/ZoneMappingType"}},"assignment_preference":{"type":"string","default":"optimal","enum":["optimal","manual"]}},"required":["channels","company_id","is_active","mapping","name","product","region_type","slug","store_ids","zone_id"]},"ZoneUpdateRequest":{"type":"object","properties":{"identifier":{"type":"string"},"data":{"$ref":"#/components/schemas/UpdateZoneData"}},"required":["data","identifier"]},"ZoneSuccessResponse":{"type":"object","properties":{"status_code":{"type":"integer"},"success":{"type":"boolean"}},"required":["status_code","success"]},"GetZoneDataViewItems":{"type":"object","properties":{"zone_id":{"type":"string"},"name":{"type":"string"},"slug":{"type":"string"},"company_id":{"type":"integer"},"is_active":{"type":"boolean"},"channels":{"type":"array","items":{"$ref":"#/components/schemas/GetZoneDataViewChannels"}},"product":{"$ref":"#/components/schemas/ZoneProductTypes"},"store_ids":{"type":"array","items":{"type":"integer"}},"region_type":{"type":"string","enum":["country-state","pincode"]},"mapping":{"type":"array","items":{"$ref":"#/components/schemas/ZoneMappingType"}},"assignment_preference":{"type":"string","default":"optimal","enum":["optimal","manual"]},"stores_count":{"type":"integer"}},"required":["channels","is_active","mapping","name","product","slug","store_ids","stores_count","zone_id"]},"GetSingleZoneDataViewResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/GetZoneDataViewItems"}},"required":["data"]},"GetZoneByIdSchema":{"type":"object","properties":{"zone_id":{"type":"string"},"name":{"type":"string"},"slug":{"type":"string"},"company_id":{"type":"integer"},"is_active":{"type":"boolean"},"channels":{"type":"array","items":{"$ref":"#/components/schemas/GetZoneDataViewChannels"}},"product":{"$ref":"#/components/schemas/ZoneProductTypes"},"store_ids":{"type":"array","items":{"type":"integer"}},"region_type":{"type":"string","enum":["country-state","pincode"]},"mapping":{"type":"array","items":{"$ref":"#/components/schemas/ZoneMappingType"}},"assignment_preference":{"type":"string","default":"optimal","enum":["optimal","manual"]},"stores_count":{"type":"integer"}},"required":["channels","is_active","mapping","name","product","region_type","slug","store_ids","stores_count","zone_id"]},"CreateZoneData":{"type":"object","properties":{"name":{"type":"string"},"slug":{"type":"string"},"company_id":{"type":"integer"},"is_active":{"type":"boolean"},"channels":{"type":"array","items":{"$ref":"#/components/schemas/GetZoneDataViewChannels"}},"store_ids":{"type":"array","items":{"type":"integer"}},"region_type":{"type":"string","enum":["country-state","pincode"]},"mapping":{"type":"array","items":{"$ref":"#/components/schemas/ZoneMappingType"}},"assignment_preference":{"type":"string","default":"optimal","enum":["optimal","manual"]}},"required":["channels","company_id","is_active","mapping","name","product","region_type","slug","store_ids"]},"ZoneResponse":{"type":"object","properties":{"status_code":{"type":"integer"},"zone_id":{"type":"string"},"success":{"type":"boolean"}},"required":["status_code","success","zone_id"]},"GetZoneFromPincodeViewRequest":{"type":"object","properties":{"country":{"type":"string"},"pincode":{"type":"string"}},"required":["country","pincode"]},"Zone":{"type":"object","properties":{"zone_id":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"slug":{"type":"string"},"is_active":{"type":"boolean"},"store_ids":{"type":"array","items":{"type":"integer"}},"assignment_preference":{"type":"string"}},"required":["assignment_preference","is_active","name","slug","store_ids","tags","type","zone_id"]},"GetZoneFromPincodeViewResponse":{"type":"object","properties":{"serviceability_type":{"type":"string"},"zones":{"type":"array","items":{"$ref":"#/components/schemas/Zone"}}},"required":["serviceability_type","zones"]},"GetZoneFromApplicationIdViewResponse":{"type":"object","properties":{"page":{"type":"array","items":{"$ref":"#/components/schemas/ZoneDataItem"}},"items":{"type":"array","items":{"$ref":"#/components/schemas/ListViewItems"}}},"required":["items","page"]},"ServiceabilityPageResponse":{"type":"object","properties":{"type":{"type":"string"},"has_next":{"type":"boolean"},"item_total":{"type":"integer"},"size":{"type":"integer"},"current":{"type":"integer"}}},"MobileNo":{"type":"object","properties":{"number":{"type":"string"},"country_code":{"type":"integer"}}},"ManagerResponse":{"type":"object","properties":{"email":{"type":"string"},"mobile_no":{"$ref":"#/components/schemas/MobileNo"},"name":{"type":"string"}}},"ModifiedByResponse":{"type":"object","properties":{"username":{"type":"string"},"user_id":{"type":"string"}}},"IntegrationTypeResponse":{"type":"object","properties":{"inventory":{"type":"string"},"order":{"type":"string"}}},"ProductReturnConfigResponse":{"type":"object","properties":{"on_same_store":{"type":"boolean"}}},"ContactNumberResponse":{"type":"object","properties":{"number":{"type":"string"},"country_code":{"type":"integer"}}},"AddressResponse":{"type":"object","properties":{"city":{"type":"string"},"address1":{"type":"string"},"pincode":{"type":"integer"},"address2":{"type":"string"},"landmark":{"type":"string"},"state":{"type":"string"},"country":{"type":"string"},"latitude":{"type":"number"},"longitude":{"type":"number"}}},"CreatedByResponse":{"type":"object","properties":{"username":{"type":"string"},"user_id":{"type":"string"}}},"EwayBillResponse":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"EinvoiceResponse":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"GstCredentialsResponse":{"type":"object","properties":{"e_waybill":{"$ref":"#/components/schemas/EwayBillResponse"},"e_invoice":{"$ref":"#/components/schemas/EinvoiceResponse"}}},"WarningsResponse":{"type":"object","properties":{"store_address":{"type":"string"}}},"OpeningClosing":{"type":"object","properties":{"minute":{"type":"integer"},"hour":{"type":"integer"}}},"TimmingResponse":{"type":"object","properties":{"open":{"type":"boolean"},"weekday":{"type":"string"},"closing":{"$ref":"#/components/schemas/OpeningClosing"},"opening":{"$ref":"#/components/schemas/OpeningClosing"}}},"DocumentsResponse":{"type":"object","properties":{"legal_name":{"type":"string"},"value":{"type":"string"},"type":{"type":"string"},"verified":{"type":"boolean"}}},"Dp":{"type":"object","properties":{"fm_priority":{"type":"integer"},"rvp_priority":{"type":"integer"},"lm_priority":{"type":"integer"},"internal_account_id":{"type":"string"},"area_code":{"type":"integer","nullable":true},"payment_mode":{"type":"string"},"operations":{"type":"array","items":{"type":"string"}},"external_account_id":{"type":"string","nullable":true},"transport_mode":{"type":"string"},"assign_dp_from_sb":{"type":"boolean"}}},"LogisticsResponse":{"type":"object","properties":{"override":{"type":"boolean"},"dp":{"$ref":"#/components/schemas/Dp"}}},"ItemResponse":{"type":"object","properties":{"created_on":{"type":"string"},"manager":{"$ref":"#/components/schemas/ManagerResponse"},"modified_by":{"$ref":"#/components/schemas/ModifiedByResponse"},"integration_type":{"$ref":"#/components/schemas/IntegrationTypeResponse"},"verified_on":{"type":"string"},"product_return_config":{"$ref":"#/components/schemas/ProductReturnConfigResponse"},"contact_numbers":{"type":"array","items":{"$ref":"#/components/schemas/ContactNumberResponse"}},"verified_by":{"$ref":"#/components/schemas/ModifiedByResponse"},"stage":{"type":"string"},"address":{"$ref":"#/components/schemas/AddressResponse"},"modified_on":{"type":"string"},"created_by":{"$ref":"#/components/schemas/CreatedByResponse"},"gst_credentials":{"$ref":"#/components/schemas/GstCredentialsResponse"},"display_name":{"type":"string"},"company_id":{"type":"integer"},"uid":{"type":"integer"},"_custom_json":{"type":"object"},"code":{"type":"string"},"warnings":{"$ref":"#/components/schemas/WarningsResponse"},"name":{"type":"string"},"timing":{"type":"array","items":{"$ref":"#/components/schemas/TimmingResponse"}},"documents":{"type":"array","items":{"$ref":"#/components/schemas/DocumentsResponse"}},"store_type":{"type":"string"},"sub_type":{"type":"string"},"company":{"type":"integer"},"_cls":{"type":"string"},"logistics":{"$ref":"#/components/schemas/LogisticsResponse"},"notification_emails":{"type":"array","items":{"type":"string"}}}},"GetStoresViewResponse":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/ServiceabilityPageResponse"},"items":{"type":"array","items":{"$ref":"#/components/schemas/ItemResponse"}}},"required":["page"]},"ReAssignStoreRequest":{"type":"object","properties":{"to_pincode":{"type":"string"},"identifier":{"type":"string"},"configuration":{"type":"object"},"ignored_locations":{"type":"array","items":{"type":"string"}},"articles":{"type":"array","items":{"type":"object"}}},"required":["articles","configuration","identifier","ignored_locations","to_pincode"]},"ReAssignStoreResponse":{"type":"object","properties":{"to_pincode":{"type":"string"},"success":{"type":"boolean"},"error":{"type":"object"},"articles":{"type":"array","items":{"type":"object"}}},"required":["error","success","to_pincode"]},"PincodeMopData":{"type":"object","properties":{"pincodes":{"type":"array","items":{"type":"integer"}},"country":{"type":"string"},"action":{"type":"string"}},"required":["action","country","pincodes"]},"PincodeMopUpdateResponse":{"type":"object","properties":{"pincode":{"type":"integer"},"channel_id":{"type":"string"},"country":{"type":"string"},"is_active":{"type":"boolean"}},"required":["channel_id","country","is_active","pincode"]},"PincodeMOPresponse":{"type":"object","properties":{"success":{"type":"boolean"},"status_code":{"type":"integer"},"batch_id":{"type":"string"},"country":{"type":"string"},"action":{"type":"string"},"pincodes":{"type":"array","items":{"type":"integer"}},"updated_pincodes":{"type":"array","items":{"$ref":"#/components/schemas/PincodeMopUpdateResponse"}}},"required":["action","batch_id","country","status_code","success"]},"PincodeMopBulkData":{"type":"object","properties":{"batch_id":{"type":"string"},"s3_url":{"type":"string"}},"required":["batch_id","s3_url"]},"PincodeBulkViewResponse":{"type":"object","properties":{"batch_id":{"type":"string"},"s3_url":{"type":"string"}},"required":["batch_id","s3_url"]},"PincodeCodStatusListingRequest":{"type":"object","properties":{"country":{"type":"string","default":"INDIA"},"is_active":{"type":"boolean","default":true},"pincode":{"type":"integer","nullable":true},"current":{"type":"integer","default":1},"page_size":{"type":"integer","default":100}}},"PincodeCodStatusListingResponse":{"type":"object","properties":{"country":{"type":"string"},"data":{"type":"array","items":{"$ref":"#/components/schemas/PincodeCodStatusListingResponse"}},"success":{"type":"boolean"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"page":{"$ref":"#/components/schemas/PincodeCodStatusListingPage"},"summary":{"$ref":"#/components/schemas/PincodeCodStatusListingSummary"}},"required":["country","data","page","success","summary"]},"PincodeCodStatusListingPage":{"type":"object","properties":{"type":{"type":"string"},"has_next":{"type":"boolean"},"item_total":{"type":"integer"},"size":{"type":"integer"},"current":{"type":"integer"}},"required":["current","has_next","item_total","size","type"]},"PincodeCodStatusListingSummary":{"type":"object","properties":{"total_active_pincodes":{"type":"integer"},"total_inactive_pincodes":{"type":"integer"}},"required":["total_active_pincodes","total_inactive_pincodes"]},"PincodeMopUpdateAuditHistoryRequest":{"type":"object","properties":{"entity_type":{"type":"string"},"file_name":{"type":"string"}},"required":["entity_type"]},"PincodeMopUpdateAuditHistoryPaging":{"type":"object","properties":{"type":{"type":"string"},"size":{"type":"integer"},"current":{"type":"integer"},"has_next":{"type":"boolean"},"item_total":{"type":"integer"}}},"PincodeMopUpdateAuditHistoryResponse":{"type":"object","properties":{"batch_id":{"type":"string"},"entity_type":{"type":"string"},"error_file_s3_url":{"type":"string"},"s3_url":{"type":"string"},"file_name":{"type":"string"},"updated_at":{"type":"string"},"updated_by":{"type":"string"},"success":{"type":"boolean"}}},"PincodeMopUpdateAuditHistoryResponseData":{"type":"object","properties":{"entity_type":{"type":"string"},"page":{"$ref":"#/components/schemas/PincodeMopUpdateAuditHistoryPaging"},"data":{"type":"array","items":{"$ref":"#/components/schemas/PincodeMopUpdateAuditHistoryResponse"}}},"required":["data","page"]},"ArithmeticOperations":{"type":"object","properties":{"lt":{"type":"integer"},"gt":{"type":"integer"},"lte":{"type":"integer"},"gte":{"type":"integer"}}},"SchemeRulesFeatures":{"type":"object","properties":{"quality_check":{"type":"boolean"},"quick_response_code":{"type":"boolean"},"e_waybill":{"type":"boolean"},"multi_part_shipments":{"type":"boolean"},"flammable":{"type":"boolean"},"hazmat":{"type":"boolean"},"battery_operated":{"type":"boolean"}}},"SchemeRules":{"type":"object","properties":{"weight":{"$ref":"#/components/schemas/ArithmeticOperations"},"transport_type":{"type":"array","items":{"type":"string","enum":["surface","air","hyper-local"]}},"region":{"type":"string","enum":["national","international"]},"payment_mode":{"type":"array","items":{"type":"string","enum":["COD","PREPAID"]}},"feature":{"$ref":"#/components/schemas/SchemeRulesFeatures"}}},"CourierAccount":{"type":"object","properties":{"extension_id":{"type":"string"},"account_id":{"type":"string"},"scheme_id":{"type":"string"},"is_self_ship":{"type":"boolean"},"stage":{"type":"string","enum":["enabled","disabled"]},"is_own_account":{"type":"boolean"}},"required":["account_id","company_id","extension_id","is_self_ship","scheme_id","stage","is_own_account"]},"CourierPartnerAccountFailureResponse":{"type":"object","properties":{"success":{"type":"boolean"},"error":{"type":"array","items":{"$ref":"#/components/schemas/ErrorResponse"}}},"required":["error","success"]},"CourierPartnerList":{"type":"object","properties":{"extension_id":{"type":"string"},"account_id":{"type":"string"},"name":{"type":"string"},"is_self_ship":{"type":"boolean"}},"required":["account_id","extension_id","is_self_ship","name"]},"LocationRuleValues":{"type":"object","properties":{"id":{"type":"string"},"sub_type":{"type":"string"},"name":{"type":"string"},"display_name":{"type":"string"},"parent_id":{"type":"string"},"parent_ids":{"type":"array","items":{"type":"string"}}},"required":["id"]},"LocationRule":{"type":"object","properties":{"type":{"type":"string"},"includes":{"type":"array","items":{"$ref":"#/components/schemas/LocationRuleValues"}}}},"StringComparisonOperations":{"type":"object","properties":{"includes":{"type":"array","items":{"type":"string"}}}},"IntComparisonOperations":{"type":"object","properties":{"includes":{"type":"array","items":{"type":"integer"}}}},"CourierPartnerRuleConditions":{"type":"object","properties":{"forward":{"$ref":"#/components/schemas/LocationRule"},"reverse":{"$ref":"#/components/schemas/LocationRule"},"payment_mode":{"$ref":"#/components/schemas/StringComparisonOperations"},"category_ids":{"$ref":"#/components/schemas/IntComparisonOperations"},"product_ids":{"$ref":"#/components/schemas/IntComparisonOperations"},"product_tags":{"$ref":"#/components/schemas/StringComparisonOperations"},"zone_ids":{"$ref":"#/components/schemas/StringComparisonOperations"},"department_ids":{"$ref":"#/components/schemas/IntComparisonOperations"},"brand_ids":{"$ref":"#/components/schemas/IntComparisonOperations"},"order_place_date":{"$ref":"#/components/schemas/ArithmeticOperations"},"store_ids":{"$ref":"#/components/schemas/IntComparisonOperations"},"store_type":{"$ref":"#/components/schemas/StringComparisonOperations"},"store_tags":{"$ref":"#/components/schemas/StringComparisonOperations"},"shipment_weight":{"$ref":"#/components/schemas/ArithmeticOperations"},"shipment_cost":{"$ref":"#/components/schemas/ArithmeticOperations"},"shipment_volumetric_weight":{"$ref":"#/components/schemas/ArithmeticOperations"}}},"CourierPartnerRule":{"type":"object","properties":{"is_active":{"type":"boolean"},"cp_list":{"type":"array","items":{"$ref":"#/components/schemas/CourierPartnerList"}},"name":{"type":"string"},"conditions":{"$ref":"#/components/schemas/CourierPartnerRuleConditions"},"sort":{"type":"array","items":{"type":"string","enum":["fastest","custom"]}}},"required":["conditions","is_active","name","sort","type"]},"FailureResponse":{"type":"object","properties":{"success":{"type":"boolean"},"error":{"type":"array","items":{"$ref":"#/components/schemas/ErrorResponse"}}},"required":["error","success"]},"CourierPartnerRulesListResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/CourierPartnerRule"}},"page":{"$ref":"#/components/schemas/Page"}},"required":["items","page"]},"ZoneConfig":{"type":"object","properties":{"serviceability_type":{"type":"string"}}},"ApplicationConfig":{"type":"object","properties":{"rule_ids":{"type":"array","items":{"type":"string"}},"sort":{"type":"array","items":{"type":"string","enum":["fastest"]}},"zones":{"$ref":"#/components/schemas/ZoneConfig"}}},"BulkRegionJobSerializer":{"type":"object","properties":{"file_path":{"type":"string"},"country":{"type":"string"},"action":{"type":"string","enum":["import","export"]},"region":{"type":"string"}},"required":["action","country","region"]},"BulkRegionResponseItemData":{"type":"object","properties":{"file_path":{"type":"string"},"failed":{"type":"integer"},"failed_records":{"type":"array","items":{"type":"object"}},"action":{"type":"string"},"batch_id":{"type":"string"},"country":{"type":"string"},"success":{"type":"integer"},"region":{"type":"string"},"status":{"type":"string"},"total":{"type":"integer"},"error_file_path":{"type":"string"}},"required":["action","batch_id","country","file_path","region","status"]},"BulkRegionResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/BulkRegionResponseItemData"}},"page":{"$ref":"#/components/schemas/Page"}},"required":["items","page"]},"SelfShipResponse":{"type":"object","properties":{"is_active":{"type":"boolean"},"tat":{"type":"number"}},"required":["is_active","tat"]},"ApplicationSelfShipConfig":{"type":"object","properties":{"self_ship":{"nullable":true,"type":"object","allOf":[{"$ref":"#/components/schemas/SelfShipResponse"}]}}},"ApplicationSelfShipConfigResponse":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/ServiceabilityErrorResponse"},"data":{"$ref":"#/components/schemas/ApplicationSelfShipConfig"},"success":{"type":"boolean"}},"required":["success"]},"StoreRuleConfigData":{"type":"object","properties":{"rule_ids":{"type":"array","items":{"type":"string"}},"type_based_priority":{"type":"array","items":{"type":"string"}},"tag_based_priority":{"type":"array","items":{"type":"string"}},"store_priority":{"type":"array","items":{"$ref":"#/components/schemas/StorePrioritySchema"}},"sort":{"type":"array","items":{"type":"string"}}}},"CustomerRadiusSchema":{"type":"object","properties":{"unit":{"type":"string"},"lt":{"type":"integer"},"lte":{"type":"integer"},"gt":{"type":"integer"},"gte":{"type":"integer"}},"required":["unit"]},"StoreRuleConditionSchema":{"type":"object","properties":{"department_ids":{"$ref":"#/components/schemas/IntComparisonOperations"},"category_ids":{"$ref":"#/components/schemas/IntComparisonOperations"},"brand_ids":{"$ref":"#/components/schemas/IntComparisonOperations"},"to_location":{"$ref":"#/components/schemas/LocationRule"},"customer_radius":{"$ref":"#/components/schemas/CustomerRadiusSchema"},"store_type":{"$ref":"#/components/schemas/StringComparisonOperations"},"product_tags":{"$ref":"#/components/schemas/StringComparisonOperations"},"product_ids":{"$ref":"#/components/schemas/IntComparisonOperations"},"store_tags":{"$ref":"#/components/schemas/StringComparisonOperations"},"order_place_date":{"$ref":"#/components/schemas/ArithmeticOperations"},"zone_ids":{"$ref":"#/components/schemas/StringComparisonOperations"}}},"StoreRuleDataSchema":{"type":"object","properties":{"id":{"type":"string","example":"64c43f44ab1403732d0d6b63"},"name":{"type":"string","example":"dummy-rule"},"company_id":{"type":"integer","example":1},"application_id":{"type":"string","example":"test_app"},"type_based_priority":{"type":"array","items":{"type":"string"}},"tag_based_priority":{"type":"array","items":{"type":"string"}},"store_priority":{"type":"array","items":{"$ref":"#/components/schemas/StorePrioritySchema"}},"sort":{"type":"array","items":{"type":"string"}},"conditions":{"$ref":"#/components/schemas/StoreRuleConditionSchema"},"is_active":{"type":"boolean"}}},"StorePrioritySchema":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}}},"GetStoreRulesApiResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/StoreRuleDataSchema"}},"page":{"$ref":"#/components/schemas/Page"}}},"CreateStoreRuleRequestSchema":{"type":"object","properties":{"name":{"type":"string"},"is_active":{"type":"boolean"},"conditions":{"$ref":"#/components/schemas/StoreRuleConditionSchema"},"type_based_priority":{"type":"array","items":{"type":"string"}},"tag_based_priority":{"type":"array","items":{"type":"string"}},"store_priority":{"type":"array","items":{"$ref":"#/components/schemas/StorePrioritySchema"}},"sort":{"type":"array","items":{"type":"string"}}}},"StoreRuleResponseSchema":{"type":"object","properties":{"id":{"type":"string","example":"64c43f44ab1403732d0d6b63"},"name":{"type":"string","example":"dummy-rule"},"type":{"type":"string","example":"store"},"type_based_priority":{"type":"array","items":{"type":"string"}},"tag_based_priority":{"type":"array","items":{"type":"string"}},"store_priority":{"type":"array","items":{"$ref":"#/components/schemas/StorePrioritySchema"}},"sort":{"type":"array","items":{"type":"string"}},"conditions":{"$ref":"#/components/schemas/StoreRuleConditionSchema"},"is_active":{"type":"boolean"}}},"StoreRuleUpdateResponseSchema":{"type":"object","properties":{"id":{"type":"string","example":"dummy-id"},"name":{"type":"string","example":"dummy-rule"},"type":{"type":"string","example":"store"},"type_based_priority":{"type":"array","items":{"type":"string"}},"tag_based_priority":{"type":"array","items":{"type":"string"}},"store_priority":{"type":"array","items":{"$ref":"#/components/schemas/StorePrioritySchema"}},"sort":{"type":"array","items":{"type":"string"}},"conditions":{"$ref":"#/components/schemas/StoreRuleConditionSchema"},"is_active":{"type":"boolean"},"company_id":{"type":"integer"},"application_id":{"type":"string"}}},"ServiceabilityModel":{"type":"object","properties":{"lm_cod_limit":{"type":"integer"},"is_qc":{"type":"boolean"},"pickup_cutoff":{"type":"string","nullable":true},"route_code":{"type":"string","nullable":true},"is_first_mile":{"type":"boolean"},"is_return":{"type":"boolean"},"is_installation":{"type":"boolean"},"is_last_mile":{"type":"boolean"}},"required":["is_first_mile","is_installation","is_last_mile","is_qc","is_return","lm_cod_limit","pickup_cutoff","route_code"]},"CourierPartnerSchemeFeatures":{"type":"object","properties":{"doorstep_qc":{"type":"boolean"},"qr":{"type":"boolean"},"mps":{"type":"boolean"},"ndr":{"type":"boolean"},"ndr_attempts":{"type":"integer"},"dangerous_goods":{"type":"boolean"},"fragile_goods":{"type":"boolean"},"restricted_goods":{"type":"boolean"},"cold_storage_goods":{"type":"boolean"},"doorstep_exchange":{"type":"boolean"},"doorstep_return":{"type":"boolean"},"product_installation":{"type":"boolean"},"openbox_delivery":{"type":"boolean"},"status_updates":{"type":"string"},"multi_pick_single_drop":{"type":"boolean"},"single_pick_multi_drop":{"type":"boolean"},"multi_pick_multi_drop":{"type":"boolean"},"ewaybill":{"type":"boolean"}}},"CourierPartnerSchemeModel":{"type":"object","properties":{"extension_id":{"type":"string"},"scheme_id":{"type":"string"},"weight":{"$ref":"#/components/schemas/ArithmeticOperations"},"transport_type":{"type":"string","enum":["surface","air","waterways"]},"region":{"type":"string","enum":["intra-city","inter-city","inter-country"]},"delivery_type":{"type":"string","enum":["hyperlocal","same-day","one-day","two-day","standard","morning","no-rush"]},"payment_mode":{"type":"array","items":{"type":"string","enum":["COD","PREPAID"]}},"stage":{"type":"string","enum":["enabled","disabled"]},"feature":{"$ref":"#/components/schemas/CourierPartnerSchemeFeatures"}},"required":["extension_id","scheme_id","weight","transport_type","region","delivery_type","payment_mode","stage","feature"]},"CourierAccountResponse":{"type":"object","properties":{"account_id":{"type":"string"},"scheme_id":{"type":"string"},"is_self_ship":{"type":"boolean"},"stage":{"type":"string","enum":["enabled","disabled"]},"is_own_account":{"type":"boolean"},"scheme_rules":{"$ref":"#/components/schemas/CourierPartnerSchemeModel"}},"required":["account_id","scheme_id","is_self_ship","stage","is_own_account","scheme_rules"]},"CompanyCourierPartnerAccountListResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/CourierAccountResponse"}},"page":{"$ref":"#/components/schemas/Page"}},"required":["items","page"]},"PackageMaterial":{"type":"object","properties":{"name":{"type":"string"},"width":{"type":"number"},"height":{"type":"number"},"length":{"type":"number"},"rules":{"type":"array","items":{"$ref":"#/components/schemas/PackageMaterialRule"}},"store_ids":{"type":"array","minItems":1,"items":{"type":"integer"}},"weight":{"type":"number"},"error_rate":{"type":"number"},"package_type":{"type":"string"},"size":{"type":"string"},"media":{"type":"array","items":{"type":"string"}},"channels":{"type":"array","items":{"$ref":"#/components/schemas/Channel"}},"track_inventory":{"type":"boolean"},"status":{"type":"string","enum":["active","inactive"]},"max_weight":{"type":"number"},"package_vol_weight":{"type":"number"},"auto_calculate":{"type":"boolean"}},"required":["error_rate","height","length","name","weight","width","channels","size","package_type","store_ids","status"]},"PackageMaterialResponse":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"item_id":{"type":"integer"},"width":{"type":"number"},"height":{"type":"number"},"length":{"type":"number"},"rules":{"type":"array","items":{"$ref":"#/components/schemas/PackageMaterialRule"}},"store_ids":{"type":"array","minItems":1,"items":{"type":"integer"}},"weight":{"type":"number"},"error_rate":{"type":"number"},"package_type":{"type":"string"},"size":{"type":"string"},"media":{"type":"array","items":{"type":"string"}},"channels":{"type":"array","items":{"$ref":"#/components/schemas/Channel"}},"track_inventory":{"type":"boolean"},"status":{"type":"string","enum":["active","inactive"]},"max_weight":{"type":"number"},"package_vol_weight":{"type":"number"},"auto_calculate":{"type":"boolean"}},"required":["error_rate","height","length","name","weight","width","channels","size","package_type","store_ids","status"]},"PackageMaterialRule":{"type":"object","properties":{"rule_id":{"type":"string"},"quantity":{"$ref":"#/components/schemas/PackageMaterialRuleQuantity"},"weight":{"type":"integer"}}},"PackageRule":{"type":"object","properties":{"name":{"type":"string"},"company_id":{"type":"integer"},"type":{"type":"string"},"is_active":{"type":"boolean"},"product_tag":{"$ref":"#/components/schemas/PackageRuleProductTag"},"product_id":{"$ref":"#/components/schemas/PackageRuleProduct"},"category_id":{"$ref":"#/components/schemas/PackageRuleCategory"}},"required":["company_id","name","type"]},"PackageRuleResponse":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"company_id":{"type":"integer"},"type":{"type":"string"},"is_active":{"type":"boolean"},"product_tag":{"$ref":"#/components/schemas/PackageRuleProductTag"},"product_id":{"$ref":"#/components/schemas/PackageRuleProduct"},"category_id":{"$ref":"#/components/schemas/PackageRuleCategory"}},"required":["company_id","name","type"]},"Channel":{"type":"object","properties":{"type":{"type":"string"},"id":{"type":"string"}}},"PackageMaterialRuleList":{"type":"object","properties":{"items":{"$ref":"#/components/schemas/PackageRuleResponse"},"page":{"$ref":"#/components/schemas/Page"}}},"PackageMaterialList":{"type":"object","properties":{"items":{"$ref":"#/components/schemas/PackageMaterialResponse"},"page":{"$ref":"#/components/schemas/Page"}}},"PackageRuleProduct":{"type":"object","properties":{"includes":{"type":"array","items":{"type":"integer"}}}},"PackageRuleProductTag":{"type":"object","properties":{"includes":{"type":"array","items":{"type":"string"}}}},"PackageRuleCategory":{"type":"object","properties":{"includes":{"type":"array","items":{"type":"integer"}}}},"PackageMaterialRuleQuantity":{"type":"object","properties":{"min":{"type":"integer"},"max":{"type":"integer"}}},"RulePriorityRequest":{"type":"object","properties":{"rule_id":{"type":"string"},"priority":{"type":"integer"}},"required":["rule_id","priority"]},"RulePriorityResponse":{"type":"object","properties":{"success":{"type":"boolean"}}},"InvalidateShipmentCachePayload":{"type":"object","properties":{"shipment_ids":{"type":"array","description":"Shipment Ids to clear cache","items":{"type":"string"}},"affiliate_bag_ids":{"type":"array","description":"Affiliate Bag Ids to clear cache of shipment Ids mapped to it","items":{"type":"string"}},"bag_ids":{"type":"array","description":"Bag Ids to clear cache of shipment Ids mapped to it","items":{"type":"string"}}}},"InvalidateShipmentCacheNestedResponse":{"type":"object","properties":{"shipment_id":{"type":"string"},"status":{"type":"integer","format":"int32"},"message":{"type":"string"},"error":{"type":"string"}}},"InvalidateShipmentCacheResponse":{"type":"object","properties":{"response":{"type":"array","items":{"$ref":"#/components/schemas/InvalidateShipmentCacheNestedResponse"}}}},"StoreReassign":{"type":"object","properties":{"store_id":{"type":"integer","format":"int32"},"bag_id":{"type":"integer","format":"int32","nullable":true},"affiliate_order_id":{"type":"string","nullable":true},"affiliate_id":{"type":"string","nullable":true},"item_id":{"type":"string","nullable":true},"fynd_order_id":{"type":"string","nullable":true,"maxLength":30},"set_id":{"type":"string","nullable":true},"affiliate_bag_id":{"type":"string","nullable":true},"reason_ids":{"type":"array","nullable":true,"items":{"type":"integer","format":"int32"}},"mongo_article_id":{"type":"string","nullable":true}},"required":["store_id"]},"StoreReassignResponse":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}},"Entities":{"type":"object","properties":{"id":{"type":"string","description":"Shipment ID if 'entity_type': shipments | Bag Id if 'entity_type': bags"},"affiliate_order_id":{"type":"string","description":"Application/Affiliate Order ID, Required if the ID is missing"},"affiliate_id":{"type":"string","description":"Application/Affiliate ID, Required if the ID is missing"},"reason_text":{"type":"string","description":"Reason For Shipment/Bag Action"},"affiliate_bag_id":{"type":"string","description":"Application/Affiliate Bag ID, Required if the ID is missing"},"affiliate_shipment_id":{"type":"string","description":"Application/Affiliate Shipment ID, Required if the ID is missing"}},"required":["reason_text"]},"UpdateShipmentLockPayload":{"type":"object","properties":{"entity_type":{"type":"string","enum":["bags","shipments"],"description":"Expected entity_type: [bags, shipments]"},"action":{"type":"string","enum":["lock","unlock","check"],"description":"Expected Actions: [lock, unlock, check]"},"action_type":{"type":"string","enum":["complete","operational","financial"],"description":"Expected action_type: [complete, operational, financial]"},"entities":{"type":"array","description":"Shipment/Entity","items":{"$ref":"#/components/schemas/Entities"}}},"required":["action","action_type","entities","entity_type"]},"OriginalFilter":{"type":"object","properties":{"affiliate_shipment_id":{"type":"string","description":"Affiliate Shipment ID"},"affiliate_id":{"type":"string","description":"Affiliate ID"}}},"Bags":{"type":"object","properties":{"bag_id":{"type":"integer","format":"int32","description":"Bag Id"},"affiliate_bag_id":{"type":"string","description":"Application/Affiliate Bag ID, Required if the ID is missing"},"is_locked":{"type":"boolean","description":"Is Bag Locked"},"affiliate_order_id":{"type":"string","description":"Application/Affiliate Order ID, Required if the ID is missing"}}},"CheckResponse":{"type":"object","properties":{"shipment_id":{"type":"string","description":"Shipment ID"},"status":{"type":"string","description":"Status"},"is_bag_locked":{"type":"boolean","description":"Is Bag Locked"},"affiliate_id":{"type":"string","description":"Affiliate ID"},"original_filter":{"description":"Filter","allOf":[{"$ref":"#/components/schemas/OriginalFilter"}]},"is_shipment_locked":{"type":"boolean","description":"Is Shipment Locked"},"lock_status":{"type":"string","nullable":true,"description":"Lock Status: Expected lock_status: [complete, operational, financial]"},"affiliate_shipment_id":{"type":"string","description":"Affiliate Shipment ID"},"bags":{"type":"array","items":{"$ref":"#/components/schemas/Bags"}}}},"UpdateShipmentLockResponse":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"},"check_response":{"type":"array","description":"Entity Lock Status, If the action input as 'check'","items":{"$ref":"#/components/schemas/CheckResponse"}}}},"AnnouncementResponse":{"type":"object","properties":{"to_datetime":{"type":"string"},"id":{"type":"integer","format":"int32"},"description":{"type":"string"},"platform_name":{"type":"string"},"from_datetime":{"type":"string"},"platform_id":{"type":"string"},"title":{"type":"string"},"company_id":{"type":"integer","format":"int32"},"logo_url":{"type":"string"},"created_at":{"type":"string"}},"required":["id"]},"AnnouncementsResponse":{"type":"object","properties":{"announcements":{"type":"array","items":{"$ref":"#/components/schemas/AnnouncementResponse"}},"success":{"type":"boolean"},"message":{"type":"string"}}},"BaseResponse":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}},"Click2CallResponse":{"type":"object","properties":{"call_id":{"type":"string","description":"Call ID from the provider"},"success":{"type":"boolean","description":"Success"}},"required":["call_id","success"]},"ErrorDetail":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}},"ProductsReasonsFilters":{"type":"object","properties":{"line_number":{"type":"integer","format":"int32","description":"Product/Bag Line number for the Product/Bag Identifier"},"identifier":{"type":"string","description":"Product/Bag Article/Item Identifier"},"quantity":{"type":"integer","format":"int32"}}},"ProductsReasonsData":{"type":"object","properties":{"reason_text":{"type":"string"},"reason_id":{"type":"integer","format":"int32"}}},"ProductsReasons":{"type":"object","properties":{"filters":{"type":"array","items":{"$ref":"#/components/schemas/ProductsReasonsFilters"}},"data":{"$ref":"#/components/schemas/ProductsReasonsData"}}},"EntityReasonData":{"type":"object","properties":{"reason_text":{"type":"string"},"reason_id":{"type":"integer","format":"int32"}}},"EntitiesReasons":{"type":"object","properties":{"filters":{"type":"array","items":{"type":"object"}},"data":{"$ref":"#/components/schemas/EntityReasonData"}}},"ReasonsData":{"type":"object","properties":{"products":{"type":"array","items":{"$ref":"#/components/schemas/ProductsReasons"}},"entities":{"type":"array","items":{"$ref":"#/components/schemas/EntitiesReasons"}}}},"Products":{"type":"object","properties":{"line_number":{"type":"integer","format":"int32","description":"Product/Bag Line number for the Product/Bag Identifier"},"identifier":{"type":"string","description":"Product/Bag Article/Item Identifier"},"quantity":{"type":"integer","format":"int32"}}},"OrderItemDataUpdates":{"type":"object","properties":{"data":{"type":"object"}}},"ProductsDataUpdatesFilters":{"type":"object","properties":{"line_number":{"type":"integer","format":"int32","description":"Product/Bag Line number for the Product/Bag Identifier"},"identifier":{"type":"string","description":"Product/Bag Article/Item Identifier"}}},"ProductsDataUpdates":{"type":"object","properties":{"filters":{"type":"array","description":"Filter for the Product/Bag","items":{"$ref":"#/components/schemas/ProductsDataUpdatesFilters"}},"data":{"type":"object"}}},"EntitiesDataUpdates":{"type":"object","properties":{"filters":{"type":"array","items":{"type":"object"}},"data":{"type":"object"}}},"DataUpdates":{"type":"object","properties":{"order_item_status":{"type":"array","items":{"$ref":"#/components/schemas/OrderItemDataUpdates"}},"products":{"type":"array","items":{"$ref":"#/components/schemas/ProductsDataUpdates"}},"entities":{"type":"array","items":{"$ref":"#/components/schemas/EntitiesDataUpdates"}}}},"ShipmentsRequest":{"type":"object","properties":{"identifier":{"type":"string","description":"Shipment ID"},"reasons":{"$ref":"#/components/schemas/ReasonsData"},"products":{"type":"array","description":"Product/Bag to be updated","items":{"$ref":"#/components/schemas/Products"}},"data_updates":{"$ref":"#/components/schemas/DataUpdates"}},"required":["identifier"]},"StatuesRequest":{"type":"object","properties":{"status":{"type":"string"},"shipments":{"type":"array","items":{"$ref":"#/components/schemas/ShipmentsRequest"}},"exclude_bags_next_state":{"type":"string","description":"State to be change for Remaining Bag/Products"},"split_shipment":{"type":"boolean","description":"Flag to split shipment"}}},"UpdateShipmentStatusRequest":{"type":"object","properties":{"force_transition":{"type":"boolean","description":"Force Transition"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/StatuesRequest"}},"lock_after_transition":{"type":"boolean","description":"Lock Shipment After Transition"},"unlock_before_transition":{"type":"boolean","description":"Unlock Shipment After Transition"},"task":{"type":"boolean","description":"To Run Status Update as a background Task"}}},"ShipmentsResponse":{"type":"object","properties":{"status":{"type":"integer","nullable":true,"format":"int32"},"final_state":{"type":"object","nullable":true},"identifier":{"type":"string","nullable":true},"stack_trace":{"type":"string","nullable":true},"code":{"type":"string","nullable":true},"meta":{"type":"object","nullable":true},"message":{"type":"string","nullable":true},"exception":{"type":"string","nullable":true}}},"StatuesResponse":{"type":"object","properties":{"shipments":{"type":"array","items":{"$ref":"#/components/schemas/ShipmentsResponse"}}}},"UpdateShipmentStatusResponseBody":{"type":"object","properties":{"statuses":{"type":"array","items":{"$ref":"#/components/schemas/StatuesResponse"}}}},"OrderUser":{"type":"object","properties":{"phone":{"type":"integer","format":"int32"},"last_name":{"type":"string"},"address1":{"type":"string","nullable":true},"state":{"type":"string"},"pincode":{"type":"string"},"first_name":{"type":"string"},"mobile":{"type":"integer","format":"int32"},"address2":{"type":"string","nullable":true},"email":{"type":"string"},"country":{"type":"string"},"city":{"type":"string"}},"required":["city","country","email","first_name","last_name","mobile","phone","pincode","state"]},"OrderPriority":{"type":"object","properties":{"fulfilment_priority_text":{"type":"string"},"affiliate_priority_code":{"type":"string","nullable":true},"fulfilment_priority":{"type":"integer","format":"int32","nullable":true}}},"ArticleDetails":{"type":"object","properties":{"_id":{"type":"string"},"brand_id":{"type":"integer","format":"int32"},"dimension":{"type":"object"},"category":{"type":"object"},"weight":{"type":"object"},"attributes":{"type":"object"},"quantity":{"type":"integer","format":"int32"}},"required":["_id","attributes","brand_id","category","dimension","quantity","weight"]},"LocationDetails":{"type":"object","properties":{"fulfillment_type":{"type":"string"},"articles":{"type":"array","items":{"$ref":"#/components/schemas/ArticleDetails"}},"fulfillment_id":{"type":"integer","format":"int32"}},"required":["articles","fulfillment_id","fulfillment_type"]},"ShipmentDetails":{"type":"object","properties":{"box_type":{"type":"string","nullable":true},"shipments":{"type":"integer","format":"int32"},"fulfillment_id":{"type":"integer","format":"int32"},"articles":{"type":"array","items":{"$ref":"#/components/schemas/ArticleDetails"}},"dp_id":{"type":"string","format":"int32","nullable":true},"meta":{"type":"object"},"affiliate_shipment_id":{"type":"string"},"dp_options":{"type":"object","nullable":true},"lock_status":{"type":"boolean","nullable":true},"action_to_status":{"type":"object","nullable":true}},"required":["affiliate_shipment_id","articles","fulfillment_id","shipments"],"nullable":true},"ShipmentConfig":{"type":"object","properties":{"location_details":{"$ref":"#/components/schemas/LocationDetails"},"source":{"type":"string"},"to_pincode":{"type":"string"},"shipment":{"type":"array","items":{"$ref":"#/components/schemas/ShipmentDetails"}},"identifier":{"type":"string"},"payment_mode":{"type":"string"},"action":{"type":"string"},"journey":{"type":"string"}},"required":["action","identifier","journey","payment_mode","shipment","source","to_pincode"]},"ShipmentData":{"type":"object","properties":{"shipment_data":{"$ref":"#/components/schemas/ShipmentConfig"}},"required":["shipment_data"]},"MarketPlacePdf":{"type":"object","properties":{"invoice":{"type":"string","format":"url","nullable":true},"label":{"type":"string","format":"url","nullable":true}}},"AffiliateBag":{"type":"object","properties":{"pdf_links":{"$ref":"#/components/schemas/MarketPlacePdf"},"store_id":{"type":"integer","format":"int32"},"sku":{"type":"string"},"discount":{"type":"number","format":"float"},"unit_price":{"type":"number","format":"float"},"price_effective":{"type":"number","format":"float"},"affiliate_store_id":{"type":"string"},"identifier":{"type":"object"},"seller_identifier":{"type":"string"},"item_size":{"type":"string"},"amount_paid":{"type":"number","format":"float"},"fynd_store_id":{"type":"string"},"item_id":{"type":"integer","format":"int32"},"delivery_charge":{"type":"number","format":"float"},"avl_qty":{"type":"integer","format":"int32"},"price_marked":{"type":"number","format":"float"},"quantity":{"type":"integer","format":"int32"},"company_id":{"type":"integer","format":"int32"},"hsn_code_id":{"type":"string"},"_id":{"type":"string"},"affiliate_meta":{"type":"object"},"modified_on":{"type":"string"},"transfer_price":{"type":"integer","format":"int32"}},"required":["_id","affiliate_meta","affiliate_store_id","amount_paid","avl_qty","company_id","delivery_charge","discount","fynd_store_id","hsn_code_id","identifier","item_id","item_size","modified_on","price_effective","price_marked","quantity","seller_identifier","sku","store_id","transfer_price","unit_price"]},"UserData":{"type":"object","properties":{"shipping_user":{"$ref":"#/components/schemas/OrderUser"},"billing_user":{"$ref":"#/components/schemas/OrderUser"}}},"OrderInfo":{"type":"object","properties":{"affiliate_order_id":{"type":"string"},"cod_charges":{"type":"number","format":"float"},"items":{"type":"object"},"discount":{"type":"number","format":"float"},"billing_address":{"$ref":"#/components/schemas/OrderUser"},"payment":{"type":"object"},"order_priority":{"$ref":"#/components/schemas/OrderPriority"},"shipment":{"$ref":"#/components/schemas/ShipmentData"},"delivery_charges":{"type":"number","format":"float"},"shipping_address":{"$ref":"#/components/schemas/OrderUser"},"order_value":{"type":"number","format":"float"},"payment_mode":{"type":"string"},"bags":{"type":"array","items":{"$ref":"#/components/schemas/AffiliateBag"}},"user":{"$ref":"#/components/schemas/UserData"},"coupon":{"type":"string","nullable":true}},"required":["bags","billing_address","cod_charges","delivery_charges","discount","items","order_value","payment_mode","shipping_address","user"]},"AffiliateAppConfigMeta":{"type":"object","properties":{"value":{"type":"string"},"name":{"type":"string"}},"required":["name","value"]},"AffiliateAppConfig":{"type":"object","properties":{"id":{"type":"string"},"description":{"type":"string"},"updated_at":{"type":"string"},"name":{"type":"string"},"token":{"type":"string"},"meta":{"type":"array","items":{"$ref":"#/components/schemas/AffiliateAppConfigMeta"}},"owner":{"type":"string"},"secret":{"type":"string"},"created_at":{"type":"string"}},"required":["created_at","id","name","owner","secret","token","updated_at"]},"AffiliateInventoryArticleAssignmentConfig":{"type":"object","properties":{"post_order_reassignment":{"type":"boolean"}}},"AffiliateInventoryPaymentConfig":{"type":"object","properties":{"source":{"type":"string"},"mode_of_payment":{"type":"string"}}},"AffiliateInventoryStoreConfig":{"type":"object","properties":{"store":{"type":"object"}}},"AffiliateInventoryOrderConfig":{"type":"object","properties":{"force_reassignment":{"type":"boolean"}}},"AffiliateInventoryLogisticsConfig":{"type":"object","properties":{"dp_assignment":{"type":"boolean"}}},"AffiliateInventoryConfig":{"type":"object","properties":{"article_assignment":{"$ref":"#/components/schemas/AffiliateInventoryArticleAssignmentConfig"},"payment":{"$ref":"#/components/schemas/AffiliateInventoryPaymentConfig"},"inventory":{"$ref":"#/components/schemas/AffiliateInventoryStoreConfig"},"order":{"$ref":"#/components/schemas/AffiliateInventoryOrderConfig"},"logistics":{"$ref":"#/components/schemas/AffiliateInventoryLogisticsConfig"}}},"AffiliateConfig":{"type":"object","properties":{"app":{"$ref":"#/components/schemas/AffiliateAppConfig"},"inventory":{"$ref":"#/components/schemas/AffiliateInventoryConfig"},"app_company_id":{"type":"integer","nullable":true}}},"Affiliate":{"type":"object","properties":{"id":{"type":"string"},"config":{"$ref":"#/components/schemas/AffiliateConfig"},"token":{"type":"string"}},"required":["id","token"]},"AffiliateStoreIdMapping":{"type":"object","properties":{"store_id":{"type":"integer","format":"int32"},"marketplace_store_id":{"type":"string"}},"required":["marketplace_store_id","store_id"]},"OrderConfig":{"type":"object","properties":{"create_user":{"type":"boolean"},"article_lookup":{"type":"string"},"bag_end_state":{"type":"string"},"affiliate":{"$ref":"#/components/schemas/Affiliate"},"store_lookup":{"type":"string"},"affiliate_store_id_mapping":{"type":"array","items":{"$ref":"#/components/schemas/AffiliateStoreIdMapping"}}},"required":["affiliate","affiliate_store_id_mapping"]},"CreateOrderPayload":{"type":"object","properties":{"affiliate_id":{"type":"string"},"order_info":{"$ref":"#/components/schemas/OrderInfo"},"order_config":{"$ref":"#/components/schemas/OrderConfig"}},"required":["affiliate_id","order_config","order_info"]},"CreateOrderResponse":{"type":"object","properties":{"fynd_order_id":{"type":"string"}},"required":["fynd_order_id"]},"DispatchManifest":{"type":"object","properties":{"manifest_id":{"type":"string"}},"required":["manifest_id"]},"ActionInfo":{"type":"object","properties":{"display_text":{"type":"string"},"id":{"type":"integer","format":"int32"},"description":{"type":"string"},"slug":{"type":"string"}},"required":["description","display_text","id","slug"]},"GetActionsResponse":{"type":"object","properties":{"permissions":{"type":"array","items":{"$ref":"#/components/schemas/ActionInfo"}}}},"HistoryReason":{"type":"object","properties":{"text":{"type":"string","nullable":true},"category":{"type":"string","nullable":true},"state":{"type":"string","nullable":true},"dislay_name":{"type":"string","nullable":true},"code":{"type":"integer","format":"int32","nullable":true},"quantity":{"type":"integer","format":"int32","nullable":true}}},"HistoryMeta":{"type":"object","properties":{"store_id":{"type":"integer","format":"int32","nullable":true},"status":{"type":"string","nullable":true},"status1":{"type":"string","nullable":true},"call_id":{"type":"string","nullable":true},"starttime":{"type":"string","nullable":true},"reason":{"$ref":"#/components/schemas/HistoryReason"},"short_link":{"type":"string","nullable":true},"endtime":{"type":"string","nullable":true},"store_name":{"type":"string","nullable":true},"caller":{"type":"string","nullable":true},"store_code":{"type":"string","nullable":true},"billsec":{"type":"string","nullable":true},"recordpath":{"type":"string","nullable":true},"status2":{"type":"string","nullable":true},"callerid":{"type":"string","nullable":true},"duration":{"type":"string","nullable":true},"channel_type":{"type":"string","nullable":true},"activity_comment":{"type":"string","nullable":true},"activity_type":{"type":"string","nullable":true},"receiver":{"type":"string","nullable":true},"recipient":{"type":"string","nullable":true},"slug":{"type":"string","nullable":true},"message":{"type":"string","nullable":true}}},"HistoryDict":{"type":"object","properties":{"display_message":{"type":"string","description":"Display Message"},"bag_id":{"type":"integer","format":"int32","description":"Bag ID"},"ticket_url":{"type":"string","description":"Ticket URL"},"l3_detail":{"type":"string","description":"L3 details of bag"},"createdat":{"type":"string","description":"Create date"},"ticket_id":{"type":"string","description":"Ticket ID"},"type":{"type":"string","description":"type of history, Expected Values:             [ activity_status, activity_escalation, activity_comment, outbound_notification, outbound_voice ]"},"l2_detail":{"type":"string","description":"L2 details of bag"},"assigned_agent":{"type":"string","description":"Assigned Agent"},"meta":{"description":"meta","allOf":[{"$ref":"#/components/schemas/HistoryMeta"}]},"l1_detail":{"type":"string","description":"L1 details of bag"},"message":{"type":"string","description":"History Message or comment"},"user":{"type":"string","description":"User who created the history"}},"required":["createdat","message","type","user"]},"ShipmentHistoryResponse":{"type":"object","properties":{"success":{"type":"boolean"},"activity_history":{"type":"array","items":{"$ref":"#/components/schemas/HistoryDict"}}},"required":["activity_history"]},"PostHistoryFilters":{"type":"object","properties":{"shipment_id":{"type":"string"},"line_number":{"type":"string"},"identifier":{"type":"string"}},"required":["shipment_id"]},"PostHistoryData":{"type":"object","properties":{"user_name":{"type":"string"},"message":{"type":"string"}},"required":["message","user_name"]},"PostHistoryDict":{"type":"object","properties":{"filters":{"type":"array","items":{"$ref":"#/components/schemas/PostHistoryFilters"}},"data":{"$ref":"#/components/schemas/PostHistoryData"}},"required":["data","filters"]},"PostShipmentHistory":{"type":"object","properties":{"activity_history":{"type":"array","items":{"$ref":"#/components/schemas/PostHistoryDict"}}}},"SmsDataPayload":{"type":"object","properties":{"shipment_id":{"type":"integer","format":"int32","description":"ShipmentId"},"phone_number":{"type":"integer","format":"int32","description":"phone number for communication"},"amount_paid":{"type":"integer","format":"int32","description":"Data mapped in Communication template: amount_paid"},"order_id":{"type":"string","description":"orderId"},"payment_mode":{"type":"string","description":"Data mapped in Communication template: payment_mode"},"customer_name":{"type":"string","description":"Data mapped in Communication template: customer_name"},"brand_name":{"type":"string","description":"Data mapped in Communication template: brand_name"},"message":{"type":"string","description":"message to be send in SMS"},"country_code":{"type":"string","description":"country code for SMS"}},"required":["country_code","message","order_id","phone_number","shipment_id"]},"SendSmsPayload":{"type":"object","properties":{"bag_id":{"type":"integer","format":"int32","description":"bag_id for the activity history track"},"data":{"description":"SMS Data","allOf":[{"$ref":"#/components/schemas/SmsDataPayload"}]},"slug":{"type":"string","description":"slug name for the template mapped in pointblank"}},"required":["bag_id","slug"]},"OrderDetails":{"type":"object","properties":{"fynd_order_id":{"type":"string"},"created_at":{"type":"string"},"user_id":{"type":"string","nullable":true},"tax_details":{"$ref":"#/components/schemas/TaxDetails"},"mongo_cart_id":{"type":"number","nullable":true},"delivery_charges":{"type":"number","nullable":true},"transaction_id":{"type":"string","nullable":true},"collect_by":{"type":"string"},"headers":{"type":"object","nullable":true},"coupon_value":{"type":"number","nullable":true},"order_value":{"type":"number"},"created_time":{"type":"string"},"currency":{"type":"string"},"total_order_value":{"type":"number"},"ordering_channel":{"type":"string"},"meta":{"type":"object","nullable":true},"cod_charges":{"type":"number","nullable":true},"cashback_value":{"type":"number","nullable":true},"refund_by":{"type":"string"},"affiliate_order_date":{"type":"string","nullable":true},"payment_methods":{"type":"object","nullable":true},"affiliate_order_id":{"type":"string"},"payment_mode_id":{"type":"number","nullable":true},"promotion_effective_discount":{"type":"number","nullable":true},"mode_of_payment":{"type":"string"},"discount":{"type":"number","nullable":true},"cashback_applied":{"type":"number","nullable":true},"fynd_credits":{"type":"number","nullable":true},"affiliate_id":{"type":"string"},"ordering_channel_logo":{"type":"string","nullable":true},"prices":{"$ref":"#/components/schemas/Prices"}}},"ShipmentDetail":{"type":"object","properties":{"shipment_id":{"type":"string"},"status":{"type":"string"},"id":{"type":"integer","format":"int32"},"bag_list":{"type":"array","items":{"type":"integer","format":"int32"}},"meta":{"$ref":"#/components/schemas/Meta"},"remarks":{"type":"string"}},"required":["id","meta"]},"OrderStatusData":{"type":"object","properties":{"order_details":{"$ref":"#/components/schemas/OrderDetails"},"errors":{"type":"array","items":{"type":"string"}},"shipment_details":{"type":"array","items":{"$ref":"#/components/schemas/ShipmentDetail"}}},"required":["order_details"]},"OrderStatusResult":{"type":"object","properties":{"success":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/OrderStatusData"}}},"required":["success"]},"Dimension":{"type":"object","properties":{"packaging_type":{"type":"string"},"weight":{"type":"string"},"height":{"type":"string"},"length":{"type":"number"},"width":{"type":"number"}}},"UpdatePackagingDimensionsPayload":{"type":"object","properties":{"shipment_id":{"type":"string"},"current_status":{"type":"string"},"dimension":{"type":"array","items":{"$ref":"#/components/schemas/Dimension"}}},"required":["current_status","dimension","shipment_id"]},"UpdatePackagingDimensionsResponse":{"type":"object","properties":{"message":{"type":"string"}}},"Charge":{"type":"object","properties":{"name":{"type":"string"},"amount":{"type":"object"},"tax":{"$ref":"#/components/schemas/Tax"},"code":{"type":"string"},"type":{"type":"string"}},"required":["amount","name","type"]},"LineItem":{"type":"object","properties":{"charges":{"type":"array","items":{"$ref":"#/components/schemas/Charge"}},"meta":{"type":"object"},"custom_message":{"type":"string"},"quantity":{"type":"integer","format":"int32"},"seller_identifier":{"type":"string"},"external_line_id":{"type":"string"}},"required":["seller_identifier"]},"ProcessingDates":{"type":"object","properties":{"dp_pickup_slot":{"type":"object"},"dispatch_after_date":{"type":"string"},"dispatch_by_date":{"type":"string"},"confirm_by_date":{"type":"string"},"customer_pickup_slot":{"type":"object"},"pack_by_date":{"type":"string"}}},"Shipment":{"type":"object","properties":{"line_items":{"type":"array","items":{"$ref":"#/components/schemas/LineItem"}},"external_shipment_id":{"type":"string"},"processing_dates":{"$ref":"#/components/schemas/ProcessingDates"},"meta":{"type":"object","nullable":true},"priority":{"type":"integer","format":"int32"},"location_id":{"type":"integer","format":"int32"},"order_type":{"type":"string"},"parent_type":{"type":"string","nullable":true},"store_invoice_id":{"type":"string","nullable":true},"lock_status":{"type":"string","nullable":true},"type":{"type":"string","nullable":true},"billing_address_json":{"$ref":"#/components/schemas/PlatformDeliveryAddress"},"id":{"type":"string"},"fulfilment_priority":{"type":"integer","nullable":true},"is_active":{"type":"boolean"},"previous_shipment_id":{"type":"string","nullable":true},"pdf_links":{"type":"object","nullable":true},"delivery_address_json":{"$ref":"#/components/schemas/PlatformDeliveryAddress"},"eway_bill_id":{"type":"string","nullable":true},"affiliate_shipment_id":{"type":"string","nullable":true},"fynd_order_id":{"type":"string"},"tags":{"type":"array","nullable":true,"items":{"type":"string"}},"created_at":{"type":"string"},"delivery_awb_number":{"type":"string","nullable":true},"hand_over_contact_json":{"$ref":"#/components/schemas/PlatformDeliveryAddress"},"credit_note_id":{"type":"string","nullable":true},"parent_id":{"type":"string","nullable":true},"affiliate_id":{"type":"string"},"packaging_type":{"type":"string","nullable":true},"vertical":{"type":"string","nullable":true},"quantity":{"type":"number","nullable":true},"status":{"$ref":"#/components/schemas/ShipmentStatusData"},"price":{"$ref":"#/components/schemas/Prices"},"gst":{"$ref":"#/components/schemas/ShipmentGstDetails"}},"required":["line_items","location_id"]},"ShippingInfo":{"type":"object","properties":{"alternate_mobile_number":{"type":"string"},"state":{"type":"string"},"customer_code":{"type":"string"},"shipping_type":{"type":"string"},"middle_name":{"type":"string"},"primary_mobile_number":{"type":"string"},"last_name":{"type":"string"},"geo_location":{"type":"object"},"gender":{"type":"string"},"house_no":{"type":"string"},"first_name":{"type":"string"},"title":{"type":"string"},"landmark":{"type":"string"},"country":{"type":"string"},"address_type":{"type":"string"},"state_code":{"type":"string"},"city":{"type":"string"},"external_customer_code":{"type":"string"},"floor_no":{"type":"string"},"alternate_email":{"type":"string"},"slot":{"type":"array","items":{"type":"object"}},"address":{"type":"string"},"area":{"type":"string"},"address1":{"type":"string"},"pincode":{"type":"string"},"primary_email":{"type":"string"},"address2":{"type":"string"},"country_code":{"type":"string"},"country_iso_code":{"type":"string","description":"Country Code in ISO 2 format (e.g. US, IN)"}}},"BillingInfo":{"type":"object","properties":{"alternate_mobile_number":{"type":"string"},"state":{"type":"string"},"customer_code":{"type":"string"},"middle_name":{"type":"string"},"primary_mobile_number":{"type":"string"},"last_name":{"type":"string"},"gender":{"type":"string"},"house_no":{"type":"string"},"first_name":{"type":"string"},"title":{"type":"string"},"country":{"type":"string"},"state_code":{"type":"string"},"city":{"type":"string"},"external_customer_code":{"type":"string"},"floor_no":{"type":"string"},"alternate_email":{"type":"string"},"address":{"type":"string"},"area":{"type":"string"},"address1":{"type":"string"},"pincode":{"type":"string"},"primary_email":{"type":"string"},"address2":{"type":"string"},"landmark":{"type":"string"},"country_code":{"type":"string"},"country_iso_code":{"type":"string","description":"Country Code in ISO 2 format (e.g. US, IN)"}}},"TaxInfo":{"type":"object","properties":{"b2b_gstin_number":{"type":"string"},"gstin":{"type":"string"},"pan_no":{"type":"string"}}},"PaymentInfo":{"type":"object","properties":{"primary_mode":{"type":"string"},"payment_methods":{"type":"array","default":[],"items":{"$ref":"#/components/schemas/PaymentMethod"}}},"required":["primary_mode"]},"CreateOrderAPI":{"type":"object","properties":{"shipments":{"type":"array","items":{"$ref":"#/components/schemas/Shipment"}},"shipping_info":{"$ref":"#/components/schemas/ShippingInfo"},"billing_info":{"$ref":"#/components/schemas/BillingInfo"},"currency_info":{"type":"object"},"external_order_id":{"type":"string"},"charges":{"type":"array","items":{"$ref":"#/components/schemas/Charge"}},"external_creation_date":{"type":"string"},"meta":{"type":"object"},"tax_info":{"$ref":"#/components/schemas/TaxInfo"},"config":{"type":"object"},"payment_info":{"$ref":"#/components/schemas/PaymentInfo"},"user_info":{"$ref":"#/components/schemas/UserInfo"}},"required":["billing_info","payment_info","shipments","shipping_info"]},"CreateOrderErrorReponse":{"type":"object","properties":{"request_id":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32"},"info":{"nullable":true},"stack_trace":{"type":"string","nullable":true},"code":{"type":"string","nullable":true},"meta":{"type":"string","nullable":true},"message":{"type":"string"},"exception":{"type":"string","nullable":true}},"required":["message","status"]},"DpConfiguration":{"type":"object","properties":{"shipping_by":{"type":"string"}}},"PaymentMethods":{"type":"object","properties":{"collect_by":{"type":"string"},"refund_by":{"type":"string"},"mode":{"type":"string"}}},"CreateChannelPaymentInfo":{"type":"object","properties":{"source":{"type":"string"},"payment_methods":{"type":"array","items":{"$ref":"#/components/schemas/PaymentMethods"}},"mode_of_payment":{"type":"string"}}},"CreateChannelConfig":{"type":"object","properties":{"dp_configuration":{"$ref":"#/components/schemas/DpConfiguration"},"shipment_assignment":{"type":"string"},"location_reassignment":{"type":"boolean"},"logo_url":{"type":"object"},"payment_info":{"$ref":"#/components/schemas/CreateChannelPaymentInfo"},"lock_states":{"type":"array","items":{"type":"string"}}}},"CreateChannelConfigData":{"type":"object","properties":{"config_data":{"$ref":"#/components/schemas/CreateChannelConfig"}}},"CreateChannelConifgErrorResponse":{"type":"object","properties":{"error":{"type":"string"}}},"CreateChannelConfigResponse":{"type":"object","properties":{"is_inserted":{"type":"boolean"},"is_upserted":{"type":"boolean"},"acknowledged":{"type":"boolean"}}},"UploadConsent":{"type":"object","properties":{"consent_url":{"type":"string"},"manifest_id":{"type":"string"}},"required":["consent_url","manifest_id"]},"PlatformOrderUpdate":{"type":"object","properties":{"order_id":{"type":"string"}},"required":["order_id"]},"ResponseDetail":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"array","items":{"type":"string"}}}},"FyndOrderIdList":{"type":"object","properties":{"fynd_order_id":{"type":"array","items":{"type":"string"}}}},"OrderStatus":{"type":"object","properties":{"order_details":{"type":"array","items":{"$ref":"#/components/schemas/FyndOrderIdList"}},"start_date":{"type":"string"},"end_date":{"type":"string"},"mobile":{"type":"integer","format":"int32"}},"required":["end_date","mobile","start_date"]},"BagStateTransitionMap":{"type":"object","properties":{"fynd":{"type":"object"},"affiliate":{"type":"object"}}},"RoleBaseStateTransitionMapping":{"type":"object","properties":{"success":{"type":"boolean"},"next_statuses":{"type":"array","items":{"type":"string"}}}},"FetchCreditBalanceRequestPayload":{"type":"object","properties":{"affiliate_id":{"type":"string"},"seller_id":{"type":"string"},"customer_mobile_number":{"type":"string"}},"required":["affiliate_id","customer_mobile_number","seller_id"]},"CreditBalanceInfo":{"type":"object","properties":{"total_credited_balance":{"type":"string"},"reason":{"type":"string"},"customer_mobile_number":{"type":"string"}}},"FetchCreditBalanceResponsePayload":{"type":"object","properties":{"success":{"type":"boolean"},"data":{"$ref":"#/components/schemas/CreditBalanceInfo"}},"required":["data","success"]},"RefundModeConfigRequestPayload":{"type":"object","properties":{"fynd_order_id":{"type":"string"},"seller_id":{"type":"integer","format":"int32"},"affiliate_id":{"type":"string"},"customer_mobile_number":{"type":"string"}},"required":["affiliate_id","fynd_order_id","seller_id"]},"RefundOption":{"type":"object","properties":{"value":{"type":"string"},"slug":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"}}},"RefundModeInfo":{"type":"object","properties":{"is_active":{"type":"boolean"},"slug":{"type":"string"},"options":{"type":"array","items":{"$ref":"#/components/schemas/RefundOption"}},"display_name":{"type":"string"}}},"RefundModeConfigResponsePayload":{"type":"object","properties":{"success":{"type":"boolean"},"data":{"type":"array","items":{"$ref":"#/components/schemas/RefundModeInfo"}}},"required":["data","success"]},"AttachUserOtpData":{"type":"object","properties":{"request_id":{"type":"string"}},"required":["request_id"]},"AttachUserInfo":{"type":"object","properties":{"first_name":{"type":"string"},"last_name":{"type":"string"},"mobile":{"type":"string"},"country_code":{"type":"string"}},"required":["first_name","last_name","mobile"]},"AttachOrderUser":{"type":"object","properties":{"otp_data":{"$ref":"#/components/schemas/AttachUserOtpData"},"fynd_order_id":{"type":"string"},"user_info":{"$ref":"#/components/schemas/AttachUserInfo"}},"required":["fynd_order_id","otp_data","user_info"]},"AttachOrderUserResponse":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}},"SendUserMobileOTP":{"type":"object","properties":{"mobile":{"type":"string"},"country_code":{"type":"string"}},"required":["mobile"]},"PointBlankOtpData":{"type":"object","properties":{"request_id":{"type":"string"},"resend_timer":{"type":"integer","format":"int32"},"message":{"type":"string"},"mobile":{"type":"integer","format":"int32"}}},"SendUserMobileOtpResponse":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"},"data":{"$ref":"#/components/schemas/PointBlankOtpData"}}},"VerifyOtpData":{"type":"object","properties":{"request_id":{"type":"string"},"mobile":{"type":"string"},"otp_code":{"type":"integer","format":"int32"}},"required":["mobile","otp_code","request_id"]},"VerifyMobileOTP":{"type":"object","properties":{"otp_data":{"$ref":"#/components/schemas/VerifyOtpData"},"fynd_order_id":{"type":"string"}},"required":["fynd_order_id","otp_data"]},"VerifyOtpResponseData":{"type":"object","properties":{"mobile":{"type":"string"},"message":{"type":"string"},"fynd_order_id":{"type":"string"},"country_code":{"type":"string"}}},"VerifyOtpResponse":{"type":"object","properties":{"status":{"type":"integer","format":"int32"},"success":{"type":"boolean"},"message":{"type":"string"},"data":{"$ref":"#/components/schemas/VerifyOtpResponseData"}}},"BulkReportsDownloadRequest":{"type":"object","properties":{"store_ids":{"type":"array","description":"Download for specific store ids.","items":{"type":"string"}},"lane_type":{"type":"string"},"custom_headers":{"type":"string","description":"Download report with specific headers"},"report_type":{"type":"string","description":"Type of report"},"start_date":{"type":"string","format":"date-time","description":"UTC start date in ISO format"},"end_date":{"type":"string","format":"date-time","description":"UTC end date in ISO format"},"entities":{"type":"array","description":"Download for specific enitites, entities can be bag, shipment or order_id, etc.","items":{"type":"string"}},"filter_type":{"type":"string"},"is_cross_company_enabled":{"type":"boolean","description":"Download lanes for cross company."},"custom_filters_for_lane":{"type":"object"}}},"BulkReportsDownloadResponse":{"type":"object","properties":{"success":{"type":"boolean"},"batch_id":{"type":"string"}}},"BulkFailedResponse":{"type":"object","properties":{"status":{"type":"boolean"},"error":{"type":"string"}}},"BulkStateTransistionRequest":{"type":"object","properties":{"url":{"type":"string"},"file_name":{"type":"string"}}},"BulkStateTransistionResponse":{"type":"object","properties":{"status":{"type":"boolean"},"message":{"type":"string"},"batch_id":{"type":"string"}}},"ShipmentActionInfo":{"type":"object","properties":{"label":{"type":"array","items":{"type":"string"}},"invoice":{"type":"array","items":{"type":"string"}},"failed_shipments":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"}}},"processing_shipments":{"type":"array","items":{"type":"string"}},"successful_shipments":{"type":"array","items":{"type":"string"}},"invoiceable_shipments":{"type":"array","items":{"type":"string"}},"failed_invoiced_shipments":{"type":"object","additionalProperties":{"type":"string"}},"processing_invoice_shipments":{"type":"array","items":{"type":"string"}},"successful_invoiced_shipments":{"type":"array","items":{"type":"string"}}}},"BulkActionListingData":{"type":"object","properties":{"store_id":{"type":"integer"},"uploaded_on":{"type":"string"},"company_id":{"type":"integer"},"shipments_action_info":{"$ref":"#/components/schemas/ShipmentActionInfo"},"is_invoiceable":{"type":"boolean"},"user_name":{"type":"string"},"file_url":{"type":"string"},"meta":{"type":"object"},"invoice_document_type":{"type":"string"},"label_document_type":{"type":"string"},"file_name":{"type":"string"},"store_name":{"type":"string"},"updated_ts":{"type":"integer"},"status":{"type":"boolean"},"store_code":{"type":"string"},"bulk_action_type":{"type":"string"},"created_ts":{"type":"string","format":"date-time"},"invoice_status":{"type":"string"},"do_invoice_label_generated":{"type":"boolean"},"id":{"type":"integer"},"user_id":{"type":"string"},"last_selected_invoice_label_type":{"type":"string"},"batch_id":{"type":"string"},"uploaded_by":{"type":"string"}}},"BulkListinPage":{"type":"object","properties":{"current":{"type":"integer"},"has_previous":{"type":"boolean"},"has_next":{"type":"boolean"},"total":{"type":"integer"},"item_total":{"type":"integer"},"type":{"type":"string"},"size":{"type":"integer"}}},"BulkListingResponse":{"type":"object","properties":{"success":{"type":"boolean"},"data":{"type":"array","items":{"$ref":"#/components/schemas/BulkActionListingData"}},"page":{"$ref":"#/components/schemas/BulkListinPage"},"total_count":{"type":"integer"}}},"JobDetailsData":{"type":"object","properties":{"batch_id":{"type":"string"},"total_shipments_count":{"type":"integer"},"successful_shipment_ids":{"type":"array","items":{"type":"string"}},"successful_shipments_count":{"type":"integer"},"failed_shipments_count":{"type":"integer"},"processing_shipments_count":{"type":"integer"},"company_id":{"type":"string"}}},"JobDetailsResponse":{"type":"object","properties":{"success":{"type":"boolean"},"data":{"type":"array","items":{"$ref":"#/components/schemas/JobDetailsData"}},"file_url":{"type":"string"},"message":{"type":"string"},"failed_records":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"}}},"uploaded_by":{"type":"string"},"user_id":{"type":"string"},"created_ts":{"type":"string","format":"date-time"},"uploaded_on":{"type":"string"},"status":{"type":"string"}}},"JobFailedResponse":{"type":"object","properties":{"file_name":{"type":"string"},"url":{"type":"string"}}},"ManifestPageInfo":{"type":"object","properties":{"current":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int32"},"has_next":{"type":"boolean"},"size":{"type":"integer","format":"int32"},"has_previous":{"type":"boolean"},"type":{"type":"string"}},"required":["current","has_next","has_previous","size","total","type"]},"ManifestItemDetails":{"type":"object","properties":{"quantity":{"type":"integer","format":"int32"},"shipment_id":{"type":"string"},"order_id":{"type":"string"},"awb_number":{"type":"string"},"invoice_id":{"type":"string"},"shipment_created_at":{"type":"string","format":"date-time"}},"required":["order_id","shipment_id"]},"ManifestShipmentListing":{"type":"object","properties":{"total_count":{"type":"integer","format":"int32"},"lane":{"type":"string"},"page":{"$ref":"#/components/schemas/ManifestPageInfo"},"success":{"type":"boolean"},"status":{"type":"integer","format":"int32"},"items":{"type":"array","items":{"$ref":"#/components/schemas/ManifestItemDetails"}},"message":{"type":"string"}},"required":["page","status","success","total_count"]},"DateRange":{"type":"object","properties":{"from_date":{"type":"string"},"to_date":{"type":"string"}}},"Filters":{"type":"object","properties":{"date_range":{"$ref":"#/components/schemas/DateRange"},"logo":{"type":"string"},"from_date":{"type":"string"},"stores":{"type":"integer","format":"int32"},"to_date":{"type":"string"},"dp_name":{"type":"string"},"dp_ids":{"type":"integer","format":"int32"},"lane":{"type":"string"},"selected_shipments":{"type":"string"},"store_name":{"type":"string"}}},"ManifestFile":{"type":"object","properties":{"key":{"type":"string"},"region":{"type":"string"},"bucket":{"type":"string"}}},"ManifestMediaUpdate":{"type":"object","properties":{"entity":{"type":"string"},"link":{"type":"string"},"code":{"type":"integer","format":"int32"},"media_type":{"type":"string"},"status":{"type":"boolean"},"file":{"$ref":"#/components/schemas/ManifestFile"}}},"PDFMeta":{"type":"object","properties":{"consent":{"type":"string","nullable":true},"media_updates":{"type":"array","items":{"$ref":"#/components/schemas/ManifestMediaUpdate"}}}},"TotalShipmentPricesCount":{"type":"object","properties":{"total_price":{"type":"number","format":"float"},"shipment_count":{"type":"integer","format":"int32"}}},"ManifestMeta":{"type":"object","properties":{"filters":{"$ref":"#/components/schemas/Filters"},"total_shipment_prices_count":{"$ref":"#/components/schemas/TotalShipmentPricesCount"}}},"Manifest":{"type":"object","properties":{"company_id":{"type":"integer"},"filters":{"$ref":"#/components/schemas/Filters"},"pdf_meta":{"$ref":"#/components/schemas/PDFMeta"},"meta":{"$ref":"#/components/schemas/ManifestMeta"},"is_active":{"type":"boolean"},"user_id":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"created_ts":{"type":"string","format":"date-time"},"manifest_id":{"type":"string"},"status":{"type":"string"},"id":{"type":"integer","format":"int32"},"uid":{"type":"string"},"created_by":{"type":"string"}},"required":["company_id","created_at","created_by","id","is_active","manifest_id","status","uid","user_id"]},"ManifestList":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Manifest"}},"page":{"$ref":"#/components/schemas/ManifestPageInfo"}}},"ManifestDetails":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ManifestItemDetails"}},"page":{"$ref":"#/components/schemas/ManifestPageInfo"},"additional_shipment_count":{"type":"integer","format":"int32"},"manifest_details":{"type":"array","items":{"$ref":"#/components/schemas/Manifest"}}}},"FiltersRequest":{"type":"object","properties":{"date_range":{"$ref":"#/components/schemas/DateRange"},"logo":{"type":"string"},"stores":{"type":"integer","format":"int32"},"dp_name":{"type":"string"},"dp_ids":{"type":"integer","format":"int32"},"lane":{"type":"string"},"store_name":{"type":"string"}},"required":["dp_ids","dp_name","lane","store_name","stores"]},"ProcessManifest":{"type":"object","properties":{"filters":{"$ref":"#/components/schemas/FiltersRequest"},"action":{"type":"string"},"unique_id":{"type":"string"},"manifest_id":{"type":"string"}},"required":["action","filters","unique_id"]},"ProcessManifestResponse":{"type":"object","properties":{"company_id":{"type":"integer","format":"int32"},"filters":{"$ref":"#/components/schemas/Filters"},"user_id":{"type":"string"},"manifest_id":{"type":"string"},"action":{"type":"string"},"uid":{"type":"string"},"created_by":{"type":"string"}}},"ProcessManifestItemResponse":{"type":"object","properties":{"items":{"$ref":"#/components/schemas/ProcessManifestResponse"}}},"FilterInfoOption":{"type":"object","properties":{"text":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"placeholder_text":{"type":"string","nullable":true},"value":{"type":"string","nullable":true},"min_search_size":{"type":"integer","format":"int32","nullable":true},"show_ui":{"type":"boolean","nullable":true}}},"FiltersInfo":{"type":"object","properties":{"options":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/FilterInfoOption"}},"text":{"type":"string"},"placeholder_text":{"type":"string","nullable":true},"value":{"type":"string"},"required":{"type":"boolean","nullable":true},"type":{"type":"string"}},"required":["text","type","value"]},"ManifestFiltersResponse":{"type":"object","properties":{"advance_filter":{"type":"array","items":{"$ref":"#/components/schemas/FiltersInfo"}},"global_filter":{"type":"array","items":{"$ref":"#/components/schemas/FiltersInfo"}}}},"PageDetails":{"properties":{"current":{"description":"Current page number","format":"int32","type":"integer","nullable":true},"has_next":{"description":"if next page contains any result","type":"boolean","nullable":true},"has_previous":{"description":"if previous page contains any result","type":"boolean","nullable":true},"item_total":{"description":"Total count of the results present in the requested filter","format":"int32","type":"integer","nullable":true},"size":{"description":"Page size","format":"int32","type":"integer","nullable":true},"type":{"description":"Type of the page","enum":["cursor","number"],"type":"string","nullable":true}},"required":["item_total"],"type":"object"},"EInvoiceIrnDetails":{"properties":{"ack_dt":{"type":"string"},"ack_no":{"type":"string"},"irn":{"type":"string"},"signed_invoice":{"type":"string"},"signed_qr_code":{"type":"string"}},"type":"object","required":["ack_dt","ack_no","irn","signed_invoice","signed_qr_code"]},"EInvoiceErrorDetails":{"properties":{"error_code":{"type":"string"},"error_message":{"type":"string"}},"type":"object","required":["error_message"]},"EInvoiceDetails":{"properties":{"irn_details":{"$ref":"#/components/schemas/EInvoiceIrnDetails"},"error_details":{"items":{"$ref":"#/components/schemas/EInvoiceErrorDetails"},"type":"array"}},"type":"object"},"EInvoiceResponseData":{"properties":{"shipment_id":{"type":"string"},"einvoice_type":{"type":"string"},"status":{"type":"integer"},"message":{"type":"string"},"einvoice_info":{"$ref":"#/components/schemas/EInvoiceDetails"}},"required":["message","shipment_id","einvoice_type","status"],"type":"object"},"EInvoiceRetry":{"properties":{"shipments_data":{"items":{"$ref":"#/components/schemas/EInvoiceRetryShipmentData"},"type":"array"}},"type":"object"},"EInvoiceRetryResponse":{"properties":{"response_data":{"items":{"$ref":"#/components/schemas/EInvoiceResponseData"},"type":"array"}},"required":["response_data"],"type":"object"},"EInvoiceErrorInfo":{"properties":{"error_details":{"items":{"$ref":"#/components/schemas/EInvoiceErrorDetails"},"type":"array"}},"type":"object"},"EInvoiceErrorResponseData":{"properties":{"shipment_id":{"type":"string"},"einvoice_type":{"type":"string"},"status":{"type":"integer"},"message":{"type":"string"},"einvoice_info":{"$ref":"#/components/schemas/EInvoiceErrorInfo"}},"type":"object","required":["shipment_id","einvoice_type","status","message"]},"EInvoiceErrorResponse":{"properties":{"response_data":{"items":{"$ref":"#/components/schemas/EInvoiceErrorResponseData"},"type":"array"},"message":{"type":"string"}},"type":"object"},"EInvoiceErrorResponseDetails":{"properties":{"response_data":{"items":{"$ref":"#/components/schemas/EInvoiceErrorResponseData"},"type":"array"},"message":{"type":"string"}},"type":"object","required":["response_data"]},"EInvoiceRetryShipmentData":{"properties":{"shipment_id":{"type":"string"},"einvoice_type":{"type":"string"}},"required":["shipment_id","einvoice_type"],"type":"object"},"CourierPartnerTrackingDetails":{"properties":{"awb":{"description":"AWB Number","example":"713191641","type":"string"},"dp_location":{"description":"Current location of Courier partner","example":"Mumbai","nullable":true,"type":"string"},"dp_name":{"description":"Courier Partner name","example":"Ecom b2b","type":"string"},"dp_status":{"description":"Status at Courier partner end","example":"dp_assigned","type":"string"},"dp_status_updated_at":{"description":"Date Time at which status was updated at Courier partner","example":"2023-07-12T20:17:46.384Z","format":"date-time","type":"string"},"estimated_delivery_date":{"description":"Estimated delivery date received from Courier partner","example":"2023-07-12T20:17:46.384Z","format":"date-time","nullable":true,"type":"string"},"id":{"description":"Id of Tracking history","example":1,"format":"int32","readOnly":true,"type":"integer"},"journey":{"description":"Journey type of the shipment","enum":["forward","return"],"example":"forward","type":"string"},"meta":{"description":"Meta field to store Courier partner's meta data","type":"object"},"operational_status":{"description":"Operational status of OMS","example":"dp_assigned","type":"string"},"promised_delivery_date":{"description":"Promised delivery date received from Courier partner","example":"2023-07-12T20:17:46.384Z","format":"date-time","nullable":true,"type":"string"},"remark":{"description":"Remark from courier partner","example":"UD -Manifested","nullable":true,"type":"string"},"shipment_id":{"description":"Shipment ID","example":"16838049724111283577","type":"string"}},"required":["awb","dp_name","dp_status","dp_status_updated_at","journey","operational_status","shipment_id"],"type":"object"},"CourierPartnerTrackingResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/CourierPartnerTrackingDetails"},"type":"array"},"page":{"$ref":"#/components/schemas/PageDetails"}},"type":"object"},"LogsChannelDetails":{"type":"object","properties":{"channel_id":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"logo":{"type":"string","nullable":true},"channel_shipment_id":{"type":"string","nullable":true}}},"LogPaymentDetails":{"type":"object","properties":{"payment_mode":{"type":"string","nullable":true},"amount_paid":{"type":"string","nullable":true}}},"FailedOrdersItem":{"type":"object","properties":{"log_id":{"type":"integer","nullable":false},"order_id":{"type":"string","nullable":false},"channel":{"$ref":"#/components/schemas/LogsChannelDetails"},"payment":{"$ref":"#/components/schemas/LogPaymentDetails"},"created_at":{"type":"string","nullable":false},"error_message":{"type":"string","nullable":true},"display_message":{"type":"string","nullable":true},"method_name":{"type":"string","nullable":false},"meta":{"type":"object","nullable":true}},"required":["log_id","order_id","created_at","method_name","channel","payment","error_message","display_message","meta"]},"FailedOrderLogs":{"type":"object","properties":{"items":{"$ref":"#/components/schemas/FailedOrdersItem"},"page":{"$ref":"#/components/schemas/PageDetails"}},"required":["items","page"]},"FailedOrderLogDetails":{"type":"object","properties":{"error_trace":{"type":"string","nullable":true},"exception":{"type":"string","nullable":true}},"required":["error_trace","exception"]},"GenerateInvoiceIDResponseData":{"type":"object","properties":{"shipment_id":{"type":"string"},"success":{"type":"boolean"},"invoice_id":{"type":"string","nullable":true},"error_message":{"type":"boolean","nullable":true}}},"GenerateInvoiceIDErrorResponseData":{"type":"object","properties":{"shipment_id":{"type":"string"},"success":{"type":"boolean"},"invoice_id":{"type":"boolean","nullable":true},"error_message":{"type":"string","nullable":true}}},"GenerateInvoiceIDRequest":{"type":"object","properties":{"shipment_ids":{"type":"array","items":{"type":"string"}}},"required":["shipment_ids"]},"GenerateInvoiceIDResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/GenerateInvoiceIDResponseData"}}}},"GenerateInvoiceIDErrorResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/GenerateInvoiceIDErrorResponseData"}}}},"BagReasonMeta":{"type":"object","properties":{"show_text_area":{"type":"boolean"}}},"QuestionSet":{"type":"object","properties":{"id":{"type":"integer"},"display_name":{"type":"string"}}},"BagReasons":{"type":"object","properties":{"qc_type":{"type":"array","items":{"type":"string"}},"id":{"type":"integer"},"display_name":{"type":"string"},"meta":{"$ref":"#/components/schemas/BagReasonMeta"},"question_set":{"type":"array","items":{"$ref":"#/components/schemas/QuestionSet"}},"reasons":{"type":"array","items":{"$ref":"#/components/schemas/BagReasons"}}}},"ShipmentBagReasons":{"type":"object","properties":{"reasons":{"type":"array","items":{"$ref":"#/components/schemas/BagReasons"}},"success":{"type":"boolean"}}},"ShipmentStatus":{"type":"object","properties":{"current_shipment_status":{"type":"string","nullable":true},"meta":{"type":"object","nullable":true},"shipment_status_id":{"type":"integer","nullable":true},"bag_list":{"type":"array","nullable":true,"items":{"type":"string"}},"title":{"type":"string"},"created_at":{"type":"string","nullable":true},"created_ts":{"type":"string","nullable":true},"shipment_id":{"type":"string","nullable":true},"status_created_at":{"type":"string","nullable":true},"status_created_ts":{"type":"string","nullable":true},"status":{"type":"string","nullable":true}},"required":["status","title"]},"UserDataInfo":{"type":"object","properties":{"uid":{"type":"integer","nullable":true},"user_oid":{"type":"string","nullable":true},"external_customer_id":{"type":"string","nullable":true},"first_name":{"type":"string","nullable":true},"last_name":{"type":"string","nullable":true},"mobile":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"is_anonymous_user":{"type":"boolean","nullable":true},"avis_user_id":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"gender":{"type":"string","nullable":true}}},"PlatformDeliveryAddress":{"type":"object","nullable":true,"properties":{"phone":{"type":"string","nullable":true},"address2":{"type":"string","nullable":true},"longitude":{"type":"integer","nullable":true},"pincode":{"type":"string","nullable":true},"area":{"type":"string","nullable":true},"address_type":{"type":"string","nullable":true},"country":{"type":"string","nullable":true},"address_category":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"created_at":{"type":"string","nullable":true},"address1":{"type":"string","nullable":true},"display_address":{"type":"string","nullable":true},"landmark":{"type":"string","nullable":true},"updated_at":{"type":"string","nullable":true},"version":{"type":"string","nullable":true},"latitude":{"type":"integer","nullable":true},"contact_person":{"type":"string","nullable":true},"state":{"type":"string","nullable":true},"city":{"type":"string","nullable":true}}},"ShipmentListingChannel":{"type":"object","properties":{"channel_shipment_id":{"type":"string","nullable":true},"is_affiliate":{"type":"boolean","nullable":true},"logo":{"type":"string","nullable":true},"name":{"type":"string","nullable":true}}},"Prices":{"type":"object","properties":{"refund_credit":{"type":"number","nullable":true},"amount_paid_roundoff":{"type":"number","nullable":true},"price_effective":{"type":"number","nullable":true},"promotion_effective_discount":{"type":"number","nullable":true},"pm_price_split":{"type":"number","nullable":true},"refund_amount":{"type":"number","nullable":true},"transfer_price":{"type":"number","nullable":true},"coupon_effective_discount":{"type":"number","nullable":true},"tax_collected_at_source":{"type":"number","nullable":true},"brand_calculated_amount":{"type":"number","nullable":true},"delivery_charge":{"type":"number","nullable":true},"cashback":{"type":"number","nullable":true},"value_of_good":{"type":"number","nullable":true},"cashback_applied":{"type":"number","nullable":true},"cod_charges":{"type":"number","nullable":true},"price_marked":{"type":"number","nullable":true},"amount_paid":{"type":"number","nullable":true},"coupon_value":{"type":"number","nullable":true},"discount":{"type":"number","nullable":true},"fynd_credits":{"type":"number","nullable":true},"gift_price":{"type":"number","nullable":true}}},"FinancialBreakup":{"type":"object","properties":{"refund_credit":{"type":"number"},"amount_paid_roundoff":{"type":"integer","nullable":true},"price_effective":{"type":"number"},"promotion_effective_discount":{"type":"number"},"transfer_price":{"type":"number"},"coupon_effective_discount":{"type":"number"},"gst_fee":{"type":"number"},"tax_collected_at_source":{"type":"number","nullable":true},"brand_calculated_amount":{"type":"number"},"delivery_charge":{"type":"number"},"gst_tag":{"type":"string"},"hsn_code":{"type":"string"},"cashback":{"type":"number"},"item_name":{"type":"string"},"value_of_good":{"type":"number"},"cashback_applied":{"type":"number"},"cod_charges":{"type":"number"},"price_marked":{"type":"number"},"size":{"type":"string"},"amount_paid":{"type":"number"},"coupon_value":{"type":"number"},"discount":{"type":"number"},"fynd_credits":{"type":"number"},"gst_tax_percentage":{"type":"number"},"identifiers":{"$ref":"#/components/schemas/Identifier"},"total_units":{"type":"integer"},"added_to_fynd_cash":{"type":"boolean"}},"required":["added_to_fynd_cash","amount_paid","brand_calculated_amount","cashback","cashback_applied","cod_charges","coupon_effective_discount","coupon_value","delivery_charge","discount","fynd_credits","gst_fee","gst_tag","gst_tax_percentage","hsn_code","identifiers","item_name","price_effective","price_marked","promotion_effective_discount","refund_credit","size","total_units","transfer_price","value_of_good"]},"GSTDetailsData":{"type":"object","properties":{"cgst_tax_percentage":{"type":"number","nullable":true},"gstin_code":{"type":"string","nullable":true},"value_of_good":{"type":"number"},"gst_fee":{"type":"number"},"igst_tax_percentage":{"type":"number","nullable":true},"gst_tax_percentage":{"type":"number","nullable":true},"hsn_code_id":{"type":"string","nullable":true},"igst_gst_fee":{"type":"number","nullable":true},"is_default_hsn_code":{"type":"boolean","nullable":true},"sgst_gst_fee":{"type":"number","nullable":true},"tax_collected_at_source":{"type":"number"},"brand_calculated_amount":{"type":"number"},"cgst_gst_fee":{"type":"number","nullable":true},"gst_tag":{"type":"string","nullable":true},"sgst_tax_percentage":{"type":"number","nullable":true},"hsn_code":{"type":"string","nullable":true}},"required":["brand_calculated_amount","gst_fee","tax_collected_at_source","value_of_good"]},"BagStateMapper":{"type":"object","properties":{"is_active":{"type":"boolean","nullable":true},"app_display_name":{"type":"string","nullable":true},"state_type":{"type":"string"},"id":{"type":"integer"},"journey_type":{"type":"string"},"app_state_name":{"type":"string","nullable":true},"name":{"type":"string"},"app_facing":{"type":"boolean","nullable":true},"notify_customer":{"type":"boolean","nullable":true},"display_name":{"type":"string"}},"required":["display_name","id","journey_type","name","state_type"]},"BagStatusHistory":{"type":"object","properties":{"forward":{"type":"boolean","nullable":true},"store_id":{"type":"integer","nullable":true},"delivery_awb_number":{"type":"string","nullable":true},"kafka_sync":{"type":"boolean","nullable":true},"delivery_partner_id":{"type":"integer","nullable":true},"app_display_name":{"type":"string","nullable":true},"state_id":{"type":"integer","nullable":true},"state_type":{"type":"string","nullable":true},"bsh_id":{"type":"integer","nullable":true},"created_at":{"type":"string","nullable":true},"created_ts":{"type":"string","nullable":true},"shipment_id":{"type":"string","nullable":true},"updated_at":{"type":"string","nullable":true},"updated_ts":{"type":"string","nullable":true},"bag_state_mapper":{"$ref":"#/components/schemas/BagStateMapper"},"bag_id":{"type":"integer","nullable":true},"reasons":{"type":"array","nullable":true,"items":{"type":"object"}},"status":{"type":"string"},"display_name":{"type":"string","nullable":true}},"required":["status"]},"Dimensions":{"type":"object","properties":{"height":{"type":"number","nullable":true},"width":{"type":"number","nullable":true},"is_default":{"type":"boolean","nullable":true},"unit":{"type":"string","nullable":true},"length":{"type":"number","nullable":true}}},"Weight":{"type":"object","properties":{"is_default":{"type":"boolean","nullable":true},"shipping":{"type":"integer","nullable":true},"unit":{"type":"string","nullable":true}}},"ShipmentListingBrand":{"type":"object","properties":{"logo":{"type":"string","nullable":true},"created_on":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"logo_base64":{"type":"string","nullable":true}}},"ReplacementDetails":{"type":"object","properties":{"replacement_type":{"type":"string","nullable":true},"original_affiliate_order_id":{"type":"string","nullable":true}}},"AffiliateMeta":{"type":"object","properties":{"order_item_id":{"type":"string","nullable":true},"channel_order_id":{"type":"string","nullable":true},"employee_discount":{"type":"number","nullable":true},"box_type":{"type":"string","nullable":true},"quantity":{"type":"integer","nullable":true},"size_level_total_qty":{"type":"integer","nullable":true},"loyalty_discount":{"type":"number","nullable":true},"replacement_details":{"$ref":"#/components/schemas/ReplacementDetails"},"channel_shipment_id":{"type":"string","nullable":true},"marketplace_invoice_id":{"type":"string","nullable":true},"due_date":{"type":"string","nullable":true},"coupon_code":{"type":"string","nullable":true},"is_priority":{"type":"boolean","nullable":true},"is_serial_number_required":{"type":"boolean","nullable":true},"fulfilment_priority":{"type":"integer","nullable":true},"customer_selling_price":{"type":"number","nullable":true}}},"AffiliateBagDetails":{"type":"object","properties":{"affiliate_meta":{"$ref":"#/components/schemas/AffiliateMeta"},"affiliate_order_id":{"type":"string"},"employee_discount":{"type":"number","nullable":true},"affiliate_bag_id":{"type":"string"},"loyalty_discount":{"type":"number","nullable":true}},"required":["affiliate_bag_id","affiliate_meta","affiliate_order_id"]},"PlatformArticleAttributes":{"type":"object","properties":{"currency":{"type":"string","nullable":true}}},"PlatformItem":{"type":"object","properties":{"id":{"type":"integer","nullable":true},"attributes":{"$ref":"#/components/schemas/PlatformArticleAttributes"},"brand_id":{"type":"integer","nullable":true},"slug_key":{"type":"string","nullable":true},"l3_category":{"type":"integer","nullable":true},"l3_category_name":{"type":"string","nullable":true},"last_updated_at":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"l2_category":{"type":"array","nullable":true,"items":{"type":"string"}},"brand":{"type":"string","nullable":true},"image":{"type":"array","nullable":true,"items":{"type":"string"}},"code":{"type":"string","nullable":true},"l1_category":{"type":"array","nullable":true,"items":{"type":"string"}},"size":{"type":"string","nullable":true},"can_cancel":{"type":"boolean","nullable":true},"can_return":{"type":"boolean","nullable":true},"branch_url":{"type":"string","nullable":true},"meta":{"type":"object","nullable":true},"color":{"type":"string","nullable":true},"department_id":{"type":"integer","nullable":true},"images":{"type":"array","nullable":true,"items":{"type":"string"}}}},"Dates":{"type":"object","properties":{"delivery_date":{"type":"string","nullable":true},"order_created":{"type":"string","nullable":true}}},"BagReturnableCancelableStatus":{"type":"object","properties":{"is_returnable":{"type":"boolean"},"is_active":{"type":"boolean"},"can_be_cancelled":{"type":"boolean"},"enable_tracking":{"type":"boolean"},"is_customer_return_allowed":{"type":"boolean"}},"required":["can_be_cancelled","enable_tracking","is_active","is_customer_return_allowed","is_returnable"]},"BagUnit":{"type":"object","properties":{"bag_type":{"type":"string","nullable":true},"gst":{"$ref":"#/components/schemas/GSTDetailsData"},"financial_breakup":{"type":"array","items":{"$ref":"#/components/schemas/FinancialBreakup"}},"bag_expiry_date":{"type":"string","nullable":true},"bag_status":{"type":"array","items":{"$ref":"#/components/schemas/BagStatusHistory"}},"current_operational_status":{"$ref":"#/components/schemas/BagStatusHistory"},"article":{"$ref":"#/components/schemas/Article"},"brand":{"$ref":"#/components/schemas/ShipmentListingBrand"},"affiliate_bag_details":{"$ref":"#/components/schemas/AffiliateBagDetails"},"item":{"$ref":"#/components/schemas/PlatformItem"},"reasons":{"type":"array","items":{"type":"object"},"nullable":true},"product_quantity":{"type":"integer"},"can_return":{"type":"boolean","nullable":true},"display_name":{"type":"string","nullable":true},"can_cancel":{"type":"boolean","nullable":true},"size":{"type":"string","nullable":true},"line_number":{"type":"integer","nullable":true},"meta":{"type":"object","nullable":true},"prices":{"$ref":"#/components/schemas/Prices"},"dates":{"$ref":"#/components/schemas/Dates"},"current_status":{"$ref":"#/components/schemas/BagStatusHistory"},"bag_id":{"type":"integer"},"entity_type":{"type":"string","nullable":true},"status":{"$ref":"#/components/schemas/BagReturnableCancelableStatus"}},"required":["bag_id","current_operational_status","current_status","financial_breakup","product_quantity","status"]},"ShipmentItemFulFillingStore":{"type":"object","properties":{"phone":{"type":"string","nullable":true},"brand_store_tags":{"type":"array","items":{"type":"string"},"nullable":true},"pincode":{"type":"string","nullable":true},"meta":{"type":"object","nullable":true},"address":{"type":"string","nullable":true},"address1":{"type":"string","nullable":true},"display_address":{"type":"string","nullable":true},"location_type":{"type":"string","nullable":true},"id":{"type":"integer"},"code":{"type":"string"},"store_email":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"state":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"tags":{"type":"array","nullable":true,"items":{"type":"string"}}},"required":["code","id"]},"OrderingCurrency":{"type":"object","properties":{"currency_code":{"type":"string"},"currency_name":{"type":"string"},"currency_symbol":{"type":"string"},"currency_sub_unit":{"type":"string"}}},"CurrencyInfo":{"type":"object","properties":{"ordering_currency":{"$ref":"#/components/schemas/OrderingCurrency"},"conversion_rate":{"$ref":"#/components/schemas/ConversionRate"}}},"ShipmentItem":{"type":"object","properties":{"order_date":{"type":"string","nullable":true},"order_created_ts":{"type":"string","nullable":true},"shipment_status":{"$ref":"#/components/schemas/ShipmentStatus"},"user":{"$ref":"#/components/schemas/UserDataInfo"},"estimated_sla_time":{"type":"string","nullable":true},"estimated_sla_ts":{"type":"string","nullable":true},"delivery_address":{"$ref":"#/components/schemas/PlatformDeliveryAddress"},"channel":{"$ref":"#/components/schemas/ShipmentListingChannel"},"previous_shipment_id":{"type":"string","nullable":true},"lock_status":{"type":"boolean","nullable":true},"invoice_id":{"type":"string","nullable":true},"payment_methods":{"type":"object","nullable":true},"status_created_at":{"type":"string"},"status_created_ts":{"type":"string"},"display_name":{"type":"string","nullable":true},"bags":{"type":"array","items":{"$ref":"#/components/schemas/BagUnit"}},"fulfilling_store":{"$ref":"#/components/schemas/ShipmentItemFulFillingStore"},"meta":{"type":"object","additionalProperties":true},"payment_mode":{"type":"string","nullable":true},"can_process":{"type":"boolean","nullable":true},"prices":{"$ref":"#/components/schemas/Prices"},"order_id":{"type":"string"},"ordering_channnel":{"type":"string","nullable":true},"shipment_id":{"type":"string","nullable":true},"customer_note":{"type":"string","nullable":true},"total_bags":{"type":"integer","nullable":true},"shipment_created_at":{"type":"string"},"mode_of_payment":{"type":"string"},"shipment_created_ts":{"type":"string"},"currency":{"$ref":"#/components/schemas/Currency"},"currency_info":{"$ref":"#/components/schemas/CurrencyInfo"}},"required":["order_id","shipment_created_at","total_bags"]},"ShipmentInternalPlatformViewResponse":{"type":"object","properties":{"total_count":{"type":"integer","nullable":true},"message":{"type":"string","nullable":true},"success":{"type":"boolean","nullable":true},"items":{"type":"array","items":{"$ref":"#/components/schemas/ShipmentItem"}},"lane":{"type":"string","nullable":true},"page":{"$ref":"#/components/schemas/Page"}},"required":[]},"TrackingList":{"type":"object","properties":{"is_passed":{"type":"boolean","nullable":true},"text":{"type":"string"},"is_current":{"type":"boolean","nullable":true},"time":{"type":"string","nullable":true},"created_ts":{"type":"string","nullable":true},"status":{"type":"string"}},"required":["status","text"]},"InvoiceInfo":{"type":"object","properties":{"store_invoice_id":{"type":"string","nullable":true},"invoice_url":{"type":"string","nullable":true},"updated_date":{"type":"string","nullable":true},"external_invoice_id":{"type":"string","nullable":true},"label_url":{"type":"string","nullable":true},"credit_note_id":{"type":"string","nullable":true},"links":{"type":"object","additionalProperties":true}}},"OrderDetailsData":{"type":"object","properties":{"order_date":{"type":"string","nullable":true},"created_ts":{"type":"string","nullable":true},"tax_details":{"type":"object","nullable":true},"cod_charges":{"type":"string","nullable":true},"source":{"type":"string","nullable":true},"fynd_order_id":{"type":"string"},"affiliate_id":{"type":"string","nullable":true},"ordering_channel_logo":{"type":"object","nullable":true},"order_value":{"type":"string","nullable":true},"ordering_channel":{"type":"string","nullable":true},"meta":{"type":"object","additionalProperties":true}},"required":["fynd_order_id"]},"UserDetailsData":{"type":"object","properties":{"phone":{"type":"string"},"pincode":{"type":"string"},"address":{"type":"string"},"area":{"type":"string","nullable":true},"address_type":{"type":"string","nullable":true},"country":{"type":"string"},"email":{"type":"string","nullable":true},"address1":{"type":"string","nullable":true},"landmark":{"type":"string","nullable":true},"state":{"type":"string"},"name":{"type":"string"},"city":{"type":"string"},"state_code":{"type":"string"},"country_iso_code":{"type":"string"},"country_phone_code":{"type":"string"},"display_address":{"type":"string","nullable":true}},"required":["address","city","country","name","phone","pincode","state"]},"PhoneDetails":{"type":"object","properties":{"country_code":{"type":"integer","nullable":true},"number":{"type":"string","nullable":true}}},"OrderingStoreDetails":{"type":"object","properties":{"phone":{"type":"string","nullable":true},"pincode":{"type":"string","nullable":true},"meta":{"type":"object","nullable":true},"address":{"type":"string","nullable":true},"address1":{"type":"string","nullable":true},"display_address":{"type":"string","nullable":true},"id":{"type":"integer","nullable":true},"code":{"type":"string","nullable":true},"store_name":{"type":"string","nullable":true},"country":{"type":"string","nullable":true},"contact_person":{"type":"string","nullable":true},"state":{"type":"string","nullable":true},"city":{"type":"string","nullable":true}}},"DPDetailsData":{"type":"object","properties":{"pincode":{"type":"string","nullable":true},"track_url":{"type":"string","nullable":true},"eway_bill_id":{"type":"string","nullable":true},"id":{"type":"integer","nullable":true},"country":{"type":"string","nullable":true},"awb_no":{"type":"string","nullable":true},"gst_tag":{"type":"string","nullable":true},"name":{"type":"string","nullable":true}}},"BuyerDetails":{"type":"object","properties":{"ajio_site_id":{"type":"string","nullable":true},"pincode":{"type":"integer"},"address":{"type":"string","nullable":true},"gstin":{"type":"string"},"name":{"type":"string"},"state":{"type":"string"},"city":{"type":"string"}},"required":["address","city","gstin","name","pincode","state"]},"DebugInfo":{"type":"object","properties":{"stormbreaker_uuid":{"type":"string","nullable":true}}},"EinvoiceInfo":{"type":"object","properties":{"credit_note":{"type":"object","nullable":true},"invoice":{"type":"object","nullable":true}}},"Formatted":{"type":"object","properties":{"max":{"type":"string","nullable":true},"min":{"type":"string","nullable":true}}},"ShipmentTags":{"type":"object","properties":{"slug":{"type":"string","nullable":true},"entity_type":{"type":"string","nullable":true},"display_text":{"type":"string","nullable":true}}},"LockData":{"type":"object","properties":{"locked":{"type":"boolean","nullable":true},"mto":{"type":"boolean","nullable":true},"lock_message":{"type":"string","nullable":true}}},"ShipmentTimeStamp":{"type":"object","properties":{"max":{"type":"integer","nullable":true},"min":{"type":"integer","nullable":true}}},"ShipmentMeta":{"type":"object","additionalProperties":true,"properties":{"tracking_url":{"type":"string","nullable":true},"estimated_delivery_date":{"type":"string","nullable":true},"same_store_available":{"type":"boolean"},"b2b_buyer_details":{"$ref":"#/components/schemas/BuyerDetails"},"formatted":{"$ref":"#/components/schemas/Formatted"},"debug_info":{"$ref":"#/components/schemas/DebugInfo"},"return_awb_number":{"type":"string","nullable":true},"is_self_ship":{"type":"boolean","nullable":true},"box_type":{"type":"string","nullable":true},"einvoice_info":{"$ref":"#/components/schemas/EinvoiceInfo"},"return_affiliate_shipment_id":{"type":"string","nullable":true},"parent_dp_id":{"type":"string","nullable":true},"shipment_weight":{"type":"number","nullable":true},"dimension":{"$ref":"#/components/schemas/Dimensions"},"dp_options":{"type":"object","nullable":true},"assign_dp_from_sb":{"type":"boolean","nullable":true},"due_date":{"type":"string","nullable":true},"store_invoice_updated_date":{"type":"string","nullable":true},"forward_affiliate_shipment_id":{"type":"string","nullable":true},"return_store_node":{"type":"integer","nullable":true},"fulfilment_priority_text":{"type":"string","nullable":true},"shipment_tags":{"type":"array","items":{"$ref":"#/components/schemas/ShipmentTags"}},"external":{"type":"object","nullable":true},"awb_number":{"type":"string","nullable":true},"lock_data":{"$ref":"#/components/schemas/LockData"},"order_type":{"type":"string","nullable":true},"ewaybill_info":{"type":"object","nullable":true},"dp_id":{"type":"string","nullable":true},"shipment_volumetric_weight":{"type":"number","nullable":true},"marketplace_store_id":{"type":"string","nullable":true},"return_details":{"type":"object","nullable":true},"dp_sort_key":{"type":"string","nullable":true},"packaging_name":{"type":"string","nullable":true},"timestamp":{"$ref":"#/components/schemas/ShipmentTimeStamp"},"auto_trigger_dp_assignment_acf":{"type":"boolean","nullable":true},"dp_name":{"type":"string","nullable":true},"po_number":{"type":"string","nullable":true},"weight":{"type":"integer"},"b2c_buyer_details":{"type":"object","nullable":true},"forward_affiliate_order_id":{"type":"string","nullable":true},"return_affiliate_order_id":{"type":"string","nullable":true},"bag_weight":{"type":"object","nullable":true},"refund_to":{"type":"string","nullable":true}},"required":["same_store_available","weight"]},"PDFLinks":{"type":"object","properties":{"invoice_type":{"type":"string"},"label_a6":{"type":"string","nullable":true},"invoice":{"type":"string","nullable":true},"label_pos":{"type":"string","nullable":true},"invoice_a6":{"type":"string","nullable":true},"b2b":{"type":"string","nullable":true},"label":{"type":"string","nullable":true},"label_a4":{"type":"string","nullable":true},"label_type":{"type":"string"},"invoice_export":{"type":"string","nullable":true},"credit_note_url":{"type":"string","nullable":true},"delivery_challan_a4":{"type":"string","nullable":true},"label_export":{"type":"string","nullable":true},"invoice_a4":{"type":"string","nullable":true},"invoice_pos":{"type":"string","nullable":true},"po_invoice":{"type":"string","nullable":true}},"required":["invoice_type","label_type"]},"AffiliateDetails":{"type":"object","properties":{"shipment_meta":{"$ref":"#/components/schemas/ShipmentMeta"},"affiliate_meta":{"$ref":"#/components/schemas/AffiliateMeta"},"affiliate_shipment_id":{"type":"string"},"company_affiliate_tag":{"type":"string","nullable":true},"affiliate_order_id":{"type":"string"},"pdf_links":{"$ref":"#/components/schemas/PDFLinks"},"config":{"$ref":"#/components/schemas/AffiliateConfig"},"affiliate_id":{"type":"string","nullable":true},"affiliate_store_id":{"type":"string"},"affiliate_bag_id":{"type":"string"},"ad_id":{"type":"string","nullable":true}},"required":["affiliate_bag_id","affiliate_meta","affiliate_order_id","affiliate_shipment_id","affiliate_store_id","shipment_meta"]},"BagConfigs":{"type":"object","properties":{"is_returnable":{"type":"boolean"},"allow_force_return":{"type":"boolean"},"is_active":{"type":"boolean"},"can_be_cancelled":{"type":"boolean"},"enable_tracking":{"type":"boolean"},"is_customer_return_allowed":{"type":"boolean"}},"required":["allow_force_return","can_be_cancelled","enable_tracking","is_active","is_customer_return_allowed","is_returnable"]},"OrderBagArticle":{"type":"object","properties":{"identifiers":{"type":"object","nullable":true},"return_config":{"$ref":"#/components/schemas/ReturnConfig"},"uid":{"type":"string","nullable":true},"size":{"type":"string","nullable":true}}},"OrderBrandName":{"type":"object","properties":{"logo":{"type":"string","nullable":true},"company":{"type":"integer","nullable":true},"id":{"type":"integer"},"created_on":{"type":"string","nullable":true},"brand_name":{"type":"string","nullable":true},"modified_on":{"type":"string","nullable":true}},"required":["id"]},"AffiliateBagsDetails":{"type":"object","properties":{"affiliate_bag_id":{"type":"string","nullable":true},"coupon_code":{"type":"string","nullable":true},"affiliate_meta":{"$ref":"#/components/schemas/AffiliateMeta"}}},"BagPaymentMethods":{"type":"object","properties":{"mode":{"type":"string","nullable":true},"amount":{"type":"number","nullable":true}}},"DiscountRules":{"type":"object","properties":{"value":{"type":"integer","nullable":true},"type":{"type":"string","nullable":true}}},"ItemCriterias":{"type":"object","properties":{"item_brand":{"type":"array","nullable":true,"items":{"type":"integer"}}}},"AppliedPromos":{"type":"object","properties":{"promotion_type":{"type":"string","nullable":true},"promotion_name":{"type":"string","nullable":true},"discount_rules":{"type":"array","items":{"$ref":"#/components/schemas/DiscountRules"}},"amount":{"type":"number","nullable":true},"article_quantity":{"type":"integer","nullable":true},"buy_rules":{"type":"array","items":{"$ref":"#/components/schemas/BuyRules"}},"promo_id":{"type":"string","nullable":true},"mrp_promotion":{"type":"boolean","nullable":true}}},"CurrentStatus":{"type":"object","properties":{"store_id":{"type":"integer","nullable":true},"delivery_awb_number":{"type":"string","nullable":true},"kafka_sync":{"type":"boolean","nullable":true},"delivery_partner_id":{"type":"integer","nullable":true},"state_type":{"type":"string","nullable":true},"state_id":{"type":"integer","nullable":true},"id":{"type":"integer"},"created_at":{"type":"string","format":"date-time","nullable":true},"created_ts":{"type":"string","format":"date-time","nullable":true},"shipment_id":{"type":"string","nullable":true},"updated_at":{"type":"string","nullable":true,"format":"date-time"},"bag_state_mapper":{"$ref":"#/components/schemas/BagStateMapper"},"bag_id":{"type":"integer","nullable":true},"status":{"type":"string","nullable":true}},"required":["id"]},"OrderBags":{"type":"object","properties":{"gst_details":{"$ref":"#/components/schemas/GSTDetailsData"},"bag_status":{"type":"array","items":{"$ref":"#/components/schemas/BagStatusHistory"}},"parent_promo_bags":{"type":"object","nullable":true},"financial_breakup":{"$ref":"#/components/schemas/FinancialBreakup"},"bag_configs":{"$ref":"#/components/schemas/BagConfigs"},"seller_identifier":{"type":"string","nullable":true},"delivery_address":{"$ref":"#/components/schemas/PlatformDeliveryAddress"},"article":{"$ref":"#/components/schemas/OrderBagArticle"},"brand":{"$ref":"#/components/schemas/OrderBrandName"},"group_id":{"type":"string","nullable":true},"affiliate_bag_details":{"$ref":"#/components/schemas/AffiliateBagsDetails"},"item":{"$ref":"#/components/schemas/PlatformItem"},"payment_methods":{"type":"array","items":{"$ref":"#/components/schemas/BagPaymentMethods"}},"quantity":{"type":"integer","nullable":true},"identifier":{"type":"string","nullable":true},"can_return":{"type":"boolean","nullable":true},"can_cancel":{"type":"boolean","nullable":true},"display_name":{"type":"string","nullable":true},"line_number":{"type":"integer","nullable":true},"meta":{"type":"object","additionalProperties":true},"applied_promos":{"type":"array","items":{"$ref":"#/components/schemas/AppliedPromos"}},"prices":{"$ref":"#/components/schemas/Prices"},"current_status":{"$ref":"#/components/schemas/CurrentStatus"},"bag_id":{"type":"integer"},"entity_type":{"type":"string","nullable":true},"is_parent":{"type":"boolean","nullable":true}},"required":["bag_id"]},"FulfillingStore":{"type":"object","properties":{"phone":{"type":"string"},"pincode":{"type":"string"},"meta":{"type":"object"},"address":{"type":"string"},"address1":{"type":"string","nullable":true},"display_address":{"type":"string","nullable":true},"id":{"type":"integer"},"code":{"type":"string"},"store_name":{"type":"string"},"country":{"type":"string"},"fulfillment_channel":{"type":"string"},"contact_person":{"type":"string"},"state":{"type":"string"},"city":{"type":"string"}},"required":["address","city","code","contact_person","country","fulfillment_channel","id","meta","phone","pincode","state","store_name"]},"ShipmentPayments":{"type":"object","properties":{"mode":{"type":"string","nullable":true},"logo":{"type":"string","nullable":true},"source":{"type":"string","nullable":true}}},"ShipmentStatusData":{"type":"object","properties":{"meta":{"type":"object","nullable":true},"bag_list":{"type":"array","nullable":true,"items":{"type":"string"}},"id":{"type":"integer","nullable":true},"created_at":{"type":"string","nullable":true},"created_ts":{"type":"string","nullable":true},"shipment_id":{"type":"string","nullable":true},"status":{"type":"string","nullable":true},"display_name":{"type":"string","nullable":true},"current_shipment_status":{"type":"string","nullable":true},"status_created_at":{"type":"string","nullable":true}}},"ShipmentLockDetails":{"type":"object","properties":{"lock_status":{"type":"boolean","nullable":true},"lock_message":{"type":"string","nullable":true},"action_to_status":{"type":"object","nullable":true}}},"PlatformShipment":{"type":"object","properties":{"picked_date":{"type":"string","nullable":true},"tracking_list":{"type":"array","items":{"$ref":"#/components/schemas/TrackingList"}},"invoice":{"$ref":"#/components/schemas/InvoiceInfo"},"shipment_status":{"type":"string","nullable":true},"gst_details":{"$ref":"#/components/schemas/GSTDetailsData"},"delivery_slot":{"type":"object","nullable":true},"order":{"$ref":"#/components/schemas/OrderDetailsData"},"user":{"$ref":"#/components/schemas/UserDataInfo"},"enable_dp_tracking":{"type":"boolean","nullable":true},"custom_message":{"type":"string","nullable":true},"estimated_sla_time":{"type":"string","nullable":true},"estimated_sla_ts":{"type":"string","nullable":true},"can_update_dimension":{"type":"boolean","nullable":true},"shipment_images":{"type":"array","nullable":true,"items":{"type":"string"}},"delivery_details":{"$ref":"#/components/schemas/UserDetailsData"},"billing_details":{"$ref":"#/components/schemas/UserDetailsData"},"forward_shipment_id":{"type":"string","nullable":true},"fulfilment_priority":{"type":"integer","nullable":true},"shipment_details":{"$ref":"#/components/schemas/ShipmentLockDetails"},"custom_meta":{"type":"array","nullable":true,"items":{"type":"object"}},"shipment_quantity":{"type":"integer","nullable":true},"company_details":{"$ref":"#/components/schemas/CompanyDetails"},"ordering_store":{"$ref":"#/components/schemas/OrderingStoreDetails"},"lock_status":{"type":"boolean","nullable":true},"platform_logo":{"type":"string","nullable":true},"user_agent":{"type":"string","nullable":true},"dp_details":{"$ref":"#/components/schemas/DPDetailsData"},"invoice_id":{"type":"string","nullable":true},"payment_methods":{"type":"object","nullable":true},"coupon":{"type":"object","nullable":true},"affiliate_details":{"$ref":"#/components/schemas/AffiliateDetails"},"priority_text":{"type":"string","nullable":true},"bag_status_history":{"type":"array","items":{"$ref":"#/components/schemas/BagStatusHistory"}},"is_dp_assign_enabled":{"type":"boolean","nullable":true},"bags":{"type":"array","items":{"$ref":"#/components/schemas/OrderBags"}},"dp_assignment":{"type":"boolean","nullable":true},"total_items":{"type":"integer","nullable":true},"fulfilling_store":{"$ref":"#/components/schemas/FulfillingStore"},"meta":{"type":"object","additionalProperties":true},"pdf_links":{"type":"object"},"payment_mode":{"type":"string","nullable":true},"packaging_type":{"type":"string","nullable":true},"journey_type":{"type":"string","nullable":true},"prices":{"$ref":"#/components/schemas/Prices"},"vertical":{"type":"string","nullable":true},"shipment_id":{"type":"string"},"payments":{"$ref":"#/components/schemas/ShipmentPayments"},"operational_status":{"type":"string","nullable":true},"status":{"$ref":"#/components/schemas/ShipmentStatusData"},"total_bags":{"type":"integer","nullable":true},"shipment_created_at":{"type":"string","nullable":true},"shipment_created_ts":{"type":"string","nullable":true},"currency":{"$ref":"#/components/schemas/Currency"},"currency_info":{"$ref":"#/components/schemas/CurrencyInfo"},"previous_shipment_id":{"type":"string","nullable":true},"shipment_update_time":{"type":"number","nullable":true},"rto_address":{"$ref":"#/components/schemas/PlatformDeliveryAddress"},"credit_note_id":{"type":"string","nullable":true},"is_self_ship":{"type":"boolean","nullable":true},"mode_of_payment":{"type":"string","nullable":true}},"required":["shipment_id"]},"ShipmentInfoResponse":{"type":"object","properties":{"message":{"type":"string","nullable":true},"success":{"type":"boolean"},"shipments":{"type":"array","items":{"$ref":"#/components/schemas/PlatformShipment"}}},"required":["success"]},"TaxDetails":{"type":"object","properties":{"pan_no":{"type":"string","nullable":true},"gstin":{"type":"string","nullable":true}}},"OrderData":{"type":"object","properties":{"order_date":{"type":"string"},"created_ts":{"type":"string"},"tax_details":{"$ref":"#/components/schemas/TaxDetails"},"meta":{"type":"object","additionalProperties":true},"fynd_order_id":{"type":"string"},"prices":{"$ref":"#/components/schemas/Prices"},"payment_methods":{"type":"object","nullable":true}},"required":["fynd_order_id","order_date"]},"OrderDetailsResponse":{"type":"object","properties":{"order":{"$ref":"#/components/schemas/OrderData"},"success":{"type":"boolean"},"shipments":{"type":"array","items":{"$ref":"#/components/schemas/PlatformShipment"}}},"required":["success"]},"SubLane":{"type":"object","properties":{"value":{"type":"string"},"text":{"type":"string"},"total_items":{"type":"integer"},"actions":{"type":"array","items":{"type":"object"}},"index":{"type":"integer"}}},"SuperLane":{"type":"object","properties":{"value":{"type":"string"},"options":{"type":"array","items":{"$ref":"#/components/schemas/SubLane"}},"text":{"type":"string"},"total_items":{"type":"integer"}},"required":["text","value"]},"LaneConfigResponse":{"type":"object","properties":{"super_lanes":{"type":"array","items":{"$ref":"#/components/schemas/SuperLane"}}}},"PlatformBreakupValues":{"type":"object","properties":{"value":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"display":{"type":"string","nullable":true}}},"PlatformChannel":{"type":"object","properties":{"logo":{"type":"string","nullable":true},"name":{"type":"string","nullable":true}}},"PlatformOrderItems":{"type":"object","properties":{"breakup_values":{"type":"array","items":{"$ref":"#/components/schemas/PlatformBreakupValues"}},"total_order_value":{"type":"number","nullable":true},"meta":{"type":"object","nullable":true},"order_created_time":{"type":"string","nullable":true},"order_created_ts":{"type":"string","nullable":true},"payment_mode":{"type":"string","nullable":true},"shipments":{"type":"array","items":{"$ref":"#/components/schemas/PlatformShipment"}},"order_id":{"type":"string","nullable":true},"channel":{"$ref":"#/components/schemas/PlatformChannel"},"user_info":{"$ref":"#/components/schemas/UserDataInfo"},"order_value":{"type":"number","nullable":true},"currency":{"$ref":"#/components/schemas/Currency"},"currency_info":{"$ref":"#/components/schemas/CurrencyInfo"}}},"OrderListingResponse":{"type":"object","properties":{"total_count":{"type":"integer","nullable":true},"message":{"type":"string","nullable":true},"success":{"type":"boolean","nullable":true},"items":{"type":"array","items":{"$ref":"#/components/schemas/PlatformOrderItems"}},"lane":{"type":"string","nullable":true},"page":{"$ref":"#/components/schemas/Page"}},"required":[]},"PlatformTrack":{"type":"object","properties":{"last_location_recieved_at":{"type":"string"},"meta":{"type":"object"},"raw_status":{"type":"string"},"updated_at":{"type":"string"},"updated_time":{"type":"string"},"awb":{"type":"string"},"shipment_type":{"type":"string"},"status":{"type":"string"},"reason":{"type":"string"},"account_name":{"type":"string"}}},"PlatformShipmentTrack":{"type":"object","properties":{"meta":{"type":"object"},"results":{"type":"array","items":{"$ref":"#/components/schemas/PlatformTrack"}}}},"AdvanceFilterInfo":{"type":"object","properties":{"returned":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/FiltersInfo"}},"action_centre":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/FiltersInfo"}},"unfulfilled":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/FiltersInfo"}},"filters":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/FiltersInfo"}},"processed":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/FiltersInfo"}},"applied_filters":{"type":"object","nullable":true},"page":{"type":"object","nullable":true}}},"FiltersResponse":{"type":"object","properties":{"advance_filter":{"$ref":"#/components/schemas/AdvanceFilterInfo"},"global_filter":{"type":"array","items":{"$ref":"#/components/schemas/FiltersInfo"}}}},"URL":{"type":"object","properties":{"url":{"type":"string"}}},"FileResponse":{"type":"object","properties":{"file_name":{"type":"string","description":"Name of the file"},"cdn":{"$ref":"#/components/schemas/URL"}}},"BulkActionTemplate":{"type":"object","properties":{"value":{"type":"string"},"text":{"type":"string"}}},"BulkActionTemplateResponse":{"type":"object","properties":{"template_x_slug":{"type":"array","description":"Allowed bulk action template slugs","items":{"$ref":"#/components/schemas/BulkActionTemplate"}}}},"Reason":{"type":"object","properties":{"qc_type":{"type":"array","items":{"type":"string"}},"id":{"type":"integer"},"question_set":{"type":"array","items":{"$ref":"#/components/schemas/QuestionSet"}},"display_name":{"type":"string"}}},"PlatformShipmentReasonsResponse":{"type":"object","properties":{"reasons":{"type":"array","items":{"$ref":"#/components/schemas/Reason"}},"success":{"type":"boolean"}}},"ShipmentResponseReasons":{"type":"object","properties":{"reason_id":{"type":"integer"},"reason":{"type":"string"}}},"ShipmentReasonsResponse":{"type":"object","properties":{"reasons":{"type":"array","items":{"$ref":"#/components/schemas/ShipmentResponseReasons"}},"message":{"type":"string"},"success":{"type":"boolean"}},"required":["message","reasons","success"]},"StoreAddress":{"type":"object","properties":{"phone":{"type":"string","nullable":true},"created_at":{"type":"string"},"contact_person":{"type":"string"},"pincode":{"type":"integer"},"address_type":{"type":"string"},"address1":{"type":"string"},"display_address":{"type":"string","nullable":true},"version":{"type":"string","nullable":true},"address_category":{"type":"string"},"city":{"type":"string"},"longitude":{"type":"number"},"address2":{"type":"string"},"area":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"updated_at":{"type":"string"},"country_code":{"type":"string"},"country":{"type":"string"},"landmark":{"type":"string"},"latitude":{"type":"number"},"state":{"type":"string"}},"required":["address1","address_category","address_type","city","contact_person","country","country_code","created_at","latitude","longitude","phone","pincode","state","updated_at"]},"EInvoicePortalDetails":{"type":"object","properties":{"username":{"type":"string","nullable":true},"user":{"type":"string","nullable":true},"password":{"type":"string","nullable":true}}},"StoreEinvoice":{"type":"object","properties":{"username":{"type":"string","nullable":true},"user":{"type":"string","nullable":true},"password":{"type":"string","nullable":true},"enabled":{"type":"boolean"}},"required":["enabled"]},"StoreEwaybill":{"type":"object","properties":{"enabled":{"type":"boolean","nullable":true}}},"StoreGstCredentials":{"type":"object","properties":{"e_invoice":{"$ref":"#/components/schemas/StoreEinvoice"},"e_waybill":{"$ref":"#/components/schemas/StoreEwaybill"}}},"StoreDocuments":{"type":"object","properties":{"gst":{"$ref":"#/components/schemas/Document"}}},"Store":{"type":"object","nullable":true,"properties":{"phone":{"type":"integer"},"is_active":{"type":"boolean","nullable":true},"company_id":{"type":"integer"},"alohomora_user_id":{"type":"integer","nullable":true},"created_at":{"type":"string"},"contact_person":{"type":"string"},"store_email":{"type":"string"},"is_enabled_for_recon":{"type":"boolean","nullable":true},"pincode":{"type":"string"},"mall_area":{"type":"string","nullable":true},"vat_no":{"type":"string","nullable":true},"address1":{"type":"string","nullable":true},"display_address":{"type":"string","nullable":true},"store_active_from":{"type":"string","nullable":true},"city":{"type":"string"},"name":{"type":"string"},"longitude":{"type":"number","nullable":true},"brand_store_tags":{"type":"array","nullable":true,"items":{"type":"string"}},"order_integration_id":{"type":"string","nullable":true},"parent_store_id":{"type":"integer","nullable":true},"location_type":{"type":"string"},"code":{"type":"string","nullable":true},"fulfillment_channel":{"type":"string"},"updated_at":{"type":"string","nullable":true},"store_address_json":{"$ref":"#/components/schemas/StoreAddress"},"meta":{"$ref":"#/components/schemas/StoreMeta"},"s_id":{"type":"string","nullable":true},"state":{"type":"string"},"country":{"type":"string"},"packaging_material_count":{"type":"integer","nullable":true},"is_archived":{"type":"boolean","nullable":true},"login_username":{"type":"string","nullable":true},"mall_name":{"type":"string","nullable":true},"latitude":{"type":"number","nullable":true},"address2":{"type":"string","nullable":true}},"required":["address1","city","company_id","contact_person","country","created_at","fulfillment_channel","location_type","meta","name","phone","pincode","state","store_email"]},"Attributes":{"type":"object","properties":{"primary_material":{"type":"string","nullable":true},"essential":{"type":"string","nullable":true},"marketer_name":{"type":"string","nullable":true},"primary_color":{"type":"string","nullable":true},"marketer_address":{"type":"string","nullable":true},"primary_color_hex":{"type":"string","nullable":true},"brand_name":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"gender":{"type":"array","nullable":true,"items":{"type":"string"}}}},"Item":{"type":"object","properties":{"status":{"type":"string"},"count":{"type":"integer"}}},"ArticleStatusDetails":{"type":"object","properties":{"status":{"type":"object","nullable":true}}},"Company":{"type":"object","properties":{"pan_no":{"type":"string","nullable":true},"created_on":{"type":"string","nullable":true},"id":{"type":"integer","nullable":true},"company_name":{"type":"string","nullable":true},"gst_number":{"type":"string","nullable":true},"company_type":{"type":"string","nullable":true},"modified_on":{"type":"string","nullable":true},"meta":{"type":"object","nullable":true},"business_type":{"type":"string","nullable":true},"agreement_start_date":{"type":"string","nullable":true}}},"ShipmentGstDetails":{"type":"object","nullable":true,"properties":{"value_of_good":{"type":"number","nullable":true},"gst_fee":{"type":"number","nullable":true},"brand_calculated_amount":{"type":"number","nullable":true},"tax_collected_at_source":{"type":"number","nullable":true},"gstin_code":{"type":"number","nullable":true}}},"DeliverySlotDetails":{"type":"object","nullable":true,"properties":{"slot":{"type":"string","nullable":true},"upper_bound":{"type":"string","nullable":true},"lower_bound":{"type":"string","nullable":true},"date":{"type":"string","nullable":true},"type":{"type":"string","nullable":true}}},"WeightData":{"type":"object","nullable":true,"properties":{"value":{"type":"number","nullable":true},"unit":{"type":"string","nullable":true}}},"BagDetails":{"type":"object","properties":{"bag_update_time":{"type":"number","nullable":true},"id":{"type":"string","nullable":true},"bag_id":{"type":"integer","nullable":true},"affiliate_bag_details":{"$ref":"#/components/schemas/AffiliateBagDetails"},"affiliate_details":{"$ref":"#/components/schemas/AffiliateDetails"},"applied_promos":{"type":"array","nullable":true,"items":{"type":"object"}},"article":{"$ref":"#/components/schemas/Article"},"article_details":{"$ref":"#/components/schemas/ArticleStatusDetails"},"bag_status":{"type":"array","items":{"$ref":"#/components/schemas/BagStatusHistory"}},"bag_status_history":{"$ref":"#/components/schemas/BagStatusHistory"},"brand":{"$ref":"#/components/schemas/Brand"},"company":{"$ref":"#/components/schemas/Company"},"current_operational_status":{"$ref":"#/components/schemas/BagStatusHistory"},"current_status":{"$ref":"#/components/schemas/BagStatusHistory"},"dates":{"$ref":"#/components/schemas/Dates"},"delivery_address":{"$ref":"#/components/schemas/PlatformDeliveryAddress"},"delivery_slot":{"$ref":"#/components/schemas/DeliverySlotDetails"},"display_name":{"type":"string","nullable":true},"dp_details":{"type":"object","nullable":true},"einvoice_info":{"type":"object","nullable":true},"entity_type":{"type":"string","nullable":true},"fallback_user":{"type":"object","nullable":true},"financial_breakup":{"type":"array","items":{"$ref":"#/components/schemas/FinancialBreakup"}},"fulfilling_store":{"$ref":"#/components/schemas/Store"},"fyndstore_emp":{"type":"object","nullable":true},"gst_details":{"$ref":"#/components/schemas/GSTDetailsData"},"invoice":{"$ref":"#/components/schemas/InvoiceDetails"},"item":{"$ref":"#/components/schemas/Item"},"journey_type":{"type":"string"},"line_number":{"type":"integer"},"lock_status":{"type":"boolean","nullable":true},"manifest_id":{"type":"string","nullable":true},"meta":{"type":"object","additionalProperties":true},"mode_of_payment":{"type":"string","nullable":true},"no_of_bags_order":{"type":"integer","nullable":true},"operational_status":{"type":"string","nullable":true},"order":{"$ref":"#/components/schemas/OrderDetails"},"order_integration_id":{"type":"string","nullable":true},"order_type":{"type":"string","nullable":true},"order_value":{"type":"number","nullable":true},"ordering_store":{"$ref":"#/components/schemas/Store"},"parent_promo_bags":{"type":"object","nullable":true},"payment_methods":{"type":"object","nullable":true},"payment_type":{"type":"string","nullable":true},"payments":{"type":"object","nullable":true},"prices":{"$ref":"#/components/schemas/Prices"},"qc_required":{"type":"boolean","nullable":true},"quantity":{"type":"number","nullable":true},"reasons":{"type":"array","nullable":true,"items":{"type":"object"}},"restore_coupon":{"type":"boolean","nullable":true},"restore_promos":{"type":"object","nullable":true},"rto_address":{"$ref":"#/components/schemas/PlatformDeliveryAddress"},"seller_identifier":{"type":"string","nullable":true},"shipment":{"$ref":"#/components/schemas/Shipment"},"shipment_details":{"$ref":"#/components/schemas/ShipmentDetails"},"shipment_id":{"type":"string","nullable":true},"shipment_gst":{"$ref":"#/components/schemas/ShipmentGstDetails"},"shipment_status":{"$ref":"#/components/schemas/ShipmentStatusData"},"shipment_status_history":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/ShipmentStatusData"}},"status":{"$ref":"#/components/schemas/BagReturnableCancelableStatus"},"tags":{"type":"array","nullable":true,"items":{"type":"string"}},"total_shipment_bags":{"type":"integer","nullable":true},"total_shipments_in_order":{"type":"integer","nullable":true},"transaction_type":{"type":"string","nullable":true},"type":{"type":"string","nullable":true},"updated_at":{"type":"string","nullable":true},"user":{"$ref":"#/components/schemas/UserDetails"},"weight":{"$ref":"#/components/schemas/WeightData"},"original_bag_list":{"type":"array","nullable":true,"items":{"type":"integer"}},"identifier":{"type":"string","nullable":true}}},"BagDetailsPlatformResponse":{"type":"object","properties":{"status_code":{"type":"integer"},"data":{"$ref":"#/components/schemas/BagDetails"}}},"BagsPage":{"type":"object","properties":{"item_total":{"type":"integer"},"has_next":{"type":"boolean"},"page_type":{"type":"string"},"current":{"type":"integer"},"size":{"type":"integer"}},"required":["current","has_next","item_total","page_type","size"]},"BagData":{"type":"object","nullable":true,"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/BagDetails"}},"page":{"$ref":"#/components/schemas/BagsPage"}}},"GetBagsPlatformResponse":{"type":"object","properties":{"status_code":{"type":"integer"},"data":{"$ref":"#/components/schemas/BagData"}}},"GeneratePosOrderReceiptResponse":{"type":"object","properties":{"customer_cn_receipt":{"type":"string"},"success":{"type":"boolean"},"order_id":{"type":"string"},"invoice_receipt":{"type":"string"},"payment_receipt":{"type":"string"},"merchant_cn_receipt":{"type":"string"},"payment_receipt_template":{"type":"string"},"customer_cn_receipt_template":{"type":"string"},"invoice_receipt_template":{"type":"string"}}},"Templates":{"type":"object","properties":{"text":{"type":"string"},"value":{"type":"string"}}},"AllowedTemplatesResponse":{"type":"object","properties":{"template_x_slug":{"type":"array","items":{"$ref":"#/components/schemas/Templates"}}}},"TemplateDownloadResponse":{"type":"object","properties":{"file_name":{"type":"string"},"url":{"type":"string"}}},"AddProxyReq":{"type":"object","properties":{"attached_path":{"type":"string","description":"Proxy path slug"},"proxy_url":{"type":"string","description":"The external URL for which the proxy URL will be generated"}}},"AddProxyResponse":{"type":"object","properties":{"_id":{"type":"string"},"attached_path":{"type":"string"},"proxy_url":{"type":"string"},"company_id":{"type":"string"},"application_id":{"type":"string"},"extension_id":{"type":"string"},"created_at":{"type":"string"},"modified_at":{"type":"string"}}},"RemoveProxyResponse":{"type":"object","properties":{"message":{"type":"string"},"data":{"type":"object"}}},"APIError":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"info":{"type":"string","description":"Error code description link"},"request_id":{"type":"string"},"meta":{"type":"object"}}},"PaymentGatewayConfigResponse":{"type":"object","properties":{"aggregators":{"type":"array","description":"List of all speceific Payment options with their Details.","items":{"type":"object"}},"app_id":{"type":"string","description":"Application Id to which Payment config Mapped"},"excluded_fields":{"type":"array","description":"List of all excluded  options with their Details.","items":{"type":"string"}},"success":{"type":"boolean","description":"Response is successful or not"},"created":{"type":"boolean","description":"Response is created or not"},"display_fields":{"type":"array","description":"List of all included  options with their Details.","items":{"type":"string"}}},"required":["app_id","created","display_fields","excluded_fields","success"]},"ErrorCodeDescription":{"type":"object","properties":{"description":{"type":"string","description":"Error human understandable description."},"code":{"type":"string","description":"Error descrption code."},"success":{"type":"boolean","description":"Response is successful or not"}},"required":["code","description","success"]},"PaymentGatewayConfig":{"type":"object","properties":{"secret":{"type":"string","description":"Secret Key of the payment aggregator"},"config_type":{"type":"string","description":"Config Type of the aggregator"},"is_active":{"type":"boolean","nullable":true,"description":"Enable or Disable Flag"},"key":{"type":"string","description":"Api key of the payment aggregator"},"merchant_salt":{"type":"string","description":"Merchant key of the payment aggregator"}},"required":["config_type","key","merchant_salt","secret"]},"PaymentGatewayConfigRequest":{"type":"object","properties":{"app_id":{"type":"string","description":"Application Id to which Payment config Mapped"},"is_active":{"type":"boolean","nullable":true,"description":"Enable or Disable Flag"},"aggregator_name":{"$ref":"#/components/schemas/PaymentGatewayConfig"}},"required":["app_id"]},"PaymentGatewayToBeReviewed":{"type":"object","properties":{"aggregator":{"type":"array","description":"List of added payment gateway","items":{"type":"string"}},"success":{"type":"boolean","description":"Response is successful or not"}},"required":["aggregator","success"]},"ErrorCodeAndDescription":{"type":"object","properties":{"description":{"type":"string","description":"Error human understandable description."},"code":{"type":"string","description":"Error descrption code."}},"required":["code","description"]},"HttpErrorCodeAndResponse":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/ErrorCodeAndDescription"},"success":{"type":"boolean","description":"Response is successful or not"}},"required":["error","success"]},"IntentAppErrorList":{"type":"object","properties":{"package_name":{"type":"string","nullable":true,"description":"package_name"},"code":{"type":"string","nullable":true,"description":"code"}}},"ProductCODData":{"type":"object","properties":{"items":{"type":"object","nullable":true,"description":"item id with its cod availability."},"cod_charges":{"$ref":"#/components/schemas/CODChargesLimitsResponse"}}},"CODChargesLimitsResponse":{"type":"object","properties":{"max_cart_value":{"type":"number","nullable":true,"description":"max allowed cart value for cod order."},"min_cart_value":{"type":"number","nullable":true,"description":"min allowed cart value for cod order."},"cod_charge":{"type":"number","nullable":true,"description":"cod charges to be applied on order."}}},"PaymentModeLogo":{"type":"object","properties":{"large":{"type":"string","format":"url","description":"large"},"small":{"type":"string","format":"url","description":"smalll"}},"required":["large","small"]},"IntentApp":{"type":"object","properties":{"package_name":{"type":"string","nullable":true,"description":"package_name"},"display_name":{"type":"string","nullable":true,"description":"display_name"},"code":{"type":"string","nullable":true,"description":"code"},"logos":{"$ref":"#/components/schemas/PaymentModeLogo"}}},"PaymentModeList":{"type":"object","properties":{"remaining_limit":{"type":"number","nullable":true,"description":"Remaining limit"},"card_brand":{"type":"string","nullable":true,"description":"card_brand"},"card_fingerprint":{"type":"string","nullable":true,"description":"card_fingerprint"},"merchant_code":{"type":"string","nullable":true,"description":"merchant code"},"intent_flow":{"type":"boolean","nullable":true,"description":"intent_flow"},"code":{"type":"string","nullable":true,"description":"code"},"card_issuer":{"type":"string","nullable":true,"description":"card_issuer"},"cod_limit_per_order":{"type":"number","nullable":true,"description":"Cod limit per order"},"card_reference":{"type":"string","nullable":true,"description":"card_reference"},"card_type":{"type":"string","nullable":true,"description":"card_type"},"card_isin":{"type":"string","nullable":true,"description":"card_isin"},"exp_month":{"type":"integer","format":"int32","nullable":true,"description":"exp_month"},"fynd_vpa":{"type":"string","nullable":true,"description":"fynd_vpa"},"card_number":{"type":"string","nullable":true,"description":"card_number"},"display_priority":{"type":"integer","format":"int32","nullable":true,"description":"Dispaly Priority"},"display_name":{"type":"string","nullable":true,"description":"display name"},"card_id":{"type":"string","nullable":true,"description":"card_id"},"retry_count":{"type":"integer","format":"int32","nullable":true,"description":"retry_count"},"card_name":{"type":"string","nullable":true,"description":"card_name"},"timeout":{"type":"integer","format":"int32","nullable":true,"description":"timeout"},"intent_app_error_dict_list":{"type":"array","nullable":true,"description":"intent_app_error_dict_list","items":{"$ref":"#/components/schemas/IntentAppErrorList"}},"card_brand_image":{"type":"string","format":"url","nullable":true,"description":"card_brand_image"},"expired":{"type":"boolean","nullable":true,"description":"expired"},"logo_url":{"$ref":"#/components/schemas/PaymentModeLogo"},"card_token":{"type":"string","nullable":true,"description":"card_token"},"aggregator_name":{"type":"string","description":"aggregator_name"},"cod_charges":{"type":"number","nullable":true,"description":"cod charges to be applied on order."},"product_cod_data":{"$ref":"#/components/schemas/ProductCODData"},"cod_limit":{"type":"number","nullable":true,"description":"cod limit"},"intent_app":{"type":"array","nullable":true,"description":"intent_app","items":{"$ref":"#/components/schemas/IntentApp"}},"nickname":{"type":"string","nullable":true,"description":"nickname"},"compliant_with_tokenisation_guidelines":{"type":"boolean","nullable":true,"description":"If card is tokenised or not"},"exp_year":{"type":"integer","format":"int32","nullable":true,"description":"exp_year"},"name":{"type":"string","nullable":true,"description":"name"},"intent_app_error_list":{"type":"array","nullable":true,"description":"intent_app_error_list","items":{"type":"string"}}},"required":["aggregator_name"]},"RootPaymentMode":{"type":"object","properties":{"list":{"type":"array","description":"Payment mode","items":{"$ref":"#/components/schemas/PaymentModeList"}},"display_priority":{"type":"integer","format":"int32","description":"Dispaly Priority"},"add_card_enabled":{"type":"boolean","nullable":true,"description":"Annonymous card flag"},"save_card":{"type":"boolean","nullable":true,"description":"Card save or not"},"is_pay_by_card_pl":{"type":"boolean","nullable":true,"description":"This flag will be true in case of Payment link payment through card"},"display_name":{"type":"string","description":"Payment mode display name"},"anonymous_enable":{"type":"boolean","nullable":true,"description":"Annonymous card flag"},"name":{"type":"string","description":"Payment mode name"},"aggregator_name":{"type":"string","nullable":true,"description":"Dispaly Priority"}},"required":["display_name","display_priority","name"]},"PaymentOptions":{"type":"object","properties":{"payment_option":{"type":"array","description":"Payment options","items":{"$ref":"#/components/schemas/RootPaymentMode"}}},"required":["payment_option"]},"AggregatorRoute":{"type":"object","nullable":true,"properties":{"data":{"type":"object","nullable":true,"description":"Data"},"payment_flow_data":{"type":"string","nullable":true,"description":"payment_flow_data"},"payment_flow":{"type":"string","nullable":true,"description":"payment_flow"},"api_link":{"type":"string","format":"url","nullable":true,"description":"api_link"}}},"PaymentFlow":{"type":"object","properties":{"bqr_razorpay":{"$ref":"#/components/schemas/AggregatorRoute"},"fynd":{"$ref":"#/components/schemas/AggregatorRoute"},"epaylater":{"$ref":"#/components/schemas/AggregatorRoute"},"razorpay":{"$ref":"#/components/schemas/AggregatorRoute"},"juspay":{"$ref":"#/components/schemas/AggregatorRoute"},"ajiodhan":{"$ref":"#/components/schemas/AggregatorRoute"},"simpl":{"$ref":"#/components/schemas/AggregatorRoute"},"rupifi":{"$ref":"#/components/schemas/AggregatorRoute"},"mswipe":{"$ref":"#/components/schemas/AggregatorRoute"},"stripe":{"$ref":"#/components/schemas/AggregatorRoute"},"ccavenue":{"$ref":"#/components/schemas/AggregatorRoute"},"payubiz":{"$ref":"#/components/schemas/AggregatorRoute"},"jiopay":{"$ref":"#/components/schemas/AggregatorRoute"}}},"PaymentOptionAndFlow":{"type":"object","properties":{"payment_option":{"type":"array","description":"Payment options","items":{"$ref":"#/components/schemas/RootPaymentMode"}},"payment_flows":{"$ref":"#/components/schemas/PaymentFlow"}},"required":["payment_flows","payment_option"]},"AdvanceObject":{"type":"object","nullable":true,"description":"Advance Payment Config - object can change according to config","properties":{"is_active":{"type":"boolean","nullable":true,"description":"Is Advance Payment active"},"amount":{"type":"number","format":"float","nullable":true,"description":"Amount for Payment Breakdown"},"time_unit":{"type":"string","nullable":true,"description":"Time unit for refunds"},"description":{"type":"string","nullable":true,"description":"The description for Advance Payment (user configured)"},"display_name":{"type":"string","nullable":true,"description":"The display name for Advance payment"},"prepayment_type":{"type":"string","nullable":true,"description":"Type of prepayment value"},"prepayment_value":{"type":"number","format":"float","nullable":true,"description":"Value for prepayment in advance payment"},"cancellation_type":{"type":"string","nullable":true,"description":"Type of cancellation"},"refund_time_limit":{"type":"number","format":"float","nullable":true,"description":"time limit for processing refund"},"all_prepayment_type":{"type":"array","description":"All available types of prepayment","nullable":true,"items":{"type":"string","nullable":true,"description":"Contains a valid prepayment type"}},"allow_custom_advance_amount":{"type":"boolean","nullable":true,"description":"Is custom advance amount allowed?"}}},"SplitObject":{"type":"object","nullable":true,"description":"Split Payment config","properties":{"total_number_of_splits":{"type":"number","format":"integer","nullable":true,"description":"Maximum amount of splits allowed"},"splits_remaining":{"type":"number","nullable":true,"format":"integer","description":"Number of splits remaining"},"amount_remaining":{"type":"number","nullable":true,"format":"float","description":"Amount pending to be paid"}}},"AdvancePaymentObject":{"type":"object","description":"Advance Payment Object - Contains payment option data and config for advance and split payment","properties":{"name":{"type":"string","nullable":true,"description":"Name of Advance Payment Mode"},"display_priority":{"type":"number","format":"integer","nullable":true,"description":"Display Priority for Payment Option"},"payment_mode_id":{"type":"number","format":"integer","nullable":true,"description":"Payment Mode ID for Advance Payment Option"},"display_name":{"type":"string","nullable":true,"description":"Display name for Advance Payment Mode"},"list":{"type":"array","nullable":true,"description":"Payment mode","items":{"$ref":"#/components/schemas/PaymentModeList"}},"split":{"$ref":"#/components/schemas/SplitObject"},"advance":{"$ref":"#/components/schemas/AdvanceObject"}}},"PaymentModeRouteResponse":{"type":"object","properties":{"payment_options":{"$ref":"#/components/schemas/PaymentOptionAndFlow"},"success":{"type":"boolean","description":"Response is successful or not"},"payment_breakup":{"type":"object","description":"Payment Breakup for advance payment"},"advance_payment":{"type":"array","description":"Advance Payment Array","nullable":true,"items":{"$ref":"#/components/schemas/AdvancePaymentObject"}}},"required":["payment_options","success"]},"PaymentOptionsResponse":{"type":"object","properties":{"payment_options":{"$ref":"#/components/schemas/PaymentOptions"},"success":{"type":"boolean","description":"Response is successful or not"},"payment_breakup":{"type":"object","description":"Payment Breakup for advance payment"}},"required":["payment_options","success"]},"PayoutCustomer":{"type":"object","properties":{"unique_external_id":{"type":"string","nullable":true,"description":"unique_external_id"},"mobile":{"type":"string","nullable":true,"description":"Customer Mobile No"},"name":{"type":"string","nullable":true,"description":"Customer Name"},"email":{"type":"string","nullable":true,"description":"Customer Email"},"id":{"type":"integer","format":"int32","nullable":true,"description":"Customer ID"}}},"PayoutMoreAttributes":{"type":"object","properties":{"branch_name":{"type":"string","nullable":true,"description":"Branch Name"},"city":{"type":"string","nullable":true,"description":"City"},"account_no":{"type":"string","nullable":true,"description":"Account Number"},"country":{"type":"string","nullable":true,"description":"Country"},"state":{"type":"string","nullable":true,"description":"State"},"account_holder":{"type":"string","nullable":true,"description":"Account Holder Name"},"ifsc_code":{"type":"string","nullable":true,"description":"IFSC Code"},"account_type":{"type":"string","nullable":true,"description":"Account Type Saving or Current"},"bank_name":{"type":"string","nullable":true,"description":"Name of Bank"}}},"PayoutAggregator":{"type":"object","properties":{"aggregator_id":{"type":"integer","format":"int32","nullable":true,"description":"aggregator_id"},"aggregator_fund_id":{"type":"integer","format":"int32","nullable":true,"description":"aggregator_fund_id"},"payout_details_id":{"type":"integer","format":"int32","nullable":true,"description":"payout_details_id"}}},"Payout":{"type":"object","properties":{"customers":{"$ref":"#/components/schemas/PayoutCustomer"},"more_attributes":{"$ref":"#/components/schemas/PayoutMoreAttributes"},"is_default":{"type":"boolean","description":"default or not "},"payouts_aggregators":{"type":"array","items":{"$ref":"#/components/schemas/PayoutAggregator"}},"unique_transfer_no":{"type":"string","description":"display priority of the payment mode"},"is_active":{"type":"boolean","description":"Enable/DIsable Flag Payout"},"transfer_type":{"type":"string","description":"transafer type"}},"required":["customers","is_active","is_default","more_attributes","transfer_type","unique_transfer_no"]},"PayoutsResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Response is successful or not"},"items":{"type":"array","description":"contains list of PayoutSchema","items":{"$ref":"#/components/schemas/Payout"}}},"required":["items","success"]},"PayoutBankDetails":{"type":"object","properties":{"ifsc_code":{"type":"string"},"account_holder":{"type":"string"},"state":{"type":"string"},"country":{"type":"string"},"account_type":{"type":"string"},"account_no":{"type":"string"},"city":{"type":"string"},"bank_name":{"type":"string"},"branch_name":{"type":"string"},"pincode":{"type":"integer","format":"int32"}},"required":["account_type","ifsc_code"]},"PayoutRequest":{"type":"object","properties":{"aggregator":{"type":"string","description":"Aggregator Name"},"users":{"type":"object","description":"payout users object"},"unique_external_id":{"type":"string","description":"Unique Id of Payout"},"is_active":{"type":"boolean","description":"Enable or Disable Flag Payout"},"bank_details":{"$ref":"#/components/schemas/PayoutBankDetails"},"transfer_type":{"type":"string","description":"transafer type"}},"required":["aggregator","bank_details","is_active","transfer_type","unique_external_id","users"]},"PayoutResponse":{"type":"object","properties":{"payment_status":{"type":"string","description":"status of payment"},"users":{"type":"object","description":"users details object"},"aggregator":{"type":"string","description":"Aggregator Name"},"unique_transfer_no":{"type":"string","description":"unique transfer no"},"is_active":{"type":"boolean","description":"Enable or DIsable Flag Payout"},"bank_details":{"type":"object","description":"payout bank_details object"},"success":{"type":"boolean","description":"Response is successful or not"},"transfer_type":{"type":"string","description":"transfer type"},"created":{"type":"boolean","description":"created flag"},"payouts":{"type":"object","description":"payout  object"}},"required":["aggregator","bank_details","created","is_active","payment_status","payouts","success","transfer_type","unique_transfer_no","users"]},"UpdatePayoutResponse":{"type":"object","properties":{"is_default":{"type":"boolean","description":"Enable or Disable Default Payout"},"is_active":{"type":"boolean","description":"Enable or DIsable Flag Payout"},"success":{"type":"boolean","description":"Response is successful or not"}},"required":["is_active","is_default","success"]},"UpdatePayoutRequest":{"type":"object","properties":{"is_default":{"type":"boolean","description":"Enable or Disable Default Payout"},"is_active":{"type":"boolean","description":"Enable or Disable Flag Payout"},"unique_external_id":{"type":"string","description":"Unique Id of Payout"}},"required":["is_active","is_default","unique_external_id"]},"DeletePayoutResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Response is successful or not"}},"required":["success"]},"SubscriptionPaymentMethodResponse":{"type":"object","properties":{"data":{"type":"array","description":"Subscription Payment Method Object","items":{"type":"object"}},"success":{"type":"boolean","description":"Response is successful or not"}},"required":["data","success"]},"DeleteSubscriptionPaymentMethodResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Success or failure."}},"required":["success"]},"SubscriptionConfigResponse":{"type":"object","properties":{"aggregator":{"type":"string","description":"Aggregator Name"},"config":{"type":"object","description":"Aggregator Config"},"success":{"type":"boolean","description":"Response is successful or not"}},"required":["aggregator","config","success"]},"SaveSubscriptionSetupIntentRequest":{"type":"object","properties":{"unique_external_id":{"type":"string","description":"Unique id i.e company:id"}},"required":["unique_external_id"]},"SaveSubscriptionSetupIntentResponse":{"type":"object","properties":{"data":{"type":"object","description":"Subscription Payment Method Object"},"success":{"type":"boolean","description":"Response is successful or not"}},"required":["data","success"]},"RefundAccountResponse":{"type":"object","properties":{"is_verified_flag":{"type":"boolean"},"message":{"type":"string","description":"Response message"},"data":{"type":"object","description":"Refund account data."},"success":{"type":"boolean","description":"Success or failure flag."}},"required":["message","success"]},"NotFoundResourceError":{"type":"object","properties":{"description":{"type":"string","description":"Not Found"},"code":{"type":"string","description":"Bad Request Data"},"success":{"type":"boolean","description":"Response is successful or not"}},"required":["code","description","success"]},"BankDetailsForOTP":{"type":"object","properties":{"ifsc_code":{"type":"string"},"account_no":{"type":"string"},"branch_name":{"type":"string"},"bank_name":{"type":"string"},"account_holder":{"type":"string"}},"required":["account_holder","account_no","bank_name","branch_name","ifsc_code"]},"AddBeneficiaryDetailsOTPRequest":{"type":"object","properties":{"order_id":{"type":"string"},"details":{"$ref":"#/components/schemas/BankDetailsForOTP"}},"required":["details","order_id"]},"IfscCodeResponse":{"type":"object","properties":{"branch_name":{"type":"string","description":"Branch Name Of Account"},"success":{"type":"boolean","description":"Response is successful or not"},"bank_name":{"type":"string","description":"Bank Name Of Account"}},"required":["bank_name","branch_name"]},"OrderBeneficiaryDetails":{"type":"object","properties":{"subtitle":{"type":"string","description":"SHort Title Of Account"},"id":{"type":"integer","format":"int32","description":" "},"title":{"type":"string","description":"Title Of Account"},"account_holder":{"type":"string","description":"Account Holder Name"},"ifsc_code":{"type":"string","description":"Ifsc Code Of Account"},"comment":{"type":"string","description":"Remarks"},"created_on":{"type":"string","description":"Creation Date of Beneficiary"},"display_name":{"type":"string","description":"Display Name Of Account"},"delights_user_name":{"type":"string","nullable":true,"description":"User Id Who filled the Beneficiary "},"transfer_mode":{"type":"string","description":"Transfer Mode Of Account"},"email":{"type":"string","description":"EMail of User"},"is_active":{"type":"boolean","description":"Boolean Flag whether Beneficiary set or not"},"branch_name":{"type":"string","description":"Branch Name Of Account"},"address":{"type":"string","description":"Address of User"},"modified_on":{"type":"string","description":"MOdification Date of Beneficiary"},"beneficiary_id":{"type":"string","description":"Benenficiary Id"},"account_no":{"type":"string","description":"Account Number"},"bank_name":{"type":"string","description":"Bank Name Of Account"},"mobile":{"type":"string","description":"MObile no of User"}},"required":["account_holder","account_no","address","bank_name","beneficiary_id","created_on","display_name","email","id","ifsc_code","is_active","modified_on","subtitle","title","transfer_mode"]},"OrderBeneficiaryResponse":{"type":"object","properties":{"beneficiaries":{"nullable":true,"description":"All Beneficiaries Of An Order","type":"array","items":{"$ref":"#/components/schemas/OrderBeneficiaryDetails"}},"show_beneficiary_details":{"type":"boolean","description":"Show beneficiary details or not."}}},"PaymentConfirmationRequest":{"type":"object","properties":{"order_id":{"type":"string","description":"Unique order id"},"payment_methods":{"type":"array","items":{"$ref":"#/components/schemas/MultiTenderPaymentMethod"}}},"required":["order_id","payment_methods"]},"PaymentConfirmationResponse":{"type":"object","properties":{"order_id":{"type":"string","description":"Unique order id"},"message":{"type":"string","description":"Message"},"success":{"type":"boolean","description":"Payment confirmation updated or not."}},"required":["message","order_id","success"]},"CODdata":{"type":"object","properties":{"remaining_limit":{"type":"integer","format":"int32","description":"Remaining Limit for COD of User"},"user_id":{"type":"string","description":"Payment mode name"},"is_active":{"type":"boolean","description":"COD option is active or not"},"limit":{"type":"integer","format":"int32","description":"Total Limit of user"},"usages":{"type":"integer","format":"int32","description":"Used COD limit from the user Limit"}},"required":["is_active","limit","remaining_limit","usages","user_id"]},"GetUserCODLimitResponse":{"type":"object","properties":{"user_cod_data":{"$ref":"#/components/schemas/CODdata"},"success":{"type":"boolean","description":"Response is successful or not"}},"required":["success","user_cod_data"]},"SetCODForUserRequest":{"type":"object","properties":{"mobileno":{"type":"string","description":"Mobile No. of User"},"is_active":{"type":"boolean","description":"either true or false"},"merchant_user_id":{"type":"string","description":"Merchant User id"}},"required":["is_active","merchant_user_id","mobileno"]},"SetCODOptionResponse":{"type":"object","properties":{"message":{"type":"string","description":"Message"},"success":{"type":"boolean","description":"Response is successful or not"}},"required":["message","success"]},"EdcModelData":{"type":"object","properties":{"aggregator":{"type":"string","description":"Name of aggregator"},"aggregator_id":{"type":"integer","format":"int32","description":"ID of aggregator"},"models":{"type":"array","description":"List of string of edc models","items":{"type":"string"}}},"required":["aggregator","aggregator_id","models"]},"EdcAggregatorAndModelListResponse":{"type":"object","properties":{"data":{"type":"array","description":"List of aggregators and their edc models","items":{"$ref":"#/components/schemas/EdcModelData"}},"success":{"type":"boolean","description":"Response is successful or not"}},"required":["data","success"]},"StatisticsData":{"type":"object","properties":{"inactive_device_count":{"type":"integer","format":"int32","description":"No of inactive devices"},"active_device_count":{"type":"integer","format":"int32","description":"No of active devices"}},"required":["active_device_count","inactive_device_count"]},"EdcDeviceStatsResponse":{"type":"object","properties":{"statistics":{"$ref":"#/components/schemas/StatisticsData"},"success":{"type":"boolean","description":"Response is successful or not"}},"required":["statistics","success"]},"EdcAddRequest":{"type":"object","properties":{"edc_model":{"type":"string","description":"Model of the edc machine"},"store_id":{"type":"integer","format":"int32","description":"Store at which devices is to used"},"aggregator_id":{"type":"integer","format":"int32","description":"Aggregator which will accept payment"},"edc_device_serial_no":{"type":"string","maxLength":20,"description":"Serial number or imei of EDC device"},"terminal_serial_no":{"type":"string","maxLength":20,"description":"Device serial number of terminal(android tablet)"},"device_tag":{"type":"string","nullable":true,"maxLength":50,"description":"Device tag of edc device to identify it"}},"required":["aggregator_id","edc_device_serial_no","edc_model","store_id","terminal_serial_no"]},"EdcDevice":{"type":"object","properties":{"edc_model":{"type":"string","description":"Name of the model"},"store_id":{"type":"integer","format":"int32","description":"Store at which devices is to used"},"aggregator_id":{"type":"integer","format":"int32","description":"Aggregator which will accept payment"},"terminal_unique_identifier":{"type":"string","description":"Genearated unique value for edc device"},"edc_device_serial_no":{"type":"string","description":"Serial number of EDC device"},"is_active":{"type":"boolean","description":"State whether device is active or inactive"},"aggregator_name":{"type":"string","description":"Name of the corresponding aggregator"},"terminal_serial_no":{"type":"string","description":"Device serial number of terminal(android tablet)"},"merchant_store_pos_code":{"type":"string","nullable":true,"description":"This is provided by pinelabs"},"device_tag":{"type":"string","description":"Device tag of edc device to identify it"},"application_id":{"type":"string","description":"Application ID"}},"required":["aggregator_id","application_id","device_tag","edc_device_serial_no","is_active","store_id","terminal_serial_no","terminal_unique_identifier"]},"EdcDeviceAddResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EdcDevice"},"success":{"type":"boolean","description":"Response is successful or not"}},"required":["data","success"]},"EdcDeviceDetailsResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EdcDevice"},"success":{"type":"boolean","description":"Response is successful or not"}},"required":["data","success"]},"EdcUpdateRequest":{"type":"object","properties":{"edc_model":{"type":"string","description":"Model of the edc machine"},"store_id":{"type":"integer","format":"int32","description":"Store at which devices is to used"},"aggregator_id":{"type":"integer","format":"int32","description":"Aggregator which will accept payment"},"edc_device_serial_no":{"type":"string","maxLength":20,"description":"Serial number or imei of EDC device"},"is_active":{"type":"boolean","description":"State whether device is active or inactive"},"merchant_store_pos_code":{"type":"string","maxLength":10,"description":"This is provided by pinelabs"},"device_tag":{"type":"string","nullable":true,"maxLength":50,"description":"Device tag of edc device to identify it"}}},"EdcDeviceUpdateResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Response is successful or not"}},"required":["success"]},"EdcDeviceListResponse":{"type":"object","properties":{"items":{"type":"array","description":"List of all edc mapped to the application options with their Details.","items":{"$ref":"#/components/schemas/EdcDevice"}},"page":{"$ref":"#/components/schemas/Page"},"success":{"type":"boolean","description":"Response is successful or not"}},"required":["items","page","success"]},"PaymentInitializationRequest":{"type":"object","properties":{"razorpay_payment_id":{"type":"string","nullable":true,"description":"Payment gateway payment id"},"device_id":{"type":"string","nullable":true,"description":"EDC machine Unique Identifier"},"email":{"type":"string","format":"email","description":"Customer valid email"},"customer_id":{"type":"string","description":"Payment gateway customer id."},"vpa":{"type":"string","nullable":true,"description":"Customer vpa address"},"aggregator":{"type":"string","description":"Payment gateway name"},"order_id":{"type":"string","description":"Payment gateway order id"},"currency":{"type":"string","description":"Currency code."},"amount":{"type":"integer","format":"int32","nullable":true,"description":"Payable amount."},"contact":{"type":"string","description":"Customer valid mobile number"},"timeout":{"type":"integer","format":"int32","nullable":true,"description":"Payment polling timeout if not recieved response"},"merchant_order_id":{"type":"string","description":"Unique fynd order id"},"method":{"type":"string","description":"Payment method"}},"required":["aggregator","amount","contact","currency","customer_id","email","merchant_order_id","method","order_id"]},"PaymentInitializationResponse":{"type":"object","properties":{"razorpay_payment_id":{"type":"string","nullable":true,"description":"Payment  id."},"device_id":{"type":"string","nullable":true,"description":"EDC machine Unique Identifier"},"upi_poll_url":{"type":"string","nullable":true,"description":"UPI poll url."},"customer_id":{"type":"string","nullable":true,"description":"Payment gateway customer id."},"polling_url":{"type":"string","description":"Polling url."},"vpa":{"type":"string","nullable":true,"description":"Customer vpa address"},"aggregator":{"type":"string","description":"Payment gateway name"},"currency":{"type":"string","nullable":true,"description":"Currency code."},"merchant_order_id":{"type":"string","description":"order id"},"amount":{"type":"integer","format":"int32","nullable":true,"description":"Payable amount."},"timeout":{"type":"integer","format":"int32","nullable":true,"description":"timeout."},"virtual_id":{"type":"string","nullable":true,"description":"Payment virtual address."},"bqr_image":{"type":"string","nullable":true,"description":"Bharath qr image url."},"aggregator_order_id":{"type":"string","description":"Payment order id"},"success":{"type":"boolean","description":"Response is successful or not."},"status":{"type":"string","description":"Status of payment."},"method":{"type":"string","description":"Payment method"}},"required":["aggregator","merchant_order_id","method","polling_url","success"]},"PaymentStatusUpdateRequest":{"type":"object","properties":{"device_id":{"type":"string","nullable":true,"description":"EDC machine Unique Identifier"},"email":{"type":"string","format":"email","description":"Customer valid email"},"customer_id":{"type":"string","description":"Payment gateway customer id."},"vpa":{"type":"string","description":"Customer vpa address"},"aggregator":{"type":"string","description":"Payment gateway name"},"order_id":{"type":"string","description":"Payment gateway order id"},"currency":{"type":"string","description":"Currency code."},"amount":{"type":"integer","format":"int32","nullable":true,"description":"Payable amount."},"contact":{"type":"string","description":"Customer valid mobile number"},"merchant_order_id":{"type":"string","description":"Unique fynd order id"},"status":{"type":"string","description":"Status of payment."},"method":{"type":"string","description":"Payment method"},"merchant_transaction_id":{"type":"string","description":"Unique fynd transaction id"}},"required":["aggregator","amount","contact","currency","customer_id","email","merchant_order_id","merchant_transaction_id","method","order_id","status"]},"PaymentStatusUpdateResponse":{"type":"object","properties":{"redirect_url":{"type":"string","nullable":true,"description":"Redirect url"},"retry":{"type":"boolean","description":"Response is successful or not."},"success":{"type":"boolean","nullable":true,"description":"Response is successful or not"},"status":{"type":"string","description":"Payment status"},"aggregator_name":{"type":"string","description":"Payment gateway name"}},"required":["aggregator_name","retry","status"]},"ResendOrCancelPaymentRequest":{"type":"object","properties":{"order_id":{"type":"string","description":"Unique order id"},"device_id":{"type":"string","nullable":true,"description":"EDC machine Unique Identifier"},"request_type":{"type":"string","description":"Either resend or cancel"}},"required":["order_id","request_type"]},"LinkStatus":{"type":"object","properties":{"status":{"type":"string","description":"Link action status"},"message":{"type":"string","description":"Message"}},"required":["message","status"]},"ResendOrCancelPaymentResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/LinkStatus"},"success":{"type":"boolean","description":"Response is successful or not."}},"required":["data","success"]},"PaymentStatusBulkHandlerRequest":{"type":"object","properties":{"merchant_order_id":{"type":"array","description":"List of order ids","items":{"type":"string"}}},"required":["merchant_order_id"]},"PaymentObjectListSerializer":{"type":"object","properties":{"user_object":{"type":"object"},"modified_on":{"type":"string"},"collected_by":{"type":"string"},"created_on":{"type":"string"},"refund_object":{"type":"object","nullable":true},"id":{"type":"string"},"payment_id":{"type":"string","nullable":true},"currency":{"type":"string"},"current_status":{"type":"string"},"aggregator_payment_object":{"type":"object","nullable":true},"payment_mode":{"type":"string"},"refunded_by":{"type":"string"},"amount_in_paisa":{"type":"string"},"payment_gateway":{"type":"string"},"company_id":{"type":"string"},"payment_mode_identifier":{"type":"string"},"application_id":{"type":"string"},"all_status":{"type":"array","items":{"type":"string"}}},"required":["all_status","amount_in_paisa","application_id","collected_by","company_id","created_on","currency","current_status","id","modified_on","payment_gateway","payment_mode","payment_mode_identifier","refunded_by","user_object"]},"PaymentStatusObject":{"type":"object","properties":{"merchant_order_id":{"type":"string"},"payment_object_list":{"type":"array","items":{"$ref":"#/components/schemas/PaymentObjectListSerializer"}}},"required":["merchant_order_id"]},"PaymentStatusBulkHandlerResponse":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/PaymentStatusObject"}},"success":{"type":"string"},"error":{"type":"string"},"status":{"type":"integer","format":"int32"}},"required":["status","success"]},"GetOauthUrlResponse":{"type":"object","properties":{"url":{"type":"string","description":"The url to call for authenticating"},"success":{"type":"boolean","description":"Response is successful or not"}},"required":["success","url"]},"RevokeOAuthToken":{"type":"object","properties":{"message":{"type":"string","description":"The confirmation message of the token revoke."},"success":{"type":"boolean","description":"Response is successful or not"}},"required":["message","success"]},"RepaymentRequestDetails":{"type":"object","properties":{"fwd_shipment_id":{"type":"string","description":"Purchase Shipment Id"},"aggregator":{"type":"string","description":"Name of Payment Gateway"},"current_status":{"type":"string","description":"Status"},"merchant_order_id":{"type":"string","description":"Merchant's Order Id"},"amount":{"type":"number","format":"float","description":"Amount to paid back"},"payment_mode":{"type":"string","description":"Payment Mode"},"outstanding_details_id":{"type":"integer","format":"int32","description":"Outstanding details ID"},"aggregator_transaction_id":{"type":"string","description":"Unique Id for the transaction"},"aggregator_order_id":{"type":"string","description":"Id of payment gateway"},"payment_mode_identifier":{"type":"string","description":"Payment Mode Id"}},"required":["aggregator","aggregator_order_id","aggregator_transaction_id","amount","current_status","fwd_shipment_id","merchant_order_id","outstanding_details_id","payment_mode","payment_mode_identifier"]},"RepaymentDetailsSerialiserPayAll":{"type":"object","properties":{"total_amount":{"type":"number","format":"float","description":"total amount"},"extension_order_id":{"type":"string","nullable":true,"description":"Order id created in extension"},"aggregator_transaction_id":{"type":"string","description":"Unique Id for the transaction"},"aggregator_order_id":{"type":"string","description":"Id of payment gateway"},"shipment_details":{"type":"array","items":{"$ref":"#/components/schemas/RepaymentRequestDetails"}}},"required":["aggregator_order_id","aggregator_transaction_id","extension_order_id","total_amount"]},"RepaymentResponse":{"type":"object","properties":{"data":{"type":"object","description":""},"success":{"type":"boolean","description":"Success/Failure of the transaction"}},"required":["data","success"]},"MerchantOnBoardingRequest":{"type":"object","properties":{"credit_line_id":{"type":"string","description":"Merchant ID at Ajiodhan's end"},"aggregator":{"type":"string","description":"Payment aggregator name"},"app_id":{"type":"string","description":"Application id"},"user_id":{"type":"string","description":"Deadlock or Grimlock user id"},"status":{"type":"string","description":"Status"}},"required":["aggregator","app_id","credit_line_id","status","user_id"]},"MerchantOnBoardingResponse":{"type":"object","properties":{"data":{"type":"object","description":""},"success":{"type":"boolean","description":"Success/Failure of the transaction"}},"required":["data","success"]},"ValidateCustomerRequest":{"type":"object","properties":{"phone_number":{"type":"string","description":"User mobile number without country code."},"aggregator":{"type":"string","description":"Payment gateway name in camel case i.e Simpl, Rupifi"},"payload":{"type":"string","nullable":true,"description":"Hashed payload string."},"delivery_address":{"type":"object","description":"Extra meta fields."},"transaction_amount_in_paise":{"type":"integer","format":"int32","description":"Payable amount in paise"},"order_items":{"type":"array","description":"Extra meta fields.","items":{"type":"object"}},"merchant_params":{"type":"object","description":"Extra meta fields."},"billing_address":{"type":"object","description":"Extra meta fields."}},"required":["aggregator","phone_number","transaction_amount_in_paise"]},"ValidateCustomerResponse":{"type":"object","properties":{"message":{"type":"string","description":"Error or success message."},"data":{"type":"object","description":"Payment gateway response data"},"success":{"type":"boolean","description":"Response is successful or not"}},"required":["data","message","success"]},"GetPaymentLinkResponse":{"type":"object","properties":{"message":{"type":"string","description":"Message"},"status_code":{"type":"integer","format":"int32","description":"HTTP status code"},"amount":{"type":"number","format":"float","nullable":true,"description":"Total value of order"},"merchant_name":{"type":"string","nullable":true,"description":"Merchant name"},"payment_link_url":{"type":"string","nullable":true,"description":"Url of payment link"},"payment_link_current_status":{"type":"string","nullable":true,"description":"Status of payment link"},"external_order_id":{"type":"string","nullable":true,"description":"Merchant order id"},"polling_timeout":{"type":"integer","format":"int32","nullable":true,"description":"Polling request timeout"},"success":{"type":"boolean","description":"Successful or failure"}},"required":["message","status_code","success"]},"ErrorDescription":{"type":"object","properties":{"msg":{"type":"string","nullable":true,"description":"Message"},"payment_transaction_id":{"type":"string","nullable":true,"description":"Payment transaction id"},"invalid_id":{"type":"boolean","nullable":true,"description":"Payment link id is valid or not"},"merchant_order_id":{"type":"string","nullable":true,"description":"Order id"},"merchant_name":{"type":"string","nullable":true,"description":"Name of merchant that created payment link"},"amount":{"type":"number","format":"float","nullable":true,"description":"Amount paid"},"expired":{"type":"boolean","nullable":true,"description":"Payment link expired or not"},"cancelled":{"type":"boolean","nullable":true,"description":"Payment link is cancelled or not"}}},"CreatePaymentLinkMeta":{"type":"object","properties":{"cart_id":{"type":"string"},"checkout_mode":{"type":"string"},"amount":{"type":"string"},"assign_card_id":{"type":"string","nullable":true}},"required":["amount","cart_id","checkout_mode"]},"CreatePaymentLinkRequest":{"type":"object","properties":{"email":{"type":"string","description":"Email to which the payment link is to be sent"},"amount":{"type":"number","format":"float","description":"Total value of order"},"mobile_number":{"type":"string","description":"Mobile number to which the payment link is to be sent"},"country_phone_code":{"type":"string","description":"Phone country code for complete mobile number"},"description":{"type":"string","nullable":true,"description":"Merchant order id"},"meta":{"$ref":"#/components/schemas/CreatePaymentLinkMeta"},"external_order_id":{"type":"string","description":"Merchant order id"}},"required":["amount","email","external_order_id","meta","mobile_number"]},"CreatePaymentLinkResponse":{"type":"object","properties":{"message":{"type":"string","description":"Message"},"status_code":{"type":"integer","format":"int32","description":"HTTP status code"},"payment_link_url":{"type":"string","nullable":true,"description":"Url of payment link"},"polling_timeout":{"type":"integer","format":"int32","nullable":true,"description":"Polling request timeout"},"success":{"type":"boolean","description":"Successful or failure"},"payment_link_id":{"type":"string","nullable":true,"description":"Unique id of payment link"}},"required":["message","status_code","success"]},"PollingPaymentLinkResponse":{"type":"object","properties":{"message":{"type":"string","nullable":true,"description":"Message"},"http_status":{"type":"integer","format":"int32","nullable":true,"description":"HTTP status code"},"status_code":{"type":"integer","format":"int32","nullable":true,"description":"HTTP status code"},"redirect_url":{"type":"string","nullable":true,"description":"Url to redirect to"},"amount":{"type":"number","format":"float","nullable":true,"description":"Amount"},"order_id":{"type":"string","nullable":true,"description":"Fynd order id"},"success":{"type":"boolean","nullable":true,"description":"Successful or failure"},"payment_link_id":{"type":"string","nullable":true,"description":"Payment link id"},"status":{"type":"string","nullable":true,"description":"Status of payment link"},"aggregator_name":{"type":"string","nullable":true,"description":"Aggregator name"}}},"CancelOrResendPaymentLinkRequest":{"type":"object","properties":{"payment_link_id":{"type":"string","description":"Unique id of payment link"}},"required":["payment_link_id"]},"ResendPaymentLinkResponse":{"type":"object","properties":{"status_code":{"type":"integer","format":"int32","description":"HTTP status code"},"message":{"type":"string","description":"Message"},"polling_timeout":{"type":"integer","format":"int32","nullable":true,"description":"Polling request timeout"},"success":{"type":"boolean","description":"Successful or failure"}},"required":["message","status_code","success"]},"CancelPaymentLinkResponse":{"type":"object","properties":{"status_code":{"type":"integer","format":"int32","description":"HTTP status code"},"message":{"type":"string","description":"Message"},"success":{"type":"boolean","description":"Successful or failure"}},"required":["message","status_code","success"]},"Code":{"type":"object","properties":{"name":{"type":"string","description":"Name of payment method"},"merchant_code":{"type":"string","description":"Merchant Payment Code"},"code":{"type":"string","description":"Payment Method Code"}},"required":["code","merchant_code","name"]},"PaymentCode":{"type":"object","properties":{"networks":{"type":"string","description":"payment networks"},"codes":{"$ref":"#/components/schemas/Code"},"name":{"type":"string","description":"name of payment name"},"types":{"type":"string","description":"Type of payment mode"}},"required":["codes","name","networks","types"]},"GetPaymentCode":{"type":"object","properties":{"method_code":{"$ref":"#/components/schemas/PaymentCode"}},"required":["method_code"]},"GetPaymentCodeResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/GetPaymentCode"},"success":{"type":"boolean","description":"Response is successful or not."}},"required":["data","success"]},"PlatformPaymentModeResponse":{"type":"object","properties":{"message":{"type":"string","nullable":true,"description":"Message"},"items":{"type":"array","nullable":true,"description":"List of all aggregator and payment mode details.","items":{"type":"object"}},"success":{"type":"boolean","description":"Response is successful or not."}},"required":["success"]},"MerchnatPaymentModeRequest":{"type":"object","properties":{"offline":{"type":"object","nullable":true,"description":"Details to be updated for online payment configuration.","items":{"type":"object"}},"online":{"type":"object","nullable":true,"description":"Details to be updated for offline payment configuration.","items":{"type":"object"}}}},"OrderDetail":{"type":"object","properties":{"gid":{"type":"string","description":"Global identifier of the entity (e.g. order, cart etc.) against which payment_session was initiated. This is generated by Fynd payments platform and is unique."},"amount":{"type":"integer","format":"int32","description":"amount paid."},"status":{"type":"string","description":"order status created by payment gateway aggregator."},"currency":{"type":"string","description":"currency of the payment."},"aggregator_order_details":{"type":"object","description":"aggregator order details generated by the payment gateway."},"aggregator":{"type":"string","description":"name of the payment gateway aggregator."}},"required":["aggregator","aggregator_order_details","amount","currency","gid","status"]},"AddressDetail":{"type":"object","properties":{"google_map_point":{"type":"object","description":"google map point of location"},"landmark":{"type":"string","description":"landmark"},"phone":{"type":"string","description":"phone number"},"country_iso_code":{"type":"string","description":"country's code name e.g. `IN`, `GB`"},"area_code":{"type":"string","description":"customer pin/zip code"},"country":{"type":"string","description":"country name"},"expire_at":{"type":"string","description":"address expiry timestamp"},"geo_location":{"type":"object","description":"location latitude and logitude"},"state":{"type":"string","description":"state of the customer"},"area":{"type":"string","description":"area details"},"g_address_id":{"type":"string","description":"unique address id generated by Fynd platform"},"area_code_slug":{"type":"string","description":"area slug code, use pin or zip code if not available"},"country_phone_code":{"type":"string","description":"country's phone code"},"name":{"type":"string","description":"customer name"},"address_type":{"type":"string","nullable":true,"description":"address type e.g. home, office"},"address":{"type":"string","description":"address details"},"email":{"type":"string","description":"customer email"},"city":{"type":"string","description":"city name"},"tags":{"type":"array","description":"optional address tag","items":{"type":"object"}}},"required":["address","area","area_code","area_code_slug","city","country","country_iso_code","country_phone_code","g_address_id","name","phone","state"]},"PaymentSessionDetail":{"type":"object","properties":{"payment_id":{"type":"string","description":"unique transaction id generated by payment gateway"},"mode":{"type":"string","description":"test or live, test mode uses test credentials so that actual payment is not created."},"amount":{"type":"integer","format":"int32","description":"amount paid."},"success_url":{"type":"string","description":"success url sent by Fynd platform at the time of payment creation"},"shipping_address":{"description":"shipping address","allOf":[{"$ref":"#/components/schemas/AddressDetail"}]},"amount_captured":{"type":"integer","format":"int32","description":"amount which is captured or credited to merchant account"},"amount_refunded":{"type":"integer","format":"int32"},"aggregator_customer_id":{"type":"string","description":"unique customer id generated by payment gateway, not required for standard checkout."},"cancel_url":{"type":"string","description":"cancel url sent by Fynd platform at the time of payment creation"},"payment_methods":{"type":"array","description":"method of payment","items":{"type":"object"}},"created":{"type":"string","description":"timestamp in epoch"},"g_user_id":{"type":"string","description":"global user identifier - unique user id generated by Fynd platform"},"currency":{"type":"string","description":"currency of the payment."},"merchant_locale":{"type":"string","description":"merchant's locale"},"locale":{"type":"string","description":"user's locale"},"aggregator_order_id":{"type":"string","description":"unique order id or payment request id generated by payment gateway"},"gid":{"type":"string","description":"Global identifier of the entity (e.g. order, cart etc.) against which payment_session was initiated. This is generated by Fynd payments platform and is unique."},"kind":{"type":"string","description":"optional kind of purchase or payment - one time payment (sale) or subcription. defaults to sale."},"billing_address":{"description":"billing address","allOf":[{"$ref":"#/components/schemas/AddressDetail"}]},"captured":{"type":"boolean","description":"whether the payment is captured (credited to merchant account) by payment gateway."},"meta":{"type":"object","description":"Metadata"},"status":{"type":"string","description":"stautus of the payment"}},"required":["aggregator_order_id","amount","amount_captured","cancel_url","currency","g_user_id","gid","mode","payment_id","payment_methods","status","success_url"]},"PaymentSessionRequestSerializer":{"type":"object","properties":{"meta":{"type":"object","description":"meta"},"gid":{"type":"string","description":"Global identifier of the entity (e.g. order, cart etc.) against which payment_session was initiated. This is generated by Fynd payments platform and is unique."},"order_details":{"description":"The details of the order.","allOf":[{"$ref":"#/components/schemas/OrderDetail"}]},"status":{"type":"string","description":"status of the payment."},"currency":{"type":"string","description":"currency of the payment."},"payment_details":{"type":"array","description":"The payment details with the schema `PaymentSessionDetail`.","items":{"$ref":"#/components/schemas/PaymentSessionDetail"}},"total_amount":{"type":"integer","format":"int32","description":"amount paid."}},"required":["currency","gid","order_details","payment_details","status","total_amount"]},"PaymentSessionResponseSerializer":{"type":"object","properties":{"gid":{"type":"string","description":"Global identifier of the entity (e.g. order, cart etc.) against which payment_session was initiated. This is generated by Fynd payments platform and is unique."},"platform_transaction_details":{"type":"array","description":"platform transaction details.","items":{"type":"object"}},"status":{"type":"string","description":"status of the payment."},"currency":{"type":"string","description":"currency of the payment."},"total_amount":{"type":"integer","format":"int32","description":"amount paid."}},"required":["currency","gid","platform_transaction_details","status","total_amount"]},"RefundSessionDetail":{"type":"object","properties":{"refund_utr":{"type":"string","description":"Unique refund utr generated by payment gateway."},"request_id":{"type":"string","description":"refund request id, unique id generated by Fynd platform"},"payment_id":{"type":"string","description":"Unique payment id generated by payment gateway."},"amount":{"type":"integer","format":"int32","description":"amount refunded."},"reason":{"type":"string","description":"reason for refund, optional"},"status":{"type":"string","description":"status of the refund."},"created":{"type":"string","description":"timestamp in epoch."},"source_transfer_reversal":{"type":"string","description":"description in case of reversal of payment."},"receipt_number":{"type":"string","description":"unique receipt for refund, generated by payment gateway, if not available can be utr."},"currency":{"type":"string","description":"currency of the payment."},"transfer_reversal":{"type":"string","description":"description in case of reversal of payment."},"balance_transaction":{"type":"string","description":"balance transaction."}},"required":["amount","created","currency","payment_id","request_id","status"]},"RefundSessionRequestSerializer":{"type":"object","properties":{"meta":{"type":"object","description":"meta"},"gid":{"type":"string","description":"Global identifier of the entity (e.g. order, cart etc.) against which payment_session was initiated. This is generated by Fynd payments platform and is unique."},"status":{"type":"string","description":"The status of the refund."},"currency":{"type":"string","description":"The currency of the payment."},"payment_details":{"description":"details of the payment","allOf":[{"$ref":"#/components/schemas/PaymentSessionDetail"}]},"total_amount":{"type":"integer","format":"int32","description":"The total amount refunded."},"refund_details":{"type":"array","description":"details of the refund","items":{"$ref":"#/components/schemas/RefundSessionDetail"}},"error":{"$ref":"#/components/schemas/ErrorDescription"},"message":{"type":"string","description":"The status of the refund."}},"required":["currency","gid","payment_details","status","total_amount"]},"RefundSessionResponseSerializer":{"type":"object","properties":{"gid":{"type":"string","description":"Global identifier of the entity (e.g. order, cart etc.) against which payment_session was initiated. This is generated by Fynd payments platform and is unique."},"status":{"type":"string","description":"The status of the refund."},"currency":{"type":"string","description":"The currency of the payment."},"platform_refund_details":{"type":"array","description":"details of the refund","items":{"type":"object"}},"total_refund_amount":{"type":"integer","format":"int32","description":"The total amount refunded."}},"required":["currency","gid","platform_refund_details","status","total_refund_amount"]},"PaymentDetailsSerializer":{"type":"object","properties":{"payment_methods":{"type":"array","description":"method of payment","items":{"type":"object"}},"gid":{"type":"string","description":"Global identifier of the entity (e.g. order, cart etc.) against which payment_session was initiated. This is generated by Fynd payments platform and is unique."},"amount_refunded":{"type":"integer","format":"int32"},"currency":{"type":"string","description":"currency of the payment."},"mode":{"type":"string","description":"test or live, test mode uses test credentials so that actual payment is not created."},"merchant_locale":{"type":"string","description":"merchant's locale"},"meta":{"type":"object","nullable":true,"description":"metadata"},"kind":{"type":"string","description":"optional kind of purchase/payment - one time payment (sale) or subcription. defaults to sale."},"success_url":{"type":"string","description":"success url sent by Fynd platform at the time of payment creation"},"status":{"type":"string","description":"stautus of the payment"},"captured":{"type":"boolean","description":"whether the payment is captured (credited to merchant account) by payment gateway."},"payment_id":{"type":"string","description":"unique transaction id generated by payment gateway"},"g_user_id":{"type":"string","description":"global user identifier - unique user id generated by Fynd platform"},"locale":{"type":"string","description":"user's locale"},"cancel_url":{"type":"string","description":"cancel url sent by Fynd platform at the time of payment creation"},"created":{"type":"string","description":"timestamp in epoch"},"amount_captured":{"type":"integer","format":"int32","description":"amount which is captured or credited to merchant account"},"amount":{"type":"integer","format":"int32","description":"amount paid."},"aggregator_customer_id":{"type":"string","description":"unique customer id generated by payment gateway, not required for standard checkout."},"aggregator_order_id":{"type":"string","description":"unique order id or payment request id generated by payment gateway"}},"required":["amount","amount_captured","currency","g_user_id","gid","mode","payment_methods","status"]},"CartDetailsSerializer":{"type":"object","properties":{"items":{"type":"object","description":"Items that are added in cart"},"articles":{"type":"array","description":"list of articles that are added in cart","items":{"type":"object"}},"cart_value":{"type":"number","description":"total cart value i.e. amount to be paid","format":"double"},"total_quantity":{"type":"integer","description":"total number of items in cart","format":"int32"}},"required":["articles","cart_value","items"]},"RefundDetailsSerializer":{"type":"object","properties":{"amount":{"type":"integer","description":"refunded amount","format":"int32"},"currency":{"type":"string","description":"The currency of the payment."},"request_id":{"type":"string","description":"refund request id, unique id generated by Fynd platform"},"status":{"type":"string","description":"The status of the refund."},"created":{"type":"string","description":"timestamp in epoch."},"refund_utr":{"type":"string","description":"Unique refund utr generated by payment gateway."}},"required":["amount","created","currency","refund_utr","request_id","status"]},"PaymentSessionSerializer":{"type":"object","properties":{"payment_details":{"description":"object of payment details","items":{"$ref":"#/components/schemas/PaymentDetailsSerializer"}},"currency":{"type":"string","description":"The currency of the payment.","nullable":true},"status":{"type":"string","description":"The status of the payment session."},"total_amount":{"type":"integer","format":"int32","description":"total amount to be paid"},"gid":{"type":"string","description":"Global identifier of the entity (e.g. order, cart etc.) against which payment_session was initiated. This is generated by Fynd payments platform and is unique.","nullable":true},"cart_details":{"$ref":"#/components/schemas/CartDetailsSerializer"},"refund_details":{"type":"array","description":"object of refund details","items":{"$ref":"#/components/schemas/RefundDetailsSerializer"}}},"required":["payment_details","refund_details","gid","status","total_amount"]},"RefundSourcesPriority":{"type":"object","properties":{"description":{"type":"string","description":"description of refund source"},"priority":{"type":"integer","format":"int32","description":"priority of refund source, 0 being highest"},"source":{"type":"string","description":"source of refund"}},"required":["description","priority","source"]},"RefundPriorityResponseSerializer":{"type":"object","properties":{"configuration":{"type":"string","description":"configuration for merchant or customer"},"success":{"type":"boolean","description":"success"},"apportion":{"type":"boolean","description":"apportion refund to multiple sources"},"refund_sources_priority":{"type":"array","description":"refund sources priority","items":{"$ref":"#/components/schemas/RefundSourcesPriority"}},"message":{"type":"string","description":"message"}},"required":["apportion","configuration","refund_sources_priority","success"]},"RefundPriorityRequestSerializer":{"type":"object","properties":{"apportion":{"type":"boolean","description":"apportion refund to multiple sources"},"refund_sources_priority":{"type":"array","description":"refund sources priority","items":{"$ref":"#/components/schemas/RefundSourcesPriority"}}},"required":["apportion","refund_sources_priority"]},"MerchantPaymentModeRequest":{"type":"object","properties":{"business_unit":{"type":"string","nullable":false,"description":"Business unit"},"items":{"type":"array","nullable":false,"description":"List of item details with respect to payment_mode","items":{"type":"object"}},"device":{"type":"object","nullable":false,"description":"List of devices and its activation status"}},"required":["device","business_unit","items"]},"FromConfig":{"type":"object","nullable":false,"properties":{"device":{"type":"string","nullable":false,"description":"Device name"},"business_unit":{"type":"string","nullable":false,"description":"Business unit name"}},"required":["device","business_unit"]},"ToConfig":{"type":"object","nullable":false,"properties":{"device":{"type":"array","nullable":false,"description":"Device name to copy the config to","items":{"type":"object"}},"business_unit":{"type":"string","nullable":false,"description":"Business unit name"}},"required":["device","business_unit"]},"PlatformPaymentModeCopyConfigRequest":{"type":"object","properties":{"from_config":{"$ref":"#/components/schemas/FromConfig"},"to_config":{"$ref":"#/components/schemas/ToConfig"}},"required":["from_config","to_config"]},"PaymentMethodsMetaOrder":{"type":"object","properties":{"payment_identifier":{"type":"string","description":"Payment identifier"},"merchant_code":{"type":"string","description":"Merchant code"},"payment_gateway":{"type":"string","description":"Payment gateway name"}},"required":["merchant_code","payment_gateway","payment_identifier"]},"PaymentOrderMethods":{"type":"object","properties":{"amount":{"type":"number","format":"float","description":"Amount to be collected"},"payment":{"type":"string","description":"Payment type i.e. Required / Blocked"},"mode":{"type":"string","description":"Payment mode"},"meta":{"$ref":"#/components/schemas/PaymentMethodsMetaOrder"},"name":{"type":"string","description":"Payment mode name"}},"required":["amount","meta","mode","name"]},"PaymentOrderRequest":{"type":"object","properties":{"order_id":{"type":"string","description":"Order id"},"payment_methods":{"type":"array","items":{"$ref":"#/components/schemas/PaymentOrderMethods"}},"shipment_id":{"type":"string","description":"shipment_id"}},"required":["order_id"]},"PaymentOrderData":{"type":"object","properties":{"contact":{"type":"string","nullable":true,"description":"Mobile number"},"aggregator":{"type":"string","nullable":true,"description":"Aggregator name"},"amount":{"type":"number","format":"float","nullable":true,"description":"Amount"},"customer_id":{"type":"string","nullable":true,"description":"Aggregator customer id"},"currency":{"type":"string","nullable":true,"description":"Currency"},"email":{"type":"string","nullable":true,"description":"Email"},"callback_url":{"type":"string","nullable":true,"description":"Callback url for aggregator"},"order_id":{"type":"string","nullable":true,"description":"Aggregator order id"},"method":{"type":"string","nullable":true,"description":"Method"},"merchant_order_id":{"type":"string","nullable":true,"description":"Merchant order id"}}},"PaymentOrderResponse":{"type":"object","properties":{"message":{"type":"string","description":"Message"},"success":{"type":"boolean","description":"Successful or failure"},"payment_confirm_url":{"type":"string","nullable":true,"description":"Payment confirm url for aggregator"},"callback_url":{"type":"string","nullable":true,"description":"Callback url for aggregator"},"status_code":{"type":"integer","format":"int32","description":"HTTP status code"},"order_id":{"type":"string","nullable":true,"description":"Merchant order id"},"data":{"$ref":"#/components/schemas/PaymentOrderData"}},"required":["message","status_code","success"]},"AggregatorVersionItemSchema":{"type":"object","properties":{"is_equal_to":{"type":"string"},"is_less_than":{"type":"string"},"is_greater_than":{"type":"string"}}},"AggregatorVersionResponse":{"type":"object","properties":{"message":{"type":"string","description":"Message"},"success":{"type":"boolean","description":"Successful or failure"},"items":{"$ref":"#/components/schemas/AggregatorVersionItemSchema"}},"required":["message","success"]},"AggregatorVersionRequestSchema":{"type":"object","properties":{"is_equal_to":{"type":"string"},"is_less_than":{"type":"string"},"is_greater_than":{"type":"string"}}},"AggregatorControlRequest":{"type":"object","properties":{"business_unit":{"type":"string","nullable":false,"description":"Business unit"},"items":{"type":"array","nullable":false,"description":"List of item details with respect to payment_mode","items":{"type":"object"}},"device":{"type":"string","nullable":false,"description":"Device name"},"version":{"$ref":"#/components/schemas/AggregatorVersionRequestSchema"}}},"PaymentModeCustomConfigSchema":{"type":"object","required":["business_unit","display_name","custom_config"],"properties":{"display_name":{"type":"string","description":"The display name of the store."},"business_unit":{"type":"string","description":"The business unit to which the store belongs."},"custom_config":{"$ref":"#/components/schemas/PaymentCustomConfigDetailsSchema"}}},"PaymentCustomConfigDetailsSchema":{"type":"object","required":["customer","payment_mode","min_order_value"],"properties":{"customer":{"$ref":"#/components/schemas/PaymentCustomConfigCustomerSchema"},"payment_mode":{"$ref":"#/components/schemas/PaymentCustomConfigModeSchema"},"min_order_value":{"type":"number","description":"The minimum order value for the store"}}},"PaymentCustomConfigCustomerSchema":{"type":"object","required":["restriction"],"properties":{"restriction":{"type":"string","description":"Customer restriction type.","enum":["ALL_CUSTOMER","CUSTOMER_GROUP","REGISTERED_CUSTOMER"]},"groups":{"type":"array","items":{"type":"integer"},"description":"Customer groups."},"types":{"type":"array","items":{"type":"string"},"description":"Customer types."}}},"PaymentCustomConfigModeSchema":{"type":"object","required":["available"],"properties":{"available":{"type":"boolean","description":"Indicates whether the payment mode is available."},"pre_order":{"type":"array","items":{"type":"string"},"description":"Payment modes available for pre-order."},"post_order":{"type":"array","items":{"type":"string"},"description":"Payment modes available for post-order."}}},"PaymentCustomConfigDetailsRequestSchema":{"type":"object","required":["customer","payment_mode","min_order_value"],"properties":{"customer":{"$ref":"#/components/schemas/PaymentCustomConfigCustomerRequestSchema"},"payment_mode":{"$ref":"#/components/schemas/PaymentCustomConfigModeSchema"},"min_order_value":{"type":"number","description":"The minimum order value for the store"}}},"PaymentCustomConfigCustomerRequestSchema":{"type":"object","required":["restriction"],"properties":{"restriction":{"type":"string","description":"Customer restriction type.","enum":["ALL_CUSTOMER","CUSTOMER_GROUP","REGISTERED_CUSTOMER"]},"groups":{"type":"array","items":{"type":"integer"},"description":"Customer groups."}}},"PaymentCustomConfigRequestSchema":{"type":"object","required":["business_unit","items"],"properties":{"business_unit":{"type":"string","description":"The business unit to which the store belongs."},"items":{"type":"array","items":{"$ref":"#/components/schemas/PaymentCustomConfigDetailsRequestSchema"}}}},"PaymentCustomConfigResponseSchema":{"type":"object","required":["success","message","items"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"},"items":{"type":"array","items":{"$ref":"#/components/schemas/PaymentModeCustomConfigSchema"}}}},"E":{"type":"object","properties":{"code":{"type":"integer"},"exception":{"type":"string"},"info":{"type":"string"},"message":{"type":"string"}}},"GiveawayResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Giveaway"}},"page":{"$ref":"#/components/schemas/Page"}}},"Giveaway":{"type":"object","properties":{"_id":{"type":"string"},"_schedule":{"$ref":"#/components/schemas/Schedule"},"active":{"type":"boolean"},"application_id":{"type":"string"},"audience":{"$ref":"#/components/schemas/RewardsAudience"},"banner_image":{"$ref":"#/components/schemas/Asset"},"created_at":{"type":"string"},"description":{"type":"string"},"name":{"type":"string"},"rule":{"$ref":"#/components/schemas/RewardsRule"},"title":{"type":"string"},"updated_at":{"type":"string"}}},"Schedule":{"type":"object","properties":{"duration":{"type":"integer"},"end":{"type":"string"},"start":{"type":"string"},"cron":{"type":"string"}}},"RewardsAudience":{"type":"object","properties":{"header_user_id":{"type":"string"},"id":{"type":"string"}}},"RewardsRule":{"type":"object","properties":{"amount":{"type":"number"}}},"Offer":{"type":"object","properties":{"_schedule":{"$ref":"#/components/schemas/Schedule"},"active":{"type":"boolean"},"application_id":{"type":"string"},"banner_image":{"$ref":"#/components/schemas/Asset"},"created_at":{"type":"string"},"name":{"type":"string"},"rule":{"type":"object"},"share":{"$ref":"#/components/schemas/ShareMessages"},"sub_text":{"type":"string"},"text":{"type":"string"},"type":{"type":"string"},"updated_at":{"type":"string"},"updated_by":{"type":"string"},"url":{"type":"string"}}},"ShareMessages":{"type":"object","properties":{"email":{"type":"integer"},"facebook":{"type":"string"},"fallback":{"type":"string"},"message":{"type":"string"},"messenger":{"type":"string"},"sms":{"type":"string"},"text":{"type":"string"},"twitter":{"type":"string"},"whatsapp":{"type":"string"}}},"UserRes":{"type":"object","properties":{"points":{"$ref":"#/components/schemas/Points"},"user":{"$ref":"#/components/schemas/RewardUser"}}},"Points":{"type":"object","properties":{"available":{"type":"number"}}},"RewardUser":{"type":"object","properties":{"_id":{"type":"string"},"active":{"type":"boolean"},"created_at":{"type":"string"},"referral":{"$ref":"#/components/schemas/Referral"},"uid":{"type":"integer"},"updated_at":{"type":"string"},"user_block_reason":{"type":"string"},"user_id":{"type":"string"}}},"Referral":{"type":"object","properties":{"code":{"type":"string"}}},"AppUser":{"type":"object","properties":{"_id":{"type":"string"},"active":{"type":"boolean"},"application_id":{"type":"string"},"block_reason":{"type":"string"},"updated_at":{"type":"string"},"updated_by":{"type":"string"},"user_id":{"type":"string"}}},"HistoryRes":{"type":"object","properties":{"items":{"description":"History is the list of points transaction.","type":"array","items":{"$ref":"#/components/schemas/PointsHistory"}},"page":{"$ref":"#/components/schemas/Page"},"points":{"type":"number"}},"required":[]},"PointsHistory":{"type":"object","properties":{"_id":{"type":"string"},"application_id":{"type":"string"},"claimed":{"type":"boolean"},"created_at":{"type":"string"},"expires_on":{"type":"string"},"meta":{"type":"object"},"points":{"type":"number"},"remaining_points":{"type":"number"},"text_1":{"type":"string"},"text_2":{"type":"string"},"text_3":{"type":"string"},"txn_name":{"type":"string"},"updated_at":{"type":"string"},"user_id":{"type":"string"}}},"ConfigurationRes":{"type":"object","properties":{"valid_android_packages":{"description":"Contains array of string items, Valid android package names.","type":"array","items":{"type":"string"}},"terms_conditions_link":{"description":"A URL that redirects to the referral information suport page link","type":"string"},"application_id":{"type":"string"},"success":{"type":"boolean"}}},"SetConfigurationRes":{"type":"object","properties":{"success":{"type":"boolean"}}},"ConfigurationRequest":{"type":"object","properties":{"valid_android_packages":{"type":"array","items":{"type":"string"}},"terms_conditions_link":{"type":"string"}}},"ClickStatsResponse":{"type":"object","properties":{"click_stats":{"type":"array","items":{"$ref":"#/components/schemas/ClickStatsItem"},"description":"An array of click statistics for the short link."}},"required":["click_stats"],"example":{"click_stats":[{"display":"Total Clicks","total":0}]}},"ClickStatsItem":{"type":"object","properties":{"display":{"type":"string","description":"The display name of the click statistic.","example":"Total Clicks"},"total":{"type":"integer","description":"The total number of clicks for the statistic.","example":0}},"required":["display","total"]},"RedirectDevice":{"type":"object","properties":{"link":{"type":"string"},"type":{"type":"string","enum":["web","app_store"]}}},"WebRedirect":{"type":"object","properties":{"link":{"type":"string"},"type":{"type":"string","enum":["web"]}}},"Redirects":{"type":"object","required":["expiry","url"],"properties":{"ios":{"$ref":"#/components/schemas/RedirectDevice"},"android":{"$ref":"#/components/schemas/RedirectDevice"},"web":{"$ref":"#/components/schemas/WebRedirect"},"force_web":{"type":"boolean"}}},"CampaignShortLink":{"type":"object","properties":{"source":{"type":"string"},"medium":{"type":"string"}}},"Attribution":{"type":"object","properties":{"campaign_cookie_expiry":{"type":"string"}}},"SocialMediaTags":{"type":"object","properties":{"title":{"type":"string"},"description":{"type":"string"},"image":{"type":"string"}}},"ShortLinkReq":{"type":"object","required":["title","url"],"properties":{"title":{"type":"string","description":"Give a name to the link."},"url":{"type":"string","description":"The web address to shorten."},"hash":{"type":"string"},"active":{"type":"boolean"},"expire_at":{"type":"string"},"enable_tracking":{"type":"boolean"},"personalized":{"type":"boolean","description":"To create personalized short links."},"campaign":{"$ref":"#/components/schemas/CampaignShortLink"},"redirects":{"$ref":"#/components/schemas/Redirects"},"attribution":{"$ref":"#/components/schemas/Attribution"},"social_media_tags":{"$ref":"#/components/schemas/SocialMediaTags"},"count":{"type":"integer"}}},"UrlInfo":{"type":"object","properties":{"original":{"type":"string"},"short":{"type":"string"},"hash":{"type":"string"}}},"ShortLinkRes":{"type":"object","properties":{"title":{"type":"string"},"url":{"$ref":"#/components/schemas/UrlInfo"},"created_by":{"type":"string"},"app_redirect":{"type":"boolean"},"fallback":{"type":"string","enum":["web","app_store"]},"active":{"type":"boolean"},"_id":{"type":"string"},"enable_tracking":{"type":"boolean"},"expire_at":{"type":"string"},"application":{"type":"string"},"user_id":{"type":"string"},"created_at":{"type":"string"},"meta":{"type":"object"},"updated_at":{"type":"string"},"personalized":{"type":"boolean","description":"To create personalized short links"},"campaign":{"$ref":"#/components/schemas/CampaignShortLink"},"redirects":{"$ref":"#/components/schemas/Redirects"},"attribution":{"$ref":"#/components/schemas/Attribution"},"social_media_tags":{"$ref":"#/components/schemas/SocialMediaTags"},"count":{"type":"integer"}}},"ShortLinkList":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ShortLinkRes"}},"page":{"$ref":"#/components/schemas/Page"}}},"ErrorRes":{"type":"object","properties":{"message":{"type":"string"}}},"ThemeReq":{"type":"object","properties":{"marketplace_theme_id":{"type":"string","description":"The ID of the marketplace theme to apply to the company.","example":"6484029485108e0149ef8a80"}}},"CompanyThemeSchema":{"type":"object","description":"A theme available for a company.","properties":{"_id":{"type":"string","description":"The unique identifier for the theme.","example":"64840dd453077109ea16e15d"},"name":{"type":"string","description":"The name of the theme.","example":"White-Splash"},"marketplace_theme_id":{"$ref":"#/components/schemas/MarketplaceThemeId"},"company_id":{"type":"integer","description":"The ID of the company that the theme belongs to.","example":17426},"meta":{"$ref":"#/components/schemas/CompanyThemeMeta"},"created_at":{"type":"string","format":"date-time","description":"The timestamp when the theme was created.","example":"2023-06-10T05:44:52.087Z"},"updated_at":{"type":"string","format":"date-time","description":"The timestamp when the theme was last updated.","example":"2023-06-10T05:44:52.087Z"},"applied_themes":{"type":"array","items":{"$ref":"#/components/schemas/AppliedThemes"}}}},"MarketplaceThemeId":{"type":"object","description":"The marketplace theme ID object.","properties":{"_id":{"type":"string","description":"The unique identifier for the marketplace theme.","example":"64840a1650fdf90359dfdb31"},"is_default":{"type":"boolean","description":"Whether the theme is the default theme.","example":false},"release":{"$ref":"#/components/schemas/Release"},"created_at":{"type":"string","description":"Creation date of the theme","example":"2023-09-26T07:52:01.315Z"},"updated_at":{"type":"string","description":"Update date of the theme","example":"2023-09-26T07:52:05.326Z"}}},"CompanyThemeMeta":{"type":"object","description":"The metadata associated with the theme.","properties":{"payment":{"$ref":"#/components/schemas/ThemePayment"},"industry":{"type":"array","description":"A list of industry categories the theme is suitable for.","items":{"type":"string","example":"Business equipment and supplies"}},"description":{"type":"string","description":"A description of the theme.","example":"Kartmax is the perfect theme to get you started with your store. Capture audiences' attention through captivating layouts inspired by editorial design, striking typography, and impactful hero sections. Embrace a contemporary narrative that exudes personality and brings your content to life."},"images":{"$ref":"#/components/schemas/ThemeImages"},"slug":{"type":"string","description":"The slug for the theme.","example":"white-splash"}}},"ThemePayment":{"type":"object","description":"Payment information for the theme.","properties":{"is_paid":{"type":"boolean","description":"Whether the theme is a paid theme.","example":false},"amount":{"type":"number","description":"The amount to be paid for the theme.","example":0}}},"ThemeImages":{"type":"object","description":"The images associated with the theme.","properties":{"desktop":{"type":"string","description":"The URL of the desktop image for the theme.","example":"https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/misc/pictures/free-icon/original/EXo5oubRa-desktop.png"},"mobile":{"type":"string","description":"The URL of the mobile image for the theme.","example":"https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/misc/pictures/free-icon/original/PY-1mmO03-mobile.png"}}},"AvailablePageSchema":{"type":"object","properties":{"value":{"type":"string"},"text":{"type":"string"},"path":{"type":"string"},"type":{"type":"string","enum":["system","custom","sections"]},"sections":{"type":"array","items":{"$ref":"#/components/schemas/AvailablePageSchemaSections"}},"sections_meta":{"type":"array","items":{"$ref":"#/components/schemas/AvailablePageSectionMetaAttributes"}},"theme":{"type":"string"},"seo":{"$ref":"#/components/schemas/AvailablePageSeo"},"props":{"type":"array","items":{"type":"object"}},"_id":{"type":"string"},"created_at":{"type":"string","description":"The creation timestamp of the page","example":"2023-06-14T11:44:14.497Z"},"updated_at":{"type":"string","description":"The last update timestamp of the page","example":"2023-06-14T11:44:14.497Z"}}},"AvailablePageSectionMetaAttributes":{"type":"object","properties":{"attributes":{"type":"object"}}},"AvailablePageSeo":{"type":"object","properties":{"title":{"type":"string"},"description":{"type":"string"},"meta_tags":{"type":"array","items":{"$ref":"#/components/schemas/SEOMetaItem"}},"sitemap":{"$ref":"#/components/schemas/SEOSitemap"},"breadcrumb":{"type":"array","items":{"$ref":"#/components/schemas/SEObreadcrumb"}},"_id":{"type":"string"}}},"AvailablePageSchemaSections":{"type":"object","properties":{"name":{"type":"string"},"label":{"type":"string"},"props":{"type":"object"},"blocks":{"type":"array","items":{"type":"object"}},"preset":{"type":"object"},"predicate":{"$ref":"#/components/schemas/AvailablePagePredicate"},"source":{"type":"string","example":"themeBundle"}}},"AvailablePagePredicate":{"type":"object","properties":{"screen":{"$ref":"#/components/schemas/AvailablePageScreenPredicate"},"user":{"$ref":"#/components/schemas/AvailablePageUserPredicate"},"route":{"$ref":"#/components/schemas/AvailablePageRoutePredicate"},"schedule":{"$ref":"#/components/schemas/AvailablePageSchedulePredicate"},"platform":{"$ref":"#/components/schemas/AvailablePagePlatformPredicate"},"zones":{"type":"array","description":"An array of zone ids associated with the section","items":{"type":"string"}}}},"AvailablePageScreenPredicate":{"type":"object","properties":{"mobile":{"type":"boolean"},"desktop":{"type":"boolean"},"tablet":{"type":"boolean"}}},"AvailablePageUserPredicate":{"type":"object","properties":{"authenticated":{"type":"boolean"},"anonymous":{"type":"boolean"}}},"AvailablePageRoutePredicate":{"type":"object","properties":{"selected":{"type":"string","enum":["none","exact","query"]},"exact_url":{"type":"string"},"query":{"type":"object","properties":{}}}},"AvailablePagePlatformPredicate":{"type":"object","description":"An object of platform values enabled for the section","properties":{"ios":{"type":"boolean","description":"Section visibility on ios platform","example":true},"android":{"type":"boolean","description":"Section visibility on android platform","example":true},"web":{"type":"boolean","description":"Section visibility on web platform","example":true}}},"AvailablePageSchedulePredicate":{"type":"object","description":"Scheduling values for a section","properties":{"cron":{"type":"string"},"start":{"type":"string","format":"date-time","example":"2019-08-06T18:25:43.511+0000"},"end":{"type":"string","format":"date-time","example":"2019-08-06T18:25:43.511+0000"}}},"AllAvailablePageSchema":{"type":"object","properties":{"pages":{"type":"array","items":{"$ref":"#/components/schemas/AvailablePageSchema"}}}},"AddThemeRequestSchema":{"type":"object","properties":{"theme_id":{"type":"string"}}},"FontsSchema":{"type":"object","properties":{"items":{"$ref":"#/components/schemas/FontsSchemaItems"},"kind":{"type":"string"}}},"BlitzkriegApiErrorSchema":{"type":"object","properties":{"message":{"type":"string"}}},"BlitzkriegInternalServerErrorSchema":{"type":"object","properties":{"message":{"type":"string"}}},"FontsSchemaItems":{"type":"object","properties":{"family":{"type":"string"},"variants":{"type":"array","items":{"type":"string"}},"subsets":{"type":"array","items":{"type":"string"}},"version":{"type":"string"},"last_modified":{"type":"string"},"files":{"$ref":"#/components/schemas/FontsSchemaItemsFiles"},"category":{"type":"string"},"kind":{"type":"string"}}},"FontsSchemaItemsFiles":{"type":"object","properties":{"regular":{"type":"string"},"italic":{"type":"string"},"bold":{"type":"string"}}},"ThemesSchema":{"type":"object","description":"The response body containing the theme details","properties":{"font":{"$ref":"#/components/schemas/Font"},"config":{"$ref":"#/components/schemas/Config"},"applied":{"type":"boolean","description":"Whether the theme has been applied or not","example":true},"is_private":{"type":"boolean","description":"Whether the theme is private or not","example":false},"tags":{"type":"array","description":"An array of tags associated with the theme","items":{"type":"string"}},"_id":{"type":"string","description":"The unique identifier of the theme","example":"64be4423bc7b28003211322e"},"application_id":{"type":"string","description":"The ID of the application","example":"6487ea376e1442284917c44e"},"marketplace_theme_id":{"type":"string","description":"The ID of the theme in the marketplace","example":"648709a9dc78c855cc907ae5"},"meta":{"$ref":"#/components/schemas/ThemeMeta"},"name":{"type":"string","description":"The name of the theme","example":"HKJun12"},"template_theme_id":{"type":"string","description":"The ID of the template theme","example":"6487143bebd1aebdeb6c9226"},"version":{"type":"string","description":"The version of the theme","example":"1.0.0"},"styles":{"type":"object","description":"The styles associated with the theme"},"created_at":{"type":"string","description":"The creation timestamp of the theme","example":"2023-06-14T11:44:14.497Z"},"updated_at":{"type":"string","description":"The last update timestamp of the theme","example":"2023-06-14T11:44:14.497Z"},"assets":{"$ref":"#/components/schemas/Assets"},"available_sections":{"type":"array","items":{"$ref":"#/components/schemas/SectionItem"},"description":"Available sections information"},"theme_type":{"type":"string","enum":["vue2","react"],"example":"react"},"company_id":{"type":"number","description":"The company id in which sales channel exists","example":1},"src":{"type":"string","example":"https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/misc/general/free/original/2w7EpbXd2-Archive.zip"}}},"ThemeUpgradableResponse":{"type":"object","properties":{"upgrade":{"type":"boolean","description":"Indicates if the theme is upgradable or not","example":false},"versions":{"$ref":"#/components/schemas/ThemeVersions"},"message":{"type":"string","description":"A message describing the theme upgrade status","example":"Theme already upgraded"}}},"UpdateThemeNameRequestBody":{"type":"object","description":"Request Body to Update Theme","properties":{"name":{"type":"string","description":"The new name of the theme.","example":"AcademyV2"}}},"UpdateThemeRequestBody":{"type":"object","description":"Request Body to Update Theme","properties":{"config":{"$ref":"#/components/schemas/Config"},"font":{"$ref":"#/components/schemas/Font"}}},"Font":{"type":"object","properties":{"variants":{"$ref":"#/components/schemas/FontVariants"},"family":{"type":"string","description":"The font family","example":"Poppins"}},"required":["variants","family"]},"FontVariants":{"type":"object","properties":{"light":{"$ref":"#/components/schemas/FontVariant"},"regular":{"$ref":"#/components/schemas/FontVariant"},"medium":{"$ref":"#/components/schemas/FontVariant"},"semi_bold":{"$ref":"#/components/schemas/FontVariant"},"bold":{"$ref":"#/components/schemas/FontVariant"}}},"FontVariant":{"type":"object","properties":{"name":{"type":"string","description":"The name of the font variant","example":"300"},"file":{"type":"string","description":"The URL of the font file","example":"https://fonts.gstatic.com/s/poppins/v9/pxiByp8kv8JHgFVrLDz8V1tvFP-KUEg.ttf"}},"required":["name","file"]},"Config":{"type":"object","properties":{"current":{"type":"string","description":"The current configuration","example":"Default"},"list":{"type":"array","description":"A list of configurations","items":{"$ref":"#/components/schemas/ThemeConfiguration"}},"global_schema":{"$ref":"#/components/schemas/GlobalSchema"},"preset":{"$ref":"#/components/schemas/Preset"}},"required":["current","list"]},"ThemeConfiguration":{"type":"object","properties":{"name":{"type":"string","description":"The name of the configuration","example":"Default"},"global_config":{"type":"object"},"page":{"type":"array","description":"An array of pages","items":{"$ref":"#/components/schemas/ThemeConfigListPage"}}}},"OverlayPopup":{"type":"object","properties":{"dialog_backgroung":{"type":"string","example":"#FFFFFF"},"overlay":{"type":"string","example":"#14130E"}}},"DividerStrokeHighlight":{"type":"object","properties":{"divider_strokes":{"type":"string","example":"#D4D1D1"},"highlight":{"type":"string","example":"#EDECE9"}}},"UserAlerts":{"type":"object","properties":{"success_background":{"type":"string","example":"#C2DBC9"},"success_text":{"type":"string","example":"#1C958F"},"error_background":{"type":"string","example":"#E6D5D5"},"error_text":{"type":"string","example":"#B24141"},"info_background":{"type":"string","example":"#EBD3BC"},"info_text":{"type":"string","example":"#D28F51"}}},"OrderTracking":{"type":"object","properties":{"show_header":{"type":"boolean","example":true},"show_footer":{"type":"boolean","example":true}}},"ThemeConfigListPage":{"type":"object","properties":{"page":{"type":"string","description":"Name of the page","example":"cart-landing"},"settings":{"$ref":"#/components/schemas/ThemeConfigListPageSettingsProps"}}},"ThemeConfigListPageSettingsProps":{"type":"object","properties":{"props":{"type":"object"}}},"CustomConfig":{"type":"object","properties":{"props":{"$ref":"#/components/schemas/CustomProps"}}},"ThemeMeta":{"type":"object","properties":{"payment":{"$ref":"#/components/schemas/ThemePayment"},"description":{"type":"string","description":"The description of the theme","example":"scribe your thescribe your the"},"industry":{"type":"array","description":"An array of industries associated with the theme","items":{"type":"string","example":"Arts and crafts"}},"release":{"$ref":"#/components/schemas/Release"},"images":{"$ref":"#/components/schemas/Images"},"slug":{"type":"string","description":"The slug of the theme","example":"hkjun12"},"name":{"type":"string","description":"The name of the theme","example":"HKJun12"}}},"Release":{"type":"object","properties":{"notes":{"type":"string","description":"The release notes of the theme","example":"<p>escribe your new theme in just a few paragraphs or briefly list the exact changes, feature enhancements, or bug fixes it contains.</p>"},"version":{"type":"string","description":"The version of the theme","example":"1.0.0"}}},"Images":{"type":"object","properties":{"desktop":{"type":"string","description":"The URL of the desktop image","example":"https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/misc/pictures/free-icon/original/burYmo6Z--desktop.jpeg"},"mobile":{"type":"string","description":"The URL of the mobile image","example":"https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/misc/pictures/free-icon/original/EymjcVzm1-mobile.jpeg"}}},"CustomProps":{"type":"object","properties":{"header_bg_color":{"type":"string","description":"The header background color","example":"#ffffff"},"header_text_color":{"type":"string","description":"The header text color","example":"#000000"},"header_border_color":{"type":"string","description":"The header border color","example":"#e1e1e1"},"header_icon_color":{"type":"string","description":"The header icon color","example":"#000000"},"header_cart_notification_bg_color":{"type":"string","description":"The header cart notification background color","example":"#e8a76c"},"header_cart_notification_text_color":{"type":"string","description":"The header cart notification text color","example":"#ffffff"},"header_nav_hover_color":{"type":"string","description":"The header navigation hover color","example":"#999999"},"button_primary_color":{"type":"string","description":"The primary button color","example":"#ffffff"},"button_primary_label_color":{"type":"string","description":"The primary button label color","example":"#000000"},"button_add_to_cart_color":{"type":"string","description":"The add to cart button color","example":"#000000"},"button_add_to_cart_label_color":{"type":"string","description":"The add to cart button label color","example":"#ffffff"},"button_secondary_color":{"type":"string","description":"The secondary button color","example":"#000000"},"button_secondary_label_color":{"type":"string","description":"The secondary button label color","example":"#ffffff"},"button_tertiary_color":{"type":"string","description":"The tertiary button color","example":"#000000"},"button_tertiary_label_color":{"type":"string","description":"The tertiary button label color","example":"#000000"},"button_tertiary_hover_color":{"type":"string","description":"The tertiary button hover color","example":"#000000"},"button_tertiary_hover_text_color":{"type":"string","description":"The tertiary button hover text color","example":"#ffffff"},"text_heading_link_color":{"type":"string","description":"The text heading link color","example":"#000000"},"text_body_color":{"type":"string","description":"The text body color","example":"#000000"},"text_price_color":{"type":"string","description":"The text price color","example":"#000000"},"text_sale_price_color":{"type":"string","description":"The text sale price color","example":"#fb406b"},"text_strikethrough_price_color":{"type":"string","description":"The text strikethrough price color","example":"#9b9b9b"},"text_discount_color":{"type":"string","description":"The text discount color","example":"#ee478d"},"footer_bg_color":{"type":"string","description":"The footer background color","example":"#ffffff"},"footer_text_color":{"type":"string","description":"The footer text color","example":"#999999"},"footer_border_color":{"type":"string","description":"The footer border color","example":"#e1e1e1"},"footer_nav_hover_color":{"type":"string","description":"The footer navigation hover color","example":"#000000"},"disable_cart":{"type":"boolean","description":"Whether to disable the cart or not","example":false},"is_menu_below_logo":{"type":"boolean","description":"Whether the menu is below the logo or not","example":false},"menu_position":{"type":"string","description":"The position of the menu","example":"left"}}},"GlobalSchema":{"type":"object","properties":{"props":{"type":"array","items":{"$ref":"#/components/schemas/Prop"}}}},"Prop":{"type":"object","properties":{"type":{"type":"string","example":"color","description":"The type of the property"},"category":{"type":"string","example":"Colors","description":"The category of the property"},"value":{"type":"string","example":"#E6D5D5","description":"The value of the property"},"id":{"type":"string","example":"button_buy_it_now_label_color","description":"The ID of the property"},"label":{"type":"string","example":"Buy It Now label/Check Pincode Button label","description":"The label of the property"},"info":{"type":"string","example":"This color will be applied on 'Check' button label in Check pincode popup & 'Buy It Now' button label in Product Detail Page(PDP)","description":"Additional information about the property"}}},"Assets":{"type":"object","properties":{"umd_js":{"$ref":"#/components/schemas/UMDJs"},"common_js":{"$ref":"#/components/schemas/CommonJS"},"css":{"$ref":"#/components/schemas/CSS"}},"description":"Asset information"},"UMDJs":{"type":"object","properties":{"link":{"type":"string","example":"https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/organization/60afe92972b7a964de57a1d4/theme/assets/EeHIEp-3v_themeBundle.umd.min.js"},"links":{"type":"array","description":"An array of pages","items":{"type":"string"},"example":["https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/organization/60afe92972b7a964de57a1d4/theme/assets/EeHIEp-3v_themeBundle.umd.min.js"]}},"description":"URLs for UMD JavaScript assets"},"CommonJS":{"type":"object","properties":{"link":{"type":"string","example":"https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/organization/60afe92972b7a964de57a1d4/theme/assets/EeHIEp-3v_themeBundle.common.js"}},"description":"URL for common JavaScript asset"},"CSS":{"type":"object","properties":{"link":{"type":"string","example":"https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/organization/60afe92972b7a964de57a1d4/theme/assets/EeHIEp-3v_themeBundle.css"},"links":{"type":"array","items":{"type":"string"},"example":["https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/organization/60afe92972b7a964de57a1d4/theme/assets/EeHIEp-3v_themeBundle.css"]}},"description":"URLs for CSS assets"},"SectionItem":{"type":"object","properties":{"props":{"type":"array","items":{}},"blocks":{"type":"array","items":{},"description":"Blocks"},"name":{"type":"string","example":"section_extension","description":"Name of the section"},"label":{"type":"string","example":"Extensions","description":"Label for the section"}}},"Preset":{"type":"object","properties":{"pages":{"type":"array","items":{"$ref":"#/components/schemas/Page"}}}},"Section":{"type":"object","properties":{"blocks":{"type":"array","items":{"$ref":"#/components/schemas/Block"}},"predicate":{"$ref":"#/components/schemas/Predicate"},"name":{"type":"string","description":"The name of the section.","example":"image_slideshow"},"props":{"$ref":"#/components/schemas/SectionProps"},"preset":{"$ref":"#/components/schemas/SectionPreset"}}},"Block":{"type":"object","properties":{"type":{"type":"string","description":"The type of the block.","example":"image_slide"},"name":{"type":"string","description":"The name of the block.","example":"Slide"},"props":{"$ref":"#/components/schemas/BlockProps"}}},"Predicate":{"type":"object","properties":{"screen":{"$ref":"#/components/schemas/Screen"},"user":{"$ref":"#/components/schemas/ThemeUserSchema"},"route":{"$ref":"#/components/schemas/Route"}}},"Screen":{"type":"object","properties":{"mobile":{"type":"boolean","description":"True if the screen is a mobile device.","example":true},"desktop":{"type":"boolean","description":"True if the screen is a desktop device.","example":true},"tablet":{"type":"boolean","description":"True if the screen is a tablet device.","example":true}}},"ThemeUserSchema":{"type":"object","properties":{"authenticated":{"type":"boolean","description":"True if the user is authenticated.","example":true},"anonymous":{"type":"boolean","description":"True if the user is anonymous.","example":true}}},"Route":{"type":"object","properties":{"selected":{"type":"string","description":"The selected route.","example":"none"},"exact_url":{"type":"string","description":"The exact URL of the route.","example":""}}},"SectionProps":{"type":"object","properties":{"title":{"$ref":"#/components/schemas/TextProp"},"item_margin":{"$ref":"#/components/schemas/TextProp"},"autoplay":{"$ref":"#/components/schemas/CheckboxProp"},"slide_interval":{"$ref":"#/components/schemas/RangeProp"}}},"SectionPreset":{"type":"object","properties":{"blocks":{"type":"array","items":{"$ref":"#/components/schemas/Block"}}}},"BlockProps":{"type":"object","properties":{"image":{"$ref":"#/components/schemas/ImagePickerProp"},"slide_link":{"$ref":"#/components/schemas/UrlProp"}}},"TextProp":{"type":"object","properties":{"value":{"type":"string","description":"The value of the text property.","example":"Trending"},"type":{"type":"string","description":"The type of the property.","example":"text"}}},"CheckboxProp":{"type":"object","properties":{"value":{"type":"boolean","description":"The value of the checkbox property.","example":false},"type":{"type":"string","description":"The type of the property.","example":"checkbox"}}},"RangeProp":{"type":"object","properties":{"value":{"type":"integer","description":"The value of the range property.","example":2},"type":{"type":"string","description":"The type of the property.","example":"range"}}},"ImagePickerProp":{"type":"object","properties":{"type":{"type":"string","description":"The type of the property.","example":"image_picker"},"value":{"type":"string","description":"The value of the image picker property.","example":""}}},"UrlProp":{"type":"object","properties":{"type":{"type":"string","description":"The type of the property.","example":"url"},"value":{"type":"string","description":"The value of the URL property.","example":""}}},"ThemeVersions":{"type":"object","properties":{"parent_theme":{"type":"string","description":"The version of the parent theme","example":"1.0.0"},"applied_theme":{"type":"string","description":"The version of the applied theme","example":"1.0.1"}}},"DummyResponse":{"description":"Dummy response","type":"object","properties":{"message":{"type":"string","example":"dummy response"}}},"AppliedThemes":{"type":"object","properties":{"_id":{"type":"string","description":"ID of the application theme","example":"6512a18bd7486e270b6fe4f5"},"application_id":{"type":"string","description":"ID of the application","example":"6512a06d68edcebc965cd1f0"}}},"CompanyPrivateTheme":{"type":"object","properties":{"theme_type":{"type":"string","description":"Type of the theme","example":"vue2"},"_id":{"type":"string","description":"Unique identifier for the theme","example":"65128dad28b09d001dc6965e"},"name":{"type":"string","description":"Name of the theme","example":"Astra"},"version":{"type":"string","description":"Version of the theme","example":"1.0.14"},"application_id":{"type":"string","description":"Identifier for the application","example":"65128d2168edcebc965cd10e"},"created_at":{"type":"string","format":"date-time","description":"Date and time when the theme was created","example":"2023-09-26T07:52:13.840Z"},"updated_at":{"type":"string","format":"date-time","description":"Date and time when the theme was last updated","example":"2023-09-26T07:52:15.372Z"},"applied":{"type":"boolean","description":"Whether the theme is applied or not","example":true},"is_private":{"type":"boolean","description":"Whether the theme is private or not","example":false},"meta":{"$ref":"#/components/schemas/CompanyThemeMeta"}}},"UserAttributeDefinition":{"type":"object","properties":{"_id":{"type":"string","description":"The unique identifier for the attribute definition."},"name":{"type":"string","description":"The attribute name."},"slug":{"type":"string","description":"The attribute key."},"description":{"type":"string","description":"The description of the attribute."},"application_id":{"type":"string","description":"The application ID."},"type":{"type":"string","enum":["number","string","date","number_array","string_array","boolean"],"description":"The attribute type."},"multi_value":{"type":"boolean","description":"Whether the attribute supports multiple values."},"customer_editable":{"type":"boolean","description":"Whether the attribute is customer-editable."},"encrypted":{"type":"boolean","description":"Whether the attribute is encrypted."},"pinned":{"type":"boolean","description":"Whether the attribute is pinned."},"pin_order":{"type":"integer","description":"The order in which the attribute is pinned."},"validations":{"type":"array","items":{"type":"object"}},"is_locked":{"type":"boolean","description":"Whether the attribute is locked."},"created_at":{"type":"string","description":"The creation date of the attribute."},"modified_at":{"type":"string","description":"The modification date of the attribute."},"__v":{"type":"integer","description":"The version number of the attribute."}}},"UserAttributeDefinitionResponse":{"type":"object","properties":{"_id":{"type":"string","description":"The unique identifier for the attribute definition."},"name":{"type":"string","description":"The attribute name."},"slug":{"type":"string","description":"The attribute key."},"description":{"type":"string","description":"The description of the attribute."},"application_id":{"type":"string","description":"The application ID."},"type":{"type":"string","enum":["number","string","date","number_array","string_array","boolean"],"description":"The attribute type."},"multi_value":{"type":"boolean","description":"Whether the attribute supports multiple values."},"customer_editable":{"type":"boolean","description":"Whether the attribute is customer-editable."},"encrypted":{"type":"boolean","description":"Whether the attribute is encrypted."},"pinned":{"type":"boolean","description":"Whether the attribute is pinned."},"pin_order":{"type":"integer","description":"The order in which the attribute is pinned."},"validations":{"type":"array","items":{"$ref":"#/components/schemas/UserAttributeDefinitionValidation"}},"is_locked":{"type":"boolean","description":"Whether the attribute is locked."},"created_by":{"type":"string","description":"The user who created the attribute."},"updated_by":{"type":"string","description":"The user who last updated the attribute."},"created_at":{"type":"string","format":"date-time","description":"The creation date of the attribute definition."},"modified_at":{"type":"string","format":"date-time","description":"The last modification date of the attribute definition."}}},"UserAttributeDefinitionValidation":{"type":"object","properties":{"type":{"type":"string","enum":["min","max","regex"],"description":"The type of validation."},"value":{"description":"The validation value."}}},"UserAttributeResponse":{"type":"object","properties":{"_id":{"type":"string","description":"The unique identifier for the attribute definition."},"name":{"type":"string","description":"The name of user attribute definition."},"user_id":{"type":"string","description":"The unique identifier for the user."},"application_id":{"type":"string","description":"The application ID."},"type":{"type":"string","enum":["number","string","date","number_array","string_array","boolean"],"description":"The attribute type."},"customer_overriden":{"type":"boolean","description":"Whether the attribute is customer-editable."},"attribute":{"type":"object"},"updated_by":{"type":"string"}}},"CreateUserAttributeRequest":{"type":"object","properties":{"customer_overriden":{"type":"boolean"},"attribute":{"type":"object"}}},"CreateUserAttributeDefinition":{"type":"object","properties":{"name":{"type":"string"},"slug":{"type":"string"},"description":{"type":"string"},"type":{"type":"string"},"multi_value":{"type":"boolean"},"customer_editable":{"type":"boolean"},"encrypted":{"type":"boolean"},"pinned":{"type":"boolean"},"pin_order":{"type":"number"},"default_value":{"type":"string"},"validations":{"type":"array","items":{"type":"object"}}}},"BlockUserRequestSchema":{"type":"object","properties":{"status":{"type":"boolean"},"user_id":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"}}},"ArchiveUserRequestSchema":{"type":"object","properties":{"user_id":{"type":"string"}}},"UnDeleteUserRequestSchema":{"type":"object","properties":{"user_id":{"type":"string"},"reason":{"type":"string"},"reason_id":{"type":"string"}}},"BlockUserSuccess":{"type":"object","properties":{"success":{"type":"boolean"}}},"ArchiveUserSuccess":{"type":"object","properties":{"success":{"type":"boolean"}}},"UnDeleteUserSuccess":{"type":"object","properties":{"success":{"type":"boolean"}}},"UserSearchResponseSchema":{"type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/components/schemas/UserSchema"}}}},"CustomerListResponseSchema":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/UserSchema"}},"page":{"$ref":"#/components/schemas/PaginationSchema"}}},"PaginationSchema":{"type":"object","properties":{"size":{"type":"integer"},"item_total":{"type":"integer"},"has_next":{"type":"boolean"},"type":{"type":"string"},"current":{"type":"integer"}}},"SessionListResponseSchema":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/SessionListResponseInfo"}}}},"SessionDeleteResponseSchema":{"type":"object","properties":{"user_id":{"type":"string"},"session_id":{"type":"string"}}},"SessionsDeleteResponseSchema":{"type":"object","properties":{"user_id":{"type":"string"},"session_ids":{"type":"array","items":{"type":"string"}}}},"AuthenticationApiErrorSchema":{"type":"object","properties":{"message":{"type":"string"}}},"SessionListResponseInfo":{"type":"object","properties":{"session_id":{"type":"string"},"user_agent":{"type":"string"},"ip":{"type":"string"},"domain":{"type":"string"},"expire_in":{"type":"string"}}},"Conditions":{"type":"object","properties":{"user_attribute_definition_id":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"},"key":{"type":"string"}}},"UserResponseErrorSchema":{"type":"object","properties":{"count":{"type":"integer"},"file_url":{"type":"string"}}},"UserGroupResponseSchema":{"type":"object","properties":{"conditions":{"type":"array","items":{"$ref":"#/components/schemas/Conditions"}},"error":{"$ref":"#/components/schemas/UserResponseErrorSchema"},"name":{"type":"string"},"description":{"type":"string"},"file_url":{"type":"string"},"_id":{"type":"string"},"status":{"type":"string"},"is_active":{"type":"boolean"},"type":{"type":"string"},"uid":{"type":"integer"},"application_id":{"type":"string"},"created_at":{"type":"string"},"modified_at":{"type":"string"},"__v":{"type":"integer"}}},"UserGroupListResponseSchema":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/UserGroupResponseSchema"}},"page":{"$ref":"#/components/schemas/PaginationSchema"}}},"ConditionsSchema":{"type":"object","properties":{"user_attribute_definition_id":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}}},"CreateUserGroup":{"type":"object","required":["name","description"],"properties":{"conditions":{"type":"array","items":{"$ref":"#/components/schemas/ConditionsSchema"}},"type":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"file_url":{"type":"string"}}},"CreateUserRequestSchema":{"type":"object","required":["phone_number","username"],"properties":{"phone_number":{"type":"string"},"email":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"gender":{"type":"string"},"username":{"type":"string"},"meta":{"type":"object"},"external_id":{"type":"string"}}},"CreateUserResponseSchema":{"type":"object","properties":{"user":{"$ref":"#/components/schemas/UserSchema"}}},"CreateUserSessionRequestSchema":{"type":"object","properties":{"domain":{"type":"string"},"max_age":{"type":"number"},"user_id":{"type":"string"}}},"CreateUserSessionResponseSchema":{"type":"object","properties":{"domain":{"type":"string"},"max_age":{"type":"number"},"secure":{"type":"boolean"},"http_only":{"type":"boolean"},"cookie":{"type":"object"}}},"PlatformSchema":{"type":"object","properties":{"display":{"type":"string"},"look_and_feel":{"$ref":"#/components/schemas/LookAndFeel"},"updated_at":{"type":"string"},"active":{"type":"boolean"},"forgot_password":{"type":"boolean"},"login":{"$ref":"#/components/schemas/Login"},"skip_captcha":{"type":"boolean"},"name":{"type":"string"},"meta":{"$ref":"#/components/schemas/MetaSchema"},"_id":{"type":"string"},"social":{"$ref":"#/components/schemas/Social"},"required_fields":{"$ref":"#/components/schemas/RequiredFields"},"register_required_fields":{"$ref":"#/components/schemas/RegisterRequiredFields"},"skip_login":{"type":"boolean"},"flash_card":{"$ref":"#/components/schemas/FlashCard"},"subtext":{"type":"string"},"social_tokens":{"$ref":"#/components/schemas/SocialTokens"},"created_at":{"type":"string"},"register":{"type":"boolean"},"mobile_image":{"type":"string"},"desktop_image":{"type":"string"},"delete_account_day":{"type":"integer"},"delete_account_reasons":{"type":"array","items":{"$ref":"#/components/schemas/DeleteAccountReasons"}},"delete_account_consent":{"type":"object","items":{"$ref":"#/components/schemas/DeleteAccountConsent"}},"session_config":{"type":"object","items":{"$ref":"#/components/schemas/SessionExpiry"}}}},"LookAndFeel":{"type":"object","properties":{"card_position":{"type":"string"},"background_color":{"type":"string"}}},"Login":{"type":"object","properties":{"password":{"type":"boolean"},"otp":{"type":"boolean"}}},"MetaSchema":{"type":"object","properties":{"fynd_default":{"type":"boolean"}}},"Social":{"type":"object","properties":{"account_kit":{"type":"boolean"},"facebook":{"type":"boolean"},"google":{"type":"boolean"},"apple":{"type":"boolean"}}},"RequiredFields":{"type":"object","properties":{"email":{"$ref":"#/components/schemas/PlatformEmail"},"mobile":{"$ref":"#/components/schemas/PlatformMobile"}}},"PlatformEmail":{"type":"object","properties":{"is_required":{"type":"boolean"},"level":{"type":"string"}}},"PlatformMobile":{"type":"object","properties":{"is_required":{"type":"boolean"},"level":{"type":"string"}}},"RegisterRequiredFields":{"type":"object","properties":{"email":{"$ref":"#/components/schemas/RegisterRequiredFieldsEmail"},"mobile":{"$ref":"#/components/schemas/RegisterRequiredFieldsMobile"}}},"RegisterRequiredFieldsEmail":{"type":"object","properties":{"is_required":{"type":"boolean"},"level":{"type":"string"}}},"RegisterRequiredFieldsMobile":{"type":"object","properties":{"is_required":{"type":"boolean"},"level":{"type":"string"}}},"FlashCard":{"type":"object","properties":{"text":{"type":"string"},"text_color":{"type":"string"},"background_color":{"type":"string"}}},"SocialTokens":{"type":"object","properties":{"facebook":{"$ref":"#/components/schemas/Facebook"},"account_kit":{"$ref":"#/components/schemas/Accountkit"},"google":{"$ref":"#/components/schemas/Google"}}},"DeleteAccountReasons":{"type":"object","properties":{"reason_text":{"type":"string"},"reason_id":{"type":"string"},"show_text_area":{"type":"boolean"}}},"DeleteAccountConsent":{"type":"object","properties":{"consent_text":{"type":"string"}}},"Facebook":{"type":"object","properties":{"app_id":{"type":"string"}}},"Accountkit":{"type":"object","properties":{"app_id":{"type":"string"}}},"Google":{"type":"object","properties":{"app_id":{"type":"string"}}},"SessionExpiry":{"type":"object","properties":{"duration":{"type":"integer"},"type":{"type":"string","enum":["Minutes","Days","Hours"]},"is_rolling":{"type":"boolean"}}},"UpdateUserGroupSchema":{"type":"object","properties":{"conditions":{"type":"array","items":{"$ref":"#/components/schemas/ConditionsSchema"}},"type":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"file_url":{"type":"string"}}},"PartialUserGroupUpdateSchema":{"type":"object","properties":{"type":{"type":"string","description":"Source of update to be used to update individual users. Default value is considered file_url if not passed.","enum":["file_url","json"]},"name":{"type":"string"},"description":{"type":"string"},"file_url":{"type":"string","description":"Required property when passed type file_url. Internet reachable csv file url which will be used to fetch download data. It must have one of columns from `phone_number``, `email``, `user_id`` and must have `action` column. `action` column can have `add` or `remove` value."},"user_data":{"type":"array","description":"Required property when passed type json. Array of user data. Must have `action` field and one of `phone_number`, `email` or `user_id` field in object","items":{"$ref":"#/components/schemas/UserGroupUpdateData"}}}},"UserGroupUpdateData":{"type":"object","required":["action"],"properties":{"user_id":{"type":"string","description":"Must be valid mongodb objectid of existing user"},"phone_number":{"type":"string","description":"Phone number of registered user"},"email":{"type":"string","description":"Email of registered user"},"action":{"type":"string","enum":["add","remove"]}}},"UpdateUserRequestSchema":{"type":"object","properties":{"first_name":{"type":"string"},"last_name":{"type":"string"},"gender":{"type":"string"},"external_id":{"type":"string"},"meta":{"type":"object"},"phone_numbers":{"type":"array","items":{"$ref":"#/components/schemas/UserPhoneNumbers"}},"emails":{"type":"array","items":{"$ref":"#/components/schemas/UserEmails"}}}},"UserEmails":{"type":"object","properties":{"active":{"type":"boolean"},"primary":{"type":"boolean"},"verified":{"type":"boolean"},"email":{"type":"string"}}},"UserPhoneNumbers":{"type":"object","properties":{"active":{"type":"boolean"},"primary":{"type":"boolean"},"verified":{"type":"boolean"},"phone":{"type":"string"},"country_code":{"type":"string"}}},"Event":{"type":"object","properties":{"event_name":{"type":"string"},"event_type":{"type":"string"},"event_category":{"type":"string"},"version":{"type":"string"}}},"RetryEventRequest":{"type":"object","properties":{"search_text":{"type":"string"},"end_date":{"type":"string"},"start_date":{"type":"string"},"subscriber_ids":{"type":"array","items":{"type":"integer"}},"event":{"type":"array","items":{"$ref":"#/components/schemas/Event"}},"status":{"type":"string"}}},"RetryCountResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Item"}}}},"RetrySuccessResponse":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}},"Err":{"type":"object","properties":{"msg":{"type":"string"},"param":{"type":"string"},"location":{"type":"string"}}},"RetryFailureResponse":{"type":"object","properties":{"err":{"type":"array","items":{"$ref":"#/components/schemas/Err"}}}},"RetryStatusResponse":{"type":"object","properties":{"total_event":{"type":"integer","description":"The total number of events that require retry."},"success_count":{"type":"integer","description":"The count of successfully retried events."},"failure_count":{"type":"integer","description":"The count of failed retry attempts."},"status":{"type":"string","description":"The overall status of the retry process (e.g., \"completed\")."}}},"EventProcessRequest":{"type":"object","properties":{"search_text":{"type":"string"},"end_date":{"type":"string","format":"date-time"},"start_date":{"type":"string","format":"date-time"},"subscriber_ids":{"type":"array","items":{"type":"integer"}},"status":{"type":"string"},"event":{"type":"array","items":{"$ref":"#/components/schemas/Event"}}}},"DownloadReportResponse":{"type":"object","properties":{"file_name":{"type":"string"}}},"EventProcessReports":{"type":"object","properties":{"rows":{"type":"array","items":{"$ref":"#/components/schemas/EventProcessReportObject"}},"page":{"$ref":"#/components/schemas/Page"}}},"EventProcessReportObject":{"type":"object","properties":{"event_name":{"type":"string","description":"The name of the processed event."},"response_code":{"type":"integer","description":"The response code of the event."},"response_message":{"type":"string","description":"The response message of the event."},"data":{"type":"object","additionalProperties":true,"description":"The data associated with the event."},"attempt":{"type":"integer","description":"The attempt number of the event."},"last_attempted_on":{"type":"integer","description":"The timestamp of the last attempted event."},"status":{"type":"string","description":"The status of the event (e.g., \"FAILED\")."},"name":{"type":"string","description":"The name of the event."},"webhook_url":{"type":"string","description":"The webhook URL associated with the event."},"response_time":{"type":"integer","description":"The response time of the event."},"message_id":{"type":"string"},"event_trace_id":{"type":"string"}}},"PingWebhook":{"type":"object","properties":{"webhook_url":{"type":"string","format":"uri","description":"The URL of the subscriber's webhook to ping."},"auth_meta":{"type":"object","description":"Authentication metadata (if required by the subscriber)."},"custom_headers":{"type":"object","description":"Custom headers to include in the ping request."}}},"PingWebhookResponse":{"type":"object","properties":{"status":{"type":"string","description":"The status of the ping (e.g., \"SUCCESS\")."},"message":{"type":"string","description":"An optional message related to the ping."},"code":{"type":"integer","description":"The HTTP status code of the ping response (e.g., 200)."}}},"EventConfig":{"type":"object","properties":{"id":{"type":"integer"},"event_name":{"type":"string"},"event_type":{"type":"string"},"event_category":{"type":"string"},"event_schema":{"nullable":true,"type":"object","additionalProperties":true},"version":{"type":"string"},"display_name":{"type":"string"},"description":{"type":"string","nullable":true},"created_on":{"type":"string"},"updated_on":{"type":"string"}}},"EventConfigResponse":{"type":"object","properties":{"event_configs":{"type":"array","items":{"$ref":"#/components/schemas/EventConfig"}}}},"ReportFiltersPayload":{"type":"object","properties":{"subscriber_ids":{"type":"array","items":{"type":"integer"},"description":"An array of subscriber IDs for filtering filters (optional)."}}},"ReportFilterResponse":{"type":"object","properties":{"filter_name":{"type":"string","description":"The name of the filter."},"values":{"type":"array","items":{"type":"object","additionalProperties":true}}}},"HistoryPayload":{"type":"object","properties":{"type":{"type":"string","description":"The type of history report (e.g., \"platform\")."},"page_no":{"type":"integer","description":"The page number of the history report."},"page_size":{"type":"integer","description":"The number of records per page."}}},"HistoryFilters":{"type":"object","properties":{"events":{"type":"array","items":{"type":"string"}},"search_text":{"type":"string"},"status":{"type":"string","description":"The status of the history report (e.g., \"FAILED\")."},"end_date":{"type":"string","format":"date-time","description":"The end date and time of the history report."},"start_date":{"type":"string","format":"date-time","description":"The start date and time of the history report."},"subscribers":{"type":"array","items":{"type":"integer"},"description":"An array of subscriber IDs associated with the history report."}}},"CdnObject":{"type":"object","properties":{"urls":{"type":"array","items":{"$ref":"#/components/schemas/Url"}}}},"UploadServiceObject":{"type":"object","nullable":true,"properties":{"cdn":{"$ref":"#/components/schemas/CdnObject"}}},"HistoryAssociation":{"type":"object","properties":{"company_id":{"type":"integer"},"subscriber_ids":{"type":"array","items":{"type":"integer"}}}},"HistoryItems":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the history report."},"association":{"$ref":"#/components/schemas/HistoryAssociation"},"filters":{"$ref":"#/components/schemas/HistoryFilters"},"filename":{"type":"string","description":"The filename of the history report."},"status":{"type":"string","description":"The status of the history report (e.g., \"COMPLETED\")."},"upload_service_response":{"$ref":"#/components/schemas/UploadServiceObject"},"created_on":{"type":"string","format":"date-time","description":"The date and time when the history report was created."},"updated_on":{"type":"string","nullable":true,"format":"date-time","description":"The date and time when the history report was last updated."},"message":{"type":"string","description":"A message related to the history report."}}},"HistoryResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/HistoryItems"}},"page":{"$ref":"#/components/schemas/Page"}}},"CancelResponse":{"type":"object","properties":{"message":{"type":"string","description":"The HTTP status code of the response (e.g., 200)."}}},"Association":{"properties":{"company_id":{"type":"integer","format":"int32"},"application_id":{"type":"array","items":{"type":"string"}},"extension_id":{"type":"string"},"criteria":{"type":"string","enum":["ALL","EMPTY","SPECIFIC-EVENTS"]}}},"AuthMeta":{"properties":{"type":{"type":"string"},"secret":{"type":"string"}}},"SubscriberResponse":{"properties":{"id":{"type":"integer","format":"int32"},"modified_by":{"type":"string"},"name":{"type":"string"},"webhook_url":{"type":"string"},"association":{"$ref":"#/components/schemas/Association"},"custom_headers":{"type":"object"},"status":{"$ref":"#/components/schemas/SubscriberStatus"},"email_id":{"type":"string"},"updated_on":{"type":"string"},"created_on":{"type":"string"},"type":{"type":"string","nullable":true},"auth_meta":{"$ref":"#/components/schemas/AuthMeta"},"event_configs":{"type":"array","items":{"$ref":"#/components/schemas/EventConfig"}}}},"SubscriberStatus":{"type":"string","enum":[{"name":"active","value":"active","description":"Status is active"},{"name":"inactive","value":"inactive","description":"Status is inactive"},{"name":"blocked","value":"blocked","description":"Subscriber is blocked by system due to multiple failed delivery attempts."}]},"SubscriberConfig":{"properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"webhook_url":{"type":"string"},"association":{"$ref":"#/components/schemas/Association"},"custom_headers":{"type":"object"},"status":{"$ref":"#/components/schemas/SubscriberStatus"},"email_id":{"type":"string"},"auth_meta":{"$ref":"#/components/schemas/AuthMeta"},"event_id":{"type":"array","items":{"type":"integer","format":"int32"}}}},"SubscriberConfigResponse":{"properties":{"id":{"type":"integer","format":"int32"},"modified_by":{"type":"string"},"name":{"type":"string"},"webhook_url":{"type":"string"},"association":{"$ref":"#/components/schemas/Association"},"custom_headers":{"type":"object"},"status":{"$ref":"#/components/schemas/SubscriberStatus"},"email_id":{"type":"string"},"updated_on":{"type":"string"},"created_on":{"type":"string"},"type":{"type":"string","nullable":true},"auth_meta":{"$ref":"#/components/schemas/AuthMeta"},"event_id":{"type":"array","items":{"type":"integer","format":"int32"}}}},"SubscriberConfigList":{"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/SubscriberResponse"}},"page":{"$ref":"#/components/schemas/Page"}}}},"responses":{"DeprecatedApiError":{"description":"Deprecated API error.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"API call to version v1 is no longer supported. Please update your CLI to the latest version. For more details, refer to the documentation link: https://partners.fyndx1.de/help/docs/partners/themes/overview"}}}}}},"BlitzkriegApiError":{"description":"API error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlitzkriegApiErrorSchema"}}}},"BlitzkriegInternalServerError":{"description":"Internal Server Error. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlitzkriegInternalServerErrorSchema"}}}},"AuthenticationApiError":{"description":"Bad Request. See the error object in the response body to know the exact reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationApiErrorSchema"}}}}},"examples":{"LogSchemaResponse":{"value":{"docs":[{"entity":{"type":"update-shipment-status","id":"16660872182851894278","action":"update"},"modifier":{"user_id":"a8d7a69b4cd980acc5d2455c","as_administrator":true,"user_details":{"first_name":"Paul","last_name":"Lobo","full_name":"Paul Lobo","email":"paullobo@xyz.com"}},"_id":"634eef735e84e7e1b09aa07c","application":"","date":"2022-10-18T18:24:51.329Z","created_at":"2022-10-18T18:24:51.400Z","modified_at":"2022-10-18T18:24:51.400Z"}]}},"EntityTypesResponse":{"value":{"items":[{"entity_value:\"sales-channel\"":null,"display_name":"Sales Channel"},{"entity_value:\"shipment-update\"":null,"display_name":"Shipment Update"}]}},"PlanDetailedGet":{"value":{"recurring":{"interval":"month","interval_count":1},"is_trial_plan":false,"plan_group":"default","tag_lines":[],"currency":"INR","is_active":true,"is_visible":true,"trial_period":0,"addons":[],"tags":[],"type":"public","country":"IN","_id":"5f3a8786c90d780037723a12","name":"Standard","description":"Standard","amount":999,"product_suite_id":"5f3a8786c90d7800377239f3","created_at":"2020-08-17T13:35:02.547Z","modified_at":"2020-08-17T13:35:02.547Z","components":[{"name":"Shipping","slug":"shipping","description":"","group":"feature","icon":"","links":{},"enabled":true,"display_text":"As per rate card"},{"name":"Transaction Fee","slug":"transaction-fee","description":"","group":"feature","icon":"","links":{},"enabled":true,"display_text":"4.5%"},{"name":"Number of Customers","slug":"customers","description":"","group":"feature","icon":"","links":{},"enabled":true,"display_text":"Unlimited"},{"name":"Team Management","slug":"team-management","description":"","group":"feature","icon":"","links":{},"enabled":true,"display_text":"20"},{"name":"Selling Locations","slug":"selling-locations","description":"","group":"feature","icon":"","links":{},"enabled":true,"display_text":"10"},{"name":"Number of Products","slug":"products","description":"","group":"feature","icon":"","links":{},"enabled":true,"display_text":"Unlimited"},{"name":"Fynd supported Payment Gateway","slug":"fynd-supported-payment-gateway","description":"","group":"feature","icon":"","links":{},"enabled":true,"display_text":"Yes"},{"name":"SSL Certificates","slug":"ssl-certificates","description":"SSL certificates","group":"feature","icon":"","links":{},"enabled":true,"display_text":"Free"},{"name":"Themes","slug":"themes","description":"","group":"feature","icon":"","links":{},"enabled":true,"display_text":"Basic Themes <br> Use themes by Partners"},{"name":"Email Campaign","slug":"email-campagin","description":"email-campagin","group":"feature","icon":"","links":{},"enabled":true,"display_text":"Free 5000 email <br> Additional email charged at 0.25 INR per email"},{"name":"Sale Websites","slug":"sale-websites","description":"","group":"feature","icon":"","links":{},"enabled":true,"display_text":"2"},{"name":"SMS campaign","slug":"sms-campagin","description":"Sms campagin","group":"feature","icon":"","links":{},"enabled":true,"display_text":"Free 5000 SMS <br> Additional SMS charged at 0.25 INR per SMS"},{"name":"Analytics - Campaign Source","slug":"analytics-campaign-source","description":"","group":"feature","icon":"","links":{},"enabled":true,"display_text":"CSV + Basic Events"},{"name":"Content Management","slug":"content-managment","description":"","group":"feature","icon":"","links":{},"enabled":true,"display_text":"Yes"},{"name":"Custom Domain","slug":"custom-domain","description":"","group":"feature","icon":"","links":{},"enabled":true,"display_text":"Yes"},{"name":"Service-Level Agreement","slug":"sla","description":"","group":"feature","icon":"","links":{},"enabled":true,"display_text":"48Hr"},{"name":"Support","slug":"support","description":"","group":"feature","icon":"","links":{},"enabled":true,"display_text":"Email"}]}},"PlanListGet":{"value":[{"recurring":{"interval":"month","interval_count":1},"is_trial_plan":false,"plan_group":"default","tag_lines":[],"currency":"INR","is_active":true,"is_visible":true,"trial_period":0,"addons":[],"tags":[],"type":"public","country":"IN","_id":"60093f1aabffb61debbcb44b","product_suite_id":"60093f13632a0a1d6fb5cdc3","name":"2020won","description":"2020won","amount":21,"meta":{"tags":["2020won"]},"created_at":"2021-01-21T08:45:14.601Z","modified_at":"2021-01-21T08:45:14.601Z"},{"recurring":{"interval":"month","interval_count":1},"is_trial_plan":false,"plan_group":"default","tag_lines":[],"currency":"INR","is_active":true,"is_visible":true,"trial_period":0,"addons":[],"tags":[],"type":"public","country":"IN","_id":"60093f13632a0a1d6fb5cddc","name":"Standard","description":"Standard","amount":999,"product_suite_id":"60093f13632a0a1d6fb5cdc3","created_at":"2021-01-21T08:45:07.979Z","modified_at":"2021-01-21T08:45:07.979Z"},{"recurring":{"interval":"month","interval_count":1},"is_trial_plan":false,"plan_group":"default","tag_lines":[],"currency":"INR","is_active":true,"is_visible":true,"trial_period":0,"addons":[],"tags":[],"type":"public","country":"IN","_id":"60093f13632a0a1d6fb5cde0","name":"Professional","description":"Professional","amount":1499,"product_suite_id":"60093f13632a0a1d6fb5cdc3","created_at":"2021-01-21T08:45:07.985Z","modified_at":"2021-01-21T08:45:07.985Z"},{"recurring":{"interval":"month","interval_count":1},"is_trial_plan":false,"plan_group":"default","tag_lines":[],"currency":"INR","is_active":true,"is_visible":true,"trial_period":0,"addons":[],"tags":["popular"],"type":"public","country":"IN","_id":"60093f13632a0a1d6fb5cde1","name":"Premium","description":"Premium","amount":2499,"product_suite_id":"60093f13632a0a1d6fb5cdc3","created_at":"2021-01-21T08:45:07.985Z","modified_at":"2021-01-21T08:45:07.985Z"},{"recurring":{"interval":"month","interval_count":1},"is_trial_plan":false,"plan_group":"default","tag_lines":[],"currency":"INR","is_active":true,"is_visible":true,"trial_period":0,"addons":[],"tags":[],"type":"public","country":"IN","_id":"60093f13632a0a1d6fb5cddf","name":"Ultra Premium","description":"Ultra Premium","amount":2999,"product_suite_id":"60093f13632a0a1d6fb5cdc3","created_at":"2021-01-21T08:45:07.979Z","modified_at":"2021-01-21T08:45:07.979Z"}]},"Invoice":{"value":{"invoice":{"period":{"start":"2020-08-17T13:45:36.722Z","end":"2020-09-17T13:45:36.722Z"},"client":{"address_lines":["TV TOWER, Foot Over Bridge Khar","","Mumbai, 400079, Maharashtra, India"],"name":"RELIANCE RETAIL LTD","email":"ZAK@GMAIL.COM","phone":"91 1234567890"},"auto_advance":true,"currency":"INR","paid":true,"attemp":3,"_id":"5f7acb709e76da30e3b92cdb","collection_method":"charge_automatically","subscriber_id":"5ee773e1351e5e84289ed9cf","invoice_url":"","number":"FP-1-72020-736","pg_data":{},"receipt_number":"5fd9b08464dc6ac048a08988","statement_descriptor":"RELIANCE RETAIL LTD","current_status":"paid","status_trail":[{"_id":"5f7ad29bd562744eab216379","value":"draft","timestamp":"2020-10-05T08:00:27.753Z"},{"_id":"5fcf40ce1613c029aff417dd","value":"open","timestamp":"2020-12-08T09:01:02.038Z"},{"_id":"5fd9b08664dc6a1ad0a08989","value":"paid","timestamp":"2020-12-16T07:00:22.973Z"}],"subtotal":15720.08,"total":15720.08,"subscription":"5f3a8a00668947663b7fbd38","next_action_time":"2020-10-05T09:00:27.754Z","created_at":"2020-10-05T07:29:52.876Z","modified_at":"2020-12-16T07:00:22.980Z","hash_identifier":"575999aca03e36f0fa54db5235bc7f25","payment_method":{"pg_payment_method_id":""}},"invoice_items":[{"_id":"5f7acb709e76da48b1b92cdd","currency":"INR","plan":{"recurring":{"interval":"month","interval_count":1},"is_trial_plan":false,"plan_group":"default","tag_lines":[],"currency":"INR","is_active":true,"is_visible":true,"trial_period":0,"addons":[],"tags":[],"type":"public","country":"IN","_id":"5f3a8786c90d780037723a14","name":"Professional","description":"Professional","amount":1499,"product_suite_id":"5f3a8786c90d7800377239f3","created_at":"2020-08-17T13:35:02.802Z","modified_at":"2020-08-17T13:35:02.802Z"},"name":"Professional","quantity":1,"description":"Professional","period":{"start":"2020-08-17T13:45:36.722Z","end":"2020-10-05T07:29:52.868Z"},"unit_amount":2356.77,"amount":2356.77,"type":"subscription","invoice_id":"5f7acb709e76da30e3b92cdb","created_at":"2020-10-05T07:29:52.886Z","modified_at":"2020-10-05T07:29:52.886Z"},{"_id":"5f7acf199aa6830c4fe5e984","currency":"INR","plan":{"recurring":{"interval":"month","interval_count":1},"is_trial_plan":false,"plan_group":"default","tag_lines":[],"currency":"INR","is_active":true,"is_visible":true,"trial_period":0,"addons":[],"tags":["popular"],"type":"public","country":"IN","_id":"5f3a8786c90d780037723a13","name":"Premium","description":"Premium","amount":2499,"product_suite_id":"5f3a8786c90d7800377239f3","created_at":"2020-08-17T13:35:02.547Z","modified_at":"2020-08-17T13:35:02.547Z"},"name":"Premium","quantity":1,"description":"Premium","period":{"start":"2020-08-17T13:45:36.722Z","end":"2020-10-05T07:45:29.755Z"},"unit_amount":3929.87,"amount":3929.87,"type":"subscription","invoice_id":"5f7acb709e76da30e3b92cdb","created_at":"2020-10-05T07:45:29.765Z","modified_at":"2020-10-05T07:45:29.765Z"},{"_id":"5f7acf7da10a707fc502dcd4","currency":"INR","plan":{"recurring":{"interval":"month","interval_count":1},"is_trial_plan":false,"plan_group":"default","tag_lines":[],"currency":"INR","is_active":true,"is_visible":true,"trial_period":0,"addons":[],"tags":[],"type":"public","country":"IN","_id":"5f3a8786c90d780037723a16","name":"Ultra Premium","description":"Ultra Premium","amount":2999,"product_suite_id":"5f3a8786c90d7800377239f3","created_at":"2020-08-17T13:35:02.802Z","modified_at":"2020-08-17T13:35:02.802Z"},"name":"Ultra Premium","quantity":1,"description":"Ultra Premium","period":{"start":"2020-08-17T13:45:36.722Z","end":"2020-10-05T07:47:09.532Z"},"unit_amount":4716.27,"amount":4716.27,"type":"subscription","invoice_id":"5f7acb709e76da30e3b92cdb","created_at":"2020-10-05T07:47:09.541Z","modified_at":"2020-10-05T07:47:09.541Z"},{"_id":"5f7ad29bd56274f23321637a","currency":"INR","plan":{"recurring":{"interval":"month","interval_count":1},"is_trial_plan":false,"plan_group":"default","tag_lines":[],"currency":"INR","is_active":true,"is_visible":true,"trial_period":0,"addons":[],"tags":[],"type":"public","country":"IN","_id":"5f3a8786c90d780037723a16","name":"Ultra Premium","description":"Ultra Premium","amount":2999,"product_suite_id":"5f3a8786c90d7800377239f3","created_at":"2020-08-17T13:35:02.802Z","modified_at":"2020-08-17T13:35:02.802Z"},"name":"Ultra Premium","quantity":1,"description":"Ultra Premium","period":{"start":"2020-08-17T13:45:36.722Z","end":"2020-10-05T08:00:27.753Z"},"unit_amount":4717.17,"amount":4717.17,"type":"subscription","invoice_id":"5f7acb709e76da30e3b92cdb","created_at":"2020-10-05T08:00:27.768Z","modified_at":"2020-10-05T08:00:27.768Z"}]}},"Invoices":{"value":{"data":[{"_id":"5f7acb709e76da30e3b92cdb","client":{"name":"RELIANCE RETAIL LTD","email":"ZAK@GMAIL.COM","phone":"91 1234567890","address_lines":["TV TOWER, Foot Over Bridge Khar","Mumbai, 400079, Maharashtra, India"]},"auto_advance":true,"currency":"INR","paid":true,"attemp":3,"collection_method":"charge_automatically","subscriber_id":"5ee773e1351e5e84289ed9cf","invoice_url":"","number":"FP-1-72020-736","pg_data":{},"period":{"start":"2020-08-17T13:45:36.722Z","end":"2020-09-17T13:45:36.722Z"},"receipt_number":"5fd9b08464dc6ac048a08988","statement_descriptor":"RELIANCE RETAIL LTD","current_status":"paid","status_trail":[{"_id":"5f7ad29bd562744eab216379","value":"draft","timestamp":"2020-10-05T08:00:27.753Z"},{"_id":"5fcf40ce1613c029aff417dd","value":"open","timestamp":"2020-12-08T09:01:02.038Z"},{"_id":"5fd9b08664dc6a1ad0a08989","value":"paid","timestamp":"2020-12-16T07:00:22.973Z"}],"subtotal":15720.08,"total":15720.08,"subscription":"5f3a8a00668947663b7fbd38","next_action_time":"2020-10-05T09:00:27.754Z","created_at":"2020-10-05T07:29:52.876Z","modified_at":"2020-12-16T07:00:22.980Z","hash_identifier":"575999aca03e36f0fa54db5235bc7f25","payment_method":{"pg_payment_method_id":""},"invoice_items":[{"_id":"5f7acb709e76da48b1b92cdd","currency":"INR","plan":{"recurring":{"interval":"month","interval_count":1},"is_trial_plan":false,"plan_group":"default","tag_lines":[],"currency":"INR","is_active":true,"is_visible":true,"trial_period":0,"addons":[],"tags":[],"type":"public","country":"IN","_id":"5f3a8786c90d780037723a14","name":"Professional","description":"Professional","amount":1499,"product_suite_id":"5f3a8786c90d7800377239f3","created_at":"2020-08-17T13:35:02.802Z","modified_at":"2020-08-17T13:35:02.802Z"},"name":"Professional","quantity":1,"description":"Professional","period":{"start":"2020-08-17T13:45:36.722Z","end":"2020-10-05T07:29:52.868Z"},"unit_amount":2356.77,"amount":2356.77,"type":"subscription","invoice_id":"5f7acb709e76da30e3b92cdb","created_at":"2020-10-05T07:29:52.886Z","modified_at":"2020-10-05T07:29:52.886Z"},{"_id":"5f7acf199aa6830c4fe5e984","currency":"INR","plan":{"recurring":{"interval":"month","interval_count":1},"is_trial_plan":false,"plan_group":"default","tag_lines":[],"currency":"INR","is_active":true,"is_visible":true,"trial_period":0,"addons":[],"tags":["popular"],"type":"public","country":"IN","_id":"5f3a8786c90d780037723a13","name":"Premium","description":"Premium","amount":2499,"product_suite_id":"5f3a8786c90d7800377239f3","created_at":"2020-08-17T13:35:02.547Z","modified_at":"2020-08-17T13:35:02.547Z"},"name":"Premium","quantity":1,"description":"Premium","period":{"start":"2020-08-17T13:45:36.722Z","end":"2020-10-05T07:45:29.755Z"},"unit_amount":3929.87,"amount":3929.87,"type":"subscription","invoice_id":"5f7acb709e76da30e3b92cdb","created_at":"2020-10-05T07:45:29.765Z","modified_at":"2020-10-05T07:45:29.765Z"},{"_id":"5f7acf7da10a707fc502dcd4","currency":"INR","plan":{"recurring":{"interval":"month","interval_count":1},"is_trial_plan":false,"plan_group":"default","tag_lines":[],"currency":"INR","is_active":true,"is_visible":true,"trial_period":0,"addons":[],"tags":[],"type":"public","country":"IN","_id":"5f3a8786c90d780037723a16","name":"Ultra Premium","description":"Ultra Premium","amount":2999,"product_suite_id":"5f3a8786c90d7800377239f3","created_at":"2020-08-17T13:35:02.802Z","modified_at":"2020-08-17T13:35:02.802Z"},"name":"Ultra Premium","quantity":1,"description":"Ultra Premium","period":{"start":"2020-08-17T13:45:36.722Z","end":"2020-10-05T07:47:09.532Z"},"unit_amount":4716.27,"amount":4716.27,"type":"subscription","invoice_id":"5f7acb709e76da30e3b92cdb","created_at":"2020-10-05T07:47:09.541Z","modified_at":"2020-10-05T07:47:09.541Z"},{"_id":"5f7ad29bd56274f23321637a","currency":"INR","plan":{"recurring":{"interval":"month","interval_count":1},"is_trial_plan":false,"plan_group":"default","tag_lines":[],"currency":"INR","is_active":true,"is_visible":true,"trial_period":0,"addons":[],"tags":[],"type":"public","country":"IN","_id":"5f3a8786c90d780037723a16","name":"Ultra Premium","description":"Ultra Premium","amount":2999,"product_suite_id":"5f3a8786c90d7800377239f3","created_at":"2020-08-17T13:35:02.802Z","modified_at":"2020-08-17T13:35:02.802Z"},"name":"Ultra Premium","quantity":1,"description":"Ultra Premium","period":{"start":"2020-08-17T13:45:36.722Z","end":"2020-10-05T08:00:27.753Z"},"unit_amount":4717.17,"amount":4717.17,"type":"subscription","invoice_id":"5f7acb709e76da30e3b92cdb","created_at":"2020-10-05T08:00:27.768Z","modified_at":"2020-10-05T08:00:27.768Z"}]}],"start":0,"end":10,"limit":10,"page":1,"total":1}},"SubscriptionCustomerRes":{"value":{"phone":{"phone_number":"1234567890","phone_country_code":"91"},"billing_address":{"country":"India","state":"Maharastra","city":"Mumbai","line1":"test1","line2":"test2","postal_code":"400059"},"_id":"5ee773e1351e5e84289ed9cf","unique_id":"1","type":"company","name":"test retail","email":"test@gmail.com","created_at":"2020-06-15T13:13:05.267Z","modified_at":"2021-02-04T00:58:45.356Z","data":{"pg_user_exists":true,"id":2}}},"SubscriptionCustomerPostReq":{"value":{"unique_id":"1","type":"company","name":"test retail","email":"test@gmail.com","phone":{"phone_number":"1234567890","phone_country_code":"91"},"billing_address":{"country":"India","state":"Maharastra","city":"Mumbai","line1":"test1","line2":"test2","postal_code":"400059"}}},"SubscriptionActiveRes":{"value":{"is_enabled":true,"subscription":{"current_period":{"start":"2023-05-23T07:00:31.345Z","end":"2023-06-22T07:00:31.345Z"},"pause_collection":{},"trial":{},"invoice_settings":{"generation":true,"charging":true},"is_active":true,"cancel_at_period_end":false,"freezed":false,"channel_type":"ecomm","_id":"6385dc9389fe3577db6935f3","subscriber_id":"6385dc9289fe356a346935eb","plan_id":"5f2e30cad1456d00386abf1c","product_suite_id":"5f2e30cad1456d00386abefc","plan_data":{"plan_components":[{"is_active":true,"display_text":null,"_id":"5f2e30cbd1456d00386ac008","plan_id":"5f2e30cad1456d00386abf1c","created_at":"2020-08-08T04:57:47.829Z","modified_at":"2021-07-31T12:13:51.221Z","component":{"is_visible":true,"is_active":true,"is_display":true,"_id":"5f2e30cad1456d00386abefd","component_price_config":{"type":"display","display_text":"4%"},"name":"Transaction Fees","slug":"transaction-fee","description":"Transaction fees is inclusive of Payment Gateway","group":"Key Features","icon":"","product_suite_id":"5f2e30cad1456d00386abefc","created_at":"2020-08-08T04:57:46.648Z","modified_at":"2021-07-31T12:13:50.344Z","links":{}},"component_price":{"display_text":"3.5%","is_default":false,"is_active":true,"processing_type":"display","tags":[],"_id":"5f2e30cbd1456d00386abf77","component_id":"5f2e30cad1456d00386abefd","created_at":"2020-08-08T04:57:47.433Z","modified_at":"2023-04-21T07:04:22.574Z","__v":0}}],"components":[{"_id":"634569a3675d1912531e5ef3","component_price_config":{"type":"revenue","default_config":{"recurring":{"aggregate_usage":"sum","usage_type":"licensed","interval_count":1},"transform_quantity":{"divide_by":1,"round":"up"},"free_tier":{"type":"TIME_BASED","value":0},"unit_amount":0,"quantity":1,"price_type":"static","price_ui_type":"standard","bill_type":"one_time","billing_scheme":"per_unit","display_text":"Yes","tiers":[],"currency":"INR"},"display_text":"Free","price_meta":{"unit_amount":0,"price_type":"static","bill_type":"one_time","billing_scheme":"per_unit","transform_quantity":{"divide_by":1,"round":"up"}}},"is_visible":true,"is_active":true,"is_display":true,"product_suite_id":"5ececa006415744de9228e2e","name":"SSL Certificates","slug":"ssl-certificates","description":"","group":"Key Features","icon":"","links":{},"created_at":"2022-10-11T13:03:31.767Z","modified_at":"2023-04-21T07:04:23.544Z"}],"fee_components":[],"recurring":{"interval_count":1,"interval":"month"},"taxation":{"gst":0.18},"one_time_fees":{"developement":0,"marketing":0},"credit_line":{"is_active":false},"is_trial_plan":false,"plan_group":"default","tag_lines":[],"currency":"INR","is_active":true,"is_visible":true,"trial_period":0,"addons":[],"tags":["popular"],"type":"public","country":"IN","company_ids":[],"channel_type":"ecomm","_id":"5f2e30cad1456d00386abf1c","tagLines":[],"name":"Premium","description":"For scaled up businesses","amount":2499,"product_suite_id":"5f2e30cad1456d00386abefc","created_at":"2020-08-08T04:57:46.830Z","modified_at":"2023-04-21T07:04:22.363Z","current_status":"active","plan_leeway_after_activation":7,"activated_on":"2023-06-02T07:57:16.638Z"},"current_status":"active","collection_method":"charge_automatically","created_at":"2022-11-29T10:18:59.466Z","modified_at":"2023-06-02T07:57:17.254Z","latest_invoice":"6479a0dda77a156ad997bd4d"},"latest_invoice":{"documents":{},"payment":{},"period":{"start":"2023-05-23T07:00:31.345Z","end":"2023-06-22T07:00:31.345Z"},"client":{"address_lines":["TEST, TEST ,TEST, TEST","","NAVI MUMBAI, 400614, MAHARASHTRA, INDIA"],"name":"avi_test","email":"avinashsharma@gofynd.com","phone":"undefined undefined"},"discount":{},"taxation":{"cgst":0.09,"sgst":0.09,"igst":0},"auto_advance":false,"currency":"INR","paid":true,"attemp":1,"credit_note_amount":1768.82,"_id":"6479a0dda77a156ad997bd4d","collection_method":"charge_automatically","subscriber_id":"6385dc9289fe356a346935eb","invoice_url":"","number":"PS-P-A00515-FY24","pg_data":{},"old_settlement":999.33,"credit_balance":null,"receipt_number":"","statement_descriptor":"avi_test","current_status":"paid","status_trail":[{"_id":"6479a0dda77a157bd397bd4e","value":"open","timestamp":"2023-06-02T07:57:17.096Z"},{"_id":"6479a196244a37915c4b9448","value":"paid","timestamp":"2023-06-02T08:00:22.059Z"},{"_id":"6479a196e3c6582ed5ea7157","value":"paid","timestamp":"2023-06-02T08:00:22.099Z"}],"subtotal":2555.4900000000002,"total":786.67,"subscription":"6385dc9389fe3577db6935f3","next_action_time":"2023-06-02T07:57:17.112Z","meta":{"old_plan_amount":499.67,"new_plan_amount":1666,"credit_note_id":"FP-C27-A00055-24","isPlanChanged":true},"created_at":"2023-06-02T07:57:17.128Z","modified_at":"2023-06-02T08:00:23.182Z","hash_identifier":"987abf78c61bfef585242bbbeaab1b59","pdf_url":"https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/company/13781/self/subscription/documents/invoices/original/U6ffgNlo_-PS-P-A00515-FY24-paid.pdf"},"latestInvoice":{"documents":{},"payment":{},"period":{"start":"2023-05-23T07:00:31.345Z","end":"2023-06-22T07:00:31.345Z"},"client":{"address_lines":["TEST, TEST ,TEST, TEST","","NAVI MUMBAI, 400614, MAHARASHTRA, INDIA"],"name":"avi_test","email":"avinashsharma@gofynd.com","phone":"undefined undefined"},"discount":{},"taxation":{"cgst":0.09,"sgst":0.09,"igst":0},"auto_advance":false,"currency":"INR","paid":true,"attemp":1,"credit_note_amount":1768.82,"_id":"6479a0dda77a156ad997bd4d","collection_method":"charge_automatically","subscriber_id":"6385dc9289fe356a346935eb","invoice_url":"","number":"PS-P-A00515-FY24","pg_data":{},"old_settlement":999.33,"credit_balance":null,"receipt_number":"","statement_descriptor":"avi_test","current_status":"paid","status_trail":[{"_id":"6479a0dda77a157bd397bd4e","value":"open","timestamp":"2023-06-02T07:57:17.096Z"},{"_id":"6479a196244a37915c4b9448","value":"paid","timestamp":"2023-06-02T08:00:22.059Z"},{"_id":"6479a196e3c6582ed5ea7157","value":"paid","timestamp":"2023-06-02T08:00:22.099Z"}],"subtotal":2555.4900000000002,"total":786.67,"subscription":"6385dc9389fe3577db6935f3","next_action_time":"2023-06-02T07:57:17.112Z","meta":{"old_plan_amount":499.67,"new_plan_amount":1666,"credit_note_id":"FP-C27-A00055-24","isPlanChanged":true},"created_at":"2023-06-02T07:57:17.128Z","modified_at":"2023-06-02T08:00:23.182Z","hash_identifier":"987abf78c61bfef585242bbbeaab1b59","pdf_url":"https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/company/13781/self/subscription/documents/invoices/original/U6ffgNlo_-PS-P-A00515-FY24-paid.pdf"},"mandate_amount":"630000","current_subscriptions":[{"current_period":{"start":"2023-05-23T07:00:31.345Z","end":"2023-06-22T07:00:31.345Z"},"pause_collection":{},"trial":{},"invoice_settings":{"generation":true,"charging":true},"is_active":true,"cancel_at_period_end":false,"freezed":false,"channel_type":"ecomm","_id":"6385dc9389fe3577db6935f3","subscriber_id":"6385dc9289fe356a346935eb","plan_id":"5f2e30cad1456d00386abf1c","product_suite_id":"5f2e30cad1456d00386abefc","plan_data":{"plan_components":[{"is_active":true,"display_text":null,"_id":"5f2e30cbd1456d00386ac008","plan_id":"5f2e30cad1456d00386abf1c","created_at":"2020-08-08T04:57:47.829Z","modified_at":"2021-07-31T12:13:51.221Z","component":{"is_visible":true,"is_active":true,"is_display":true,"_id":"5f2e30cad1456d00386abefd","component_price_config":{"type":"display","display_text":"4%"},"name":"Transaction Fees","slug":"transaction-fee","description":"Transaction fees is inclusive of Payment Gateway","group":"Key Features","icon":"","product_suite_id":"5f2e30cad1456d00386abefc","created_at":"2020-08-08T04:57:46.648Z","modified_at":"2021-07-31T12:13:50.344Z","links":{}},"component_price":{"display_text":"3.5%","is_default":false,"is_active":true,"processing_type":"display","tags":[],"_id":"5f2e30cbd1456d00386abf77","component_id":"5f2e30cad1456d00386abefd","created_at":"2020-08-08T04:57:47.433Z","modified_at":"2023-04-21T07:04:22.574Z","__v":0}}],"components":[{"_id":"634569a3675d1912531e5ef3","component_price_config":{"type":"revenue","default_config":{"recurring":{"aggregate_usage":"sum","usage_type":"licensed","interval_count":1},"transform_quantity":{"divide_by":1,"round":"up"},"free_tier":{"type":"TIME_BASED","value":0},"unit_amount":0,"quantity":1,"price_type":"static","price_ui_type":"standard","bill_type":"one_time","billing_scheme":"per_unit","display_text":"Yes","tiers":[],"currency":"INR"},"display_text":"Free","price_meta":{"unit_amount":0,"price_type":"static","bill_type":"one_time","billing_scheme":"per_unit","transform_quantity":{"divide_by":1,"round":"up"}}},"is_visible":true,"is_active":true,"is_display":true,"product_suite_id":"5ececa006415744de9228e2e","name":"SSL Certificates","slug":"ssl-certificates","description":"","group":"Key Features","icon":"","links":{},"created_at":"2022-10-11T13:03:31.767Z","modified_at":"2023-04-21T07:04:23.544Z"}],"fee_components":[],"recurring":{"interval_count":1,"interval":"month"},"taxation":{"gst":0.18},"one_time_fees":{"developement":0,"marketing":0},"credit_line":{"is_active":false},"is_trial_plan":false,"plan_group":"default","tag_lines":[],"currency":"INR","is_active":true,"is_visible":true,"trial_period":0,"addons":[],"tags":["popular"],"type":"public","country":"IN","company_ids":[],"channel_type":"ecomm","_id":"5f2e30cad1456d00386abf1c","tagLines":[],"name":"Premium","description":"For scaled up businesses","amount":2499,"product_suite_id":"5f2e30cad1456d00386abefc","created_at":"2020-08-08T04:57:46.830Z","modified_at":"2023-04-21T07:04:22.363Z","current_status":"active","plan_leeway_after_activation":7,"activated_on":"2023-06-02T07:57:16.638Z"},"current_status":"active","collection_method":"charge_automatically","created_at":"2022-11-29T10:18:59.466Z","modified_at":"2023-06-02T07:57:17.254Z","latest_invoice":"6479a0dda77a156ad997bd4d"}]}},"SubscriptionInactiveRes":{"value":{"is_enabled":true,"message":"Subscription not enabled"}},"CurrentLimitRes":{"value":{"application":{"enabled":true,"hard_limit":25,"soft_limit":25},"marketplace":{"enabled":true},"other_platform":{"enabled":true},"team":{"limit":-1},"products":{"bulk":true,"limit":-1},"extensions":{"enabled":true,"limit":-1},"integrations":{"enabled":true,"limit":-1},"is_trial_plan":false}},"SubscriptionActivateReq":{"value":{"unique_id":"1","type":"company","product_suite":"fynd-platform","plan_id":"5ef1a72db9c566b5a5aa5f84","payment_method":"1"}},"SubscriptionActivateRes":{"value":{"success":true,"data":{"pause_collection":{},"trial":{},"invoice_settings":{"generation":true,"charging":true},"is_active":true,"cancel_at_period_end":false,"_id":"601b8e4a32d3e837ec662f5c","subscriber_id":"5ef5f810961ddf004c1457ac","plan_id":"5f3a8786c90d780037723a12","product_suite_id":"5f3a8786c90d7800377239f3","plan_data":{"recurring":{"interval":"month","interval_count":1},"is_trial_plan":false,"plan_group":"default","tag_lines":[],"currency":"INR","is_active":true,"is_visible":true,"trial_period":0,"addons":[],"tags":[],"type":"public","country":"IN","_id":"5f3a8786c90d780037723a12","name":"Standard","description":"Standard","amount":999,"product_suite_id":"5f3a8786c90d7800377239f3","created_at":"2020-08-17T13:35:02.547Z","modified_at":"2020-08-17T13:35:02.547Z"},"current_period":{"start":"2021-02-04T06:03:54.567Z","end":"2021-03-04T06:03:54.567Z"},"current_status":"active","collection_method":"charge_automatically","created_at":"2021-02-04T06:03:54.580Z","modified_at":"2021-02-04T06:03:54.580Z"}}},"CancelSubscriptionReq":{"value":{"unique_id":"1","type":"company","product_suite":"fynd-platform","subscription_id":"5eea10b4dae8da14752c3058"}},"CancelSubscriptionRes":{"value":{"success":true,"data":{"current_period":{"start":"2021-02-04T06:03:54.567Z","end":"2021-03-04T06:03:54.567Z"},"pause_collection":{},"trial":{},"invoice_settings":{"generation":true,"charging":true},"is_active":false,"cancel_at_period_end":false,"_id":"601b8e4a32d3e837ec662f5c","subscriber_id":"5ef5f810961ddf004c1457ac","plan_id":"5f3a8786c90d780037723a12","product_suite_id":"5f3a8786c90d7800377239f3","plan_data":{"recurring":{"interval":"month","interval_count":1},"is_trial_plan":false,"plan_group":"default","tag_lines":[],"currency":"INR","is_active":true,"is_visible":true,"trial_period":0,"addons":[],"tags":[],"type":"public","country":"IN","_id":"5f3a8786c90d780037723a12","name":"Standard","description":"Standard","amount":999,"product_suite_id":"5f3a8786c90d7800377239f3","created_at":"2020-08-17T13:35:02.547Z","modified_at":"2020-08-17T13:35:02.547Z"},"current_status":"canceled","collection_method":"charge_automatically","created_at":"2021-02-04T06:03:54.580Z","modified_at":"2021-02-04T08:52:25.806Z","cancel_at":"2021-02-04T08:52:25.802Z","canceled_at":"2021-02-04T08:52:25.802Z"}}},"SunscribePlanExample":{"value":{"entity_type":"subscription","collection_type":"online","plan_id":"64e8c18e548ddf67f0c4cb1f","callback_url":"https://platform.fyndx1.de/company/8029/billing/bills","meta":{"subscribe":true,"is_custom_plan":true,"is_plan_upgrade":false}}},"SubscriptionPlanResExample":{"value":{"redirect_url":"https://platform.fyndx1.de/company/8029/subscription/renew-plan?plan_id=64e8c18e548ddf67f0c4cb1f&transaction_id=64ec54e3202d2b0bd9fcd120&renew=true&callback_url=https://platform.fyndx1.de/company/8029/billing/bills&meta={\"subscribe\":true,\"is_custom_plan\":true,\"is_plan_upgrade\":false}","transaction_id":"64ec54e3202d2b0bd9fcd120","current_status":"initiated","meta":{"subscribe":true,"is_custom_plan":true,"is_plan_upgrade":false}}},"EventSubscriptionsBulkUpdateRequest":{"value":{"subscriptions":[{"_id":"64b2ddb856dd97a75c452f2d","template":{"sms":{"subscribed":true,"template":"65252a7f2b235b3b7a75e4be"},"email":{"subscribed":true,"template":"65252a196fcb371a2d6aa418"},"pushnotification":{"subscribed":false}}}]}},"EventSubscription":{"value":{"template":{"sms":{"subscribed":true,"template":"64aec4c4c987e14691600d1a"},"email":{"subscribed":true,"template":"64aec4c4c987e14691600d1a"},"pushnotification":{"subscribed":false}},"_id":"64b2ddb756dd97a75c452ee6","application":"64b2ddb6cb99a609e12a9bea","event":"64aec4c4c987e14691600d1d","slug":"arriving_early_out_for_delivery-event","category":"website","created_at":"2023-07-15T17:56:07.926Z","updated_at":"2023-10-07T09:41:32.836Z","__v":0}},"EventSubscriptionsBulkUpdateResponse":{"value":[{"template":{"sms":{"subscribed":true,"template":"65252a7f2b235b3b7a75e4be"},"email":{"subscribed":true,"template":"65252a196fcb371a2d6aa418"},"pushnotification":{"subscribed":false}},"_id":"64b2ddb856dd97a75c452f2d","application":"64b2ddb6cb99a609e12a9bea","event":"64aec4c6c987e14691600e2b","slug":"invite-event","category":"website","created_at":"2023-07-15T17:56:08.601Z","updated_at":"2023-10-10T10:50:28.781Z"}]},"SubscriptionsObject":{"value":{"_id":"64b2ddb856dd97a75c452f2d","template":{"sms":{"subscribed":true,"template":"64aec4c6c987e14691600e28"},"email":{"subscribed":true,"template":"65252a196fcb371a2d6aa418"},"pushnotification":{"subscribed":false}}}},"AppProvider":{"value":{"email":{"transaction":{"provider":"5f0408cec0c2a2175a1c16f6"},"promotional":{"provider":"6385ed1ebf50a6c9a61d58d5"},"otp":{"provider":"5f0408cec0c2a2175a1c16f6"}},"sms":{"transaction":{"provider":"63db8c68975237fff4f2133e"},"promotional":{"provider":"63db8c68975237fff4f2133e"},"otp":{"provider":"63db8c68975237fff4f21346"}},"voice":{"transaction":{"provider":"643cf4098bb1fc2c1d67f089"},"otp":{"provider":"643cf4098bb1fc2c1d67f089"}},"_id":"63e20ce7648381edb6de45ff","application":"637b6355dc65337da9b5c951","created_at":"2023-02-07T08:33:43.169Z","updated_at":"2023-05-30T07:16:39.161Z","__v":0}},"AppProviderReq":{"value":{"email":{"transaction":{"provider":"5f0408cec0c2a2175a1c16f6"},"otp":{"provider":"5f0408cec0c2a2175a1c16f6"},"promotional":{"provider":"6385ed1ebf50a6c9a61d58d5"}},"sms":{"transaction":{"provider":"63db8c68975237fff4f2133e"},"otp":{"provider":"63db8c68975237fff4f21346"},"promotional":{"provider":"637b67fa70083213e935be4a"}},"voice":{"transaction":{"provider":"643cf4098bb1fc2c1d67f089"},"otp":{"provider":"643cf4098bb1fc2c1d67f089"}}}},"GlobalProviders":{"value":{"email":[{"_id":"5f0408cec0c2a2175a1c16f6","name":"Fynd-falconide"}],"sms":[{"_id":"63db8c68975237fff4f2133e","name":"Fynd Transactional - timesinternet"},{"_id":"63db8c68975237fff4f21346","name":"Fynd OTP - timesinternet"}],"voice":[{"_id":"643cf4098bb1fc2c1d67f089","name":"Fynd-exotel"}]}},"GetStats":{"value":{"items":[{"_id":"6009a1ea1f6a61d88e80a867","imported":{"count":2},"processed":{"email":{"success":2,"failed":0,"suppressed":0},"sms":{"success":0,"failed":0,"suppressed":0}}}]}},"CampaignReq":{"value":{"recipient_headers":{"email":"email"},"email":{"template":{"key":"_id","value":"5fb6757a09fd90ca91917a60"},"provider":{"_id":"5e560652b5eb4b1f13b4d601","from_name":"Fynd","from_email":"hey@gofynd.com"}},"description":"","tags":[],"is_active":true,"datasource":"6009a1be1f6a61a13180a866","type":"email","name":"testing bq email","application":"000000000000000000000004"}},"Campaign":{"value":{"recipient_headers":{"email":"email"},"email":{"template":{"key":"_id","value":"5fb6757a09fd90ca91917a60"},"provider":{"_id":"5e560652b5eb4b1f13b4d601","from_name":"Fynd","from_email":"hey@gofynd.com"}},"description":"","tags":[],"is_active":true,"_id":"6009a1ea1f6a61d88e80a867","datasource":"6009a1be1f6a61a13180a866","type":"email","name":"testing bq email","application":"000000000000000000000004","created_at":"2021-01-21T15:46:50.357Z","updated_at":"2021-01-21T15:46:50.357Z","slug":"testing-bq-email-vPyAd1YB1","__v":0}},"Campaigns":{"value":{"items":[{"recipient_headers":{"email":"email"},"email":{"template":{"key":"_id","value":"5fb6757a09fd90ca91917a60"},"provider":{"_id":"5e560652b5eb4b1f13b4d601","from_name":"Fynd","from_email":"hey@gofynd.com"}},"description":"","tags":[],"is_active":true,"_id":"6009a1ea1f6a61d88e80a867","datasource":"6009a1be1f6a61a13180a866","type":"email","name":"testing bq email","application":"000000000000000000000004","created_at":"2021-01-21T15:46:50.357Z","updated_at":"2021-01-21T15:46:50.357Z","slug":"testing-bq-email-vPyAd1YB1","__v":0},{"recipient_headers":{"sms":"phone_number"},"sms":{"template":{"key":"_id","value":"5fb675d009fd903196917a61"},"provider":{"_id":"5e560652b5eb4b06f3b4d5ff"}},"description":"","tags":[],"is_active":true,"_id":"600981561f6a612c6080a85e","datasource":"600981461f6a614b2c80a85d","type":"sms","name":"test","application":"000000000000000000000004","created_at":"2021-01-21T13:27:50.848Z","updated_at":"2021-01-21T13:27:50.848Z","slug":"test-ipLO3c8Jh","__v":0}],"page":{"type":"number","current":1,"size":2,"item_total":2,"has_next":false}}},"GetNRecordsCsvReq":{"value":{"url":"https://api.fyndx0.de/common/assets/v1/proxy/fetch?url=https://hdn-1.addsale.com/x0/application/000000000000000000000004/datasources/2_r_D1jt6-test-1-entries.csv","header":true,"count":10}},"GetNRecordsCsvRes":{"value":{"items":[{"phone_number":"1234567890","email":"abcxyz@gofynd.com","firstname":"Abc","lastname":"Xyz","orderid":"1"}]}},"AudienceReq":{"value":{"name":"dummy data","description":"datasource that is dummy","tags":["tag1","tag2"],"file_url":"https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/fyndnp/wrkr/x5/application/64802b8bd4dc759bcc1fef86/datasources/wu10BBMXD-jsonviewer.csv","type":"raw_csv","records_count":1,"headers":["phone","mail"]}},"Audience":{"value":{"_id":"64ad30a15efbc5f85fb549d8","application":"64802b8bd4dc759bcc1fef86","name":"dummy ds","description":"desc","records_count":1,"type":"raw_csv","tags":["tag1","tag2"],"headers":["phone","mail"],"file_url":"https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/fyndnp/wrkr/x5/application/64802b8bd4dc759bcc1fef86/datasources/ODKRR6aBQ-jsonviewer.csv","is_active":true,"created_at":"2023-07-11T10:36:17.340Z","updated_at":"2023-07-11T10:36:17.340Z","slug":"dummy-1-5JrNGM8LA","__v":0}},"Audiences":{"value":{"items":[{"_id":"64ad30a15efbc5f85fb549d8","application":"64802b8bd4dc759bcc1fef86","name":"dummy ds","description":"desc","records_count":1,"type":"raw_csv","tags":["tag1","tag2"],"headers":["phone","mail"],"file_url":"https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/fyndnp/wrkr/x5/application/64802b8bd4dc759bcc1fef86/datasources/ODKRR6aBQ-jsonviewer.csv","is_active":true,"created_at":"2023-07-11T10:36:17.340Z","updated_at":"2023-07-11T10:36:17.340Z","slug":"dummy-1-5JrNGM8LA","__v":0}],"page":{"type":"number","current":1,"size":1,"item_total":1,"has_next":false}}},"DummyDatasources":{"value":[{"id":1,"name":"Data source 1"},{"id":2,"name":"Data source 2"}]},"DummyDatasourcesMeta":{"value":{"id":2,"data":{"b":2}}},"EmailProviderReq":{"value":{"name":"test","description":"test provider","keys":{"bcc":"abc@gofynd.com"},"from":"abc@gofynd.com","static_to":["abc@gofynd.com"],"static_cc":["abc@gofynd.com"],"static_bcc":["abc@gofynd.com"],"reply_to":"abc@gofynd.com","headers":[{"key":"x-test-header","value":"test123"}],"subject":{"providerType":"static","provider":"This is test email"},"html":{"providerType":"static","provider":"This is test email"},"text":{"providerType":"static","provider":"This is test email"},"attachments":[],"priority":"low"}},"EmailProvider":{"value":{"type":"application","provider":"falconide","from_address":[{"is_default":true,"name":"abc","email":"abc@test.com"}],"_id":"5fd9fd44c474a7e3d5d376d6","name":"test falconide","description":"test","api_key":"testtttt","application":"000000000000000000000004","created_at":"2020-12-16T12:27:48.051Z","updated_at":"2020-12-16T12:27:48.051Z","slug":"test-falconide-application-falconide-ZTD-D7wbB","__v":0}},"EmailProviders":{"value":{"items":[{"type":"application","provider":"falconide","from_address":[{"is_default":true,"name":"abc","email":"abc@test.com"}],"_id":"5fd9fd44c474a7e3d5d376d6","name":"test falconide","description":"test","api_key":"testtttt","application":"000000000000000000000004","created_at":"2020-12-16T12:27:48.051Z","updated_at":"2020-12-16T12:27:48.051Z","slug":"test-falconide-application-falconide-ZTD-D7wbB","__v":0}],"page":{"type":"number","current":1,"size":10,"item_total":1,"has_next":false}}},"EmailTemplateReq":{"value":{"name":"test","description":"test template","from_name":"Fynd","static_to":["abc@gofynd.com"],"static_cc":["abc@gofynd.com"],"static_bcc":["abc@gofynd.com"],"reply_to":"abc@gofynd.com","priority":"low","tags":["tag1"],"template_variables":{"hello":"world"},"published":true,"subject":{"template_type":"static","template":"This is the subject"},"html":{"template_type":"static","template":"<p>This is the HTML content</p>"},"editor_type":"bee","editor_meta":"","attachments":[],"headers":[{"key":"x-test-header","value":"test123"}],"keys":{"to":"abc@gofynd.com","cc":"abc@gofynd.com","bcc":"abc@gofynd.com"},"text":{"template_type":"static","template":"This is the plain text content"}}},"EmailTemplate":{"value":{"application":"637b6355dc65337da9b5c951","is_system":false,"is_internal":false,"name":"title","description":"desc","editor_type":"bee","editor_meta":"","static_to":[],"static_cc":["abc@abc.com"],"static_bcc":["abc@abc.com"],"reply_to":"abc@abc.com","tags":["tag"],"subject":{"template_type":"nunjucks","template":"subject"},"html":{"template_type":"nunjucks","template":""},"url_shorten":{"enabled":false},"priority":"low","template_variables":{"hello":"world"},"published":true,"category":"website","_id":"649fca8fe89b403f490f9c55","headers":[],"attachments":[],"created_at":"2023-07-01T06:41:19.360Z","updated_at":"2023-07-01T06:41:19.360Z","slug":"title-W9qbdl8AJ","__v":0,"from_name":"Fynd","text":{"template_type":"nunjucks","template":"subject"}}},"EmailTemplates":{"value":{"items":[{"application":"637b6355dc65337da9b5c951","is_system":false,"is_internal":false,"name":"title","description":"desc","editor_type":"bee","editor_meta":"","static_to":[],"static_cc":["abc@abc.com"],"static_bcc":["abc@abc.com"],"reply_to":"abc@abc.com","tags":["tag"],"subject":{"template_type":"nunjucks","template":"subject"},"html":{"template_type":"nunjucks","template":""},"url_shorten":{"enabled":false},"priority":"low","template_variables":{"hello":"world"},"published":true,"category":"website","_id":"649fca8fe89b403f490f9c55","headers":[],"attachments":[],"created_at":"2023-07-01T06:41:19.360Z","updated_at":"2023-07-01T06:41:19.360Z","slug":"title-W9qbdl8AJ","__v":0,"from_name":"Fynd","text":{"template_type":"nunjucks","template":"subject"}}],"page":{"type":"number","current":1,"size":1,"item_total":66,"has_next":true}}},"SystemEmailTemplates":{"value":{"url_shorten":{"enabled":true},"_id":"646b73e7e10612283cfd977f","is_system":true,"is_internal":false,"name":"Online order confirmed","slug":"bag_confirmed-email","description":"Use this email template for notifying the customers, that their order is Confirmed.","static_to":[],"static_cc":[],"static_bcc":[],"tags":[],"subject":{"template_type":"nunjucks","template":"{{ email_subject }}"},"html":{"template_type":"nunjucks","template":""},"text":{"template_type":"nunjucks","template":""},"priority":"high","template_variables":{},"published":true,"category":"website","headers":[],"attachments":[],"created_at":"2023-05-22T13:53:43.468Z","updated_at":"2023-05-22T13:53:43.468Z","__v":0}},"EngineRequest":{"value":{"payload":{"data":[{"to":"abc@gmail.com","cc":"xyz@gmail.com","bcc":"xyz@gmail.com","country_code":"+91","phone_number":"9876543210","ref_user":"5db050c86425272ce27bd5c5","ref_application":"611113b5d4beb64b288f8d66"}],"email":{"template":{"key":"event-slug","value":"order-placed-event"},"provider":{"_id":"611113b5d4beb64b288f8d66"}},"sms":{"template":{"key":"event-slug","value":"order-placed-event"},"provider":{"_id":"611113b5d4beb64b288f8d66"}},"application":"611113b5d4beb64b288f8d66"},"meta":{"job_type":"event","action":"send","trace":"partner.{uuid1}","timestamp":"2022-02-22T05:21:50.005Z"}}},"EngineResponse":{"value":{"success":true}},"EventSubscriptions":{"value":{"items":[{"template":{"sms":{"subscribed":true,"template":"null"},"email":{"subscribed":true,"template":"5e5653c1d503e0038407fc16"}},"is_default":true,"_id":"5e56598f2bfda9050ccaa8e8","application":"000000000000000000000004","event":"5e5653c1d503e0038407fc10","slug":"reset-password-event","created_at":"2020-02-26T11:42:08.164Z","updated_at":"2021-03-03T09:00:47.871Z","__v":0},{"template":{"sms":{"subscribed":true,"template":"null"},"email":{"subscribed":true,"template":"5e5653c1d503e0038407fc17"}},"is_default":true,"_id":"5e56598f2bfda9050ccaa911","application":"000000000000000000000004","event":"5e5653c1d503e0038407fc11","slug":"invite-email-event","created_at":"2020-02-26T11:42:08.174Z","updated_at":"2021-03-03T09:00:47.871Z","__v":0},{"template":{"sms":{"subscribed":true,"template":"null"},"email":{"subscribed":true,"template":"5e5653c1d503e0038407fc14"}},"is_default":true,"_id":"5e56598f2bfda9050ccaa8f2","application":"000000000000000000000004","event":"5e5653c1d503e0038407fc12","slug":"verify-email-event","created_at":"2020-02-26T11:42:08.172Z","updated_at":"2021-03-03T09:00:47.953Z","__v":0},{"template":{"sms":{"subscribed":true,"template":"null"},"email":{"subscribed":true,"template":"5e5653c1d503e0038407fc15"}},"is_default":true,"_id":"5e56598f2bfda9050ccaa8fd","application":"000000000000000000000004","event":"5e5653c1d503e0038407fc13","slug":"verify-otp-event","created_at":"2020-02-26T11:42:08.172Z","updated_at":"2021-03-03T09:00:47.953Z","__v":0},{"template":{"sms":{"subscribed":true,"template":"5e565a10343582051d211d1c"},"email":{"subscribed":true,"template":"5e565a10343582051d211d1b"}},"is_default":true,"_id":"5e565a16343582051d211d68","application":"000000000000000000000004","event":"5e565a10343582051d211d1d","slug":"cancelled_customer-event","created_at":"2020-02-26T11:44:22.246Z","updated_at":"2021-03-03T09:00:47.953Z","__v":0},{"template":{"sms":{"subscribed":true,"template":"5e565a10343582051d211d1f"},"email":{"subscribed":true,"template":"5e565a10343582051d211d1e"}},"is_default":true,"_id":"5e565a16343582051d211d6c","application":"000000000000000000000004","event":"5e565a11343582051d211d20","slug":"cancelled_fynd-event","created_at":"2020-02-26T11:44:22.314Z","updated_at":"2021-03-03T09:00:47.953Z","__v":0},{"template":{"sms":{"subscribed":true,"template":"5e565a11343582051d211d22"},"email":{"subscribed":true,"template":"5e565a11343582051d211d21"}},"is_default":true,"_id":"5e565a16343582051d211d65","application":"000000000000000000000004","event":"5e565a11343582051d211d23","slug":"delivery_done-event","created_at":"2020-02-26T11:44:22.246Z","updated_at":"2021-03-03T09:00:47.972Z","__v":0},{"template":{"sms":{"subscribed":true,"template":"5e565a11343582051d211d25"},"email":{"subscribed":true,"template":"5e565a11343582051d211d24"}},"is_default":true,"_id":"5e565a16343582051d211d61","application":"000000000000000000000004","event":"5e565a11343582051d211d26","slug":"out_for_delivery-event","created_at":"2020-02-26T11:44:22.171Z","updated_at":"2021-03-03T09:00:47.972Z","__v":0},{"template":{"sms":{"subscribed":true,"template":"5e565a12343582051d211d28"},"email":{"subscribed":true,"template":"5e565a11343582051d211d27"}},"is_default":true,"_id":"5e565a16343582051d211d62","application":"000000000000000000000004","event":"5e565a12343582051d211d29","slug":"out_for_pickup-event","created_at":"2020-02-26T11:44:22.171Z","updated_at":"2021-03-03T09:00:47.972Z","__v":0},{"template":{"sms":{"subscribed":true,"template":"5e565a12343582051d211d2b"},"email":{"subscribed":true,"template":"5e565a12343582051d211d2a"}},"is_default":true,"_id":"5e565a16343582051d211d69","application":"000000000000000000000004","event":"5e565a12343582051d211d2c","slug":"placed-event","created_at":"2020-02-26T11:44:22.246Z","updated_at":"2021-03-03T09:00:47.953Z","__v":0},{"template":{"sms":{"subscribed":true,"template":"5e565a12343582051d211d2e"},"email":{"subscribed":true,"template":"5e565a12343582051d211d2d"}},"is_default":true,"_id":"5e565a16343582051d211d66","application":"000000000000000000000004","event":"5e565a12343582051d211d2f","slug":"refund_completed-event","created_at":"2020-02-26T11:44:22.246Z","updated_at":"2021-03-03T09:00:48.052Z","__v":0},{"template":{"sms":{"subscribed":true,"template":"5e565a13343582051d211d31"},"email":{"subscribed":true,"template":"5e565a12343582051d211d30"}},"is_default":true,"_id":"5e565a16343582051d211d64","application":"000000000000000000000004","event":"5e565a13343582051d211d32","slug":"refund_initiated-event","created_at":"2020-02-26T11:44:22.246Z","updated_at":"2021-03-03T09:00:47.972Z","__v":0},{"template":{"sms":{"subscribed":true,"template":"5e565a13343582051d211d34"},"email":{"subscribed":true,"template":"5e565a13343582051d211d33"}},"is_default":true,"_id":"5e565a16343582051d211d6d","application":"000000000000000000000004","event":"5e565a13343582051d211d35","slug":"rejected_by_customer-event","created_at":"2020-02-26T11:44:22.314Z","updated_at":"2021-03-03T09:00:47.972Z","__v":0},{"template":{"sms":{"subscribed":true,"template":"5e565a13343582051d211d37"},"email":{"subscribed":true,"template":"5e565a13343582051d211d36"}},"is_default":true,"_id":"5e565a16343582051d211d63","application":"000000000000000000000004","event":"5e565a13343582051d211d38","slug":"return_accepted-event","created_at":"2020-02-26T11:44:22.178Z","updated_at":"2021-03-03T09:00:48.052Z","__v":0},{"template":{"sms":{"subscribed":true,"template":"5e565a14343582051d211d3a"},"email":{"subscribed":true,"template":"5e565a13343582051d211d39"}},"is_default":true,"_id":"5e565a16343582051d211d6a","application":"000000000000000000000004","event":"5e565a14343582051d211d3b","slug":"return_bag_picked_by_dp-event","created_at":"2020-02-26T11:44:22.246Z","updated_at":"2021-03-03T09:00:48.052Z","__v":0},{"template":{"sms":{"subscribed":true,"template":"5e565a14343582051d211d3d"},"email":{"subscribed":true,"template":"5e565a14343582051d211d3c"}},"is_default":true,"_id":"5e565a16343582051d211d67","application":"000000000000000000000004","event":"5e565a14343582051d211d3e","slug":"return_initiated-event","created_at":"2020-02-26T11:44:22.246Z","updated_at":"2021-03-03T09:00:48.052Z","__v":0},{"template":{"sms":{"subscribed":true,"template":"5e565a14343582051d211d40"},"email":{"subscribed":true,"template":"5e565a14343582051d211d3f"}},"is_default":true,"_id":"5e565a16343582051d211d6b","application":"000000000000000000000004","event":"5e565a14343582051d211d41","slug":"return_not_accepted-event","created_at":"2020-02-26T11:44:22.314Z","updated_at":"2021-03-03T09:00:48.052Z","__v":0},{"template":{"sms":{"subscribed":true,"template":"5e565a15343582051d211d43"},"email":{"subscribed":true,"template":"5e565a15343582051d211d42"}},"is_default":true,"_id":"5e565a16343582051d211d6e","application":"000000000000000000000004","event":"5e565a15343582051d211d44","slug":"return_request_cancelled-event","created_at":"2020-02-26T11:44:22.314Z","updated_at":"2021-03-03T09:00:48.052Z","__v":0},{"template":{"sms":{"subscribed":true,"template":"5e6a4b6d610dbf44166e74ba"},"email":{"subscribed":true,"template":"null"}},"is_default":true,"_id":"5e6a4b6e610dbf6b2a6e74c4","application":"000000000000000000000004","event":"5e6a4b6d610dbf3b146e74bb","slug":"handed_over_to_customer-event","created_at":"2020-03-12T14:47:10.453Z","updated_at":"2021-03-03T09:00:48.141Z","__v":0},{"template":{"sms":{"subscribed":true,"template":"5e6a4b6d610dbf01326e74b6"},"email":{"subscribed":true,"template":"null"}},"is_default":true,"_id":"5e6a4b6e610dbf907e6e74c2","application":"000000000000000000000004","event":"5e6a4b6d610dbf454e6e74b7","slug":"arrived_at_store-event","created_at":"2020-03-12T14:47:10.453Z","updated_at":"2021-03-03T09:00:48.052Z","__v":0},{"template":{"sms":{"subscribed":true,"template":"5e6a4b6d610dbf69b16e74b8"},"email":{"subscribed":true,"template":"null"}},"is_default":true,"_id":"5e6a4b6e610dbf28086e74c3","application":"000000000000000000000004","event":"5e6a4b6d610dbf91c76e74b9","slug":"bag_packed-event","created_at":"2020-03-12T14:47:10.453Z","updated_at":"2021-03-03T09:00:48.052Z","__v":0},{"template":{"sms":{"subscribed":true,"template":"null"},"email":{"subscribed":true,"template":"5ed72116ccc0c408fbb5a404"}},"is_default":true,"_id":"5ed72117ccc0c48f29b5a408","application":"000000000000000000000004","event":"5ed72116ccc0c4e240b5a405","slug":"order-review-reminder-event","created_at":"2020-06-03T04:03:35.394Z","updated_at":"2021-03-03T09:00:48.052Z","__v":0},{"template":{"sms":{"subscribed":true,"template":"5f633b15b490eaf13f494bf4"},"email":{"subscribed":true,"template":"null"}},"is_default":true,"_id":"5f633b16b490ea31eb494bfd","application":"000000000000000000000004","event":"5f633b15b490ea3c9b494bf5","slug":"referral-code-applied-to-referrer","created_at":"2020-09-17T10:31:50.204Z","updated_at":"2021-03-03T09:00:48.141Z","__v":0},{"template":{"sms":{"subscribed":true,"template":"5f633b15b490ea465b494bf2"},"email":{"subscribed":true,"template":"null"}},"is_default":true,"_id":"5f633b16b490eada59494bfc","application":"000000000000000000000004","event":"5f633b15b490ea40dd494bf3","slug":"referral-code-applied-to-referred-friend","created_at":"2020-09-17T10:31:50.204Z","updated_at":"2021-03-03T09:00:48.141Z","__v":0},{"template":{"sms":{"subscribed":true,"template":"5fe2e7da09c5fc047172e830"},"email":{"subscribed":true,"template":"null"}},"is_default":true,"_id":"5fe2e7dc09c5fc657372e841","application":"000000000000000000000004","event":"5fe2e7da09c5fc3da372e831","slug":"return_dp_out_for_pickup-event","created_at":"2020-12-23T06:46:52.214Z","updated_at":"2021-03-03T09:00:48.141Z","__v":0},{"template":{"sms":{"subscribed":true,"template":"5fe2e7da09c5fcef0a72e82b"},"email":{"subscribed":true,"template":"5ff841fd864df30915c416e9"}},"is_default":true,"_id":"600951fb0e9745637d2e5081","application":"000000000000000000000004","event":"5fe2e7da09c5fc524f72e82c","slug":"delivery_attempt_failed-event","created_at":"2021-01-21T10:05:47.315Z","updated_at":"2021-03-03T09:00:48.141Z","__v":0},{"template":{"sms":{"subscribed":true,"template":"5fe2e7da09c5fc6c5272e82e"},"email":{"subscribed":true,"template":"5fe2e7da09c5fc7fee72e82d"}},"is_default":true,"_id":"5fe2e7dc09c5fc10fe72e840","application":"000000000000000000000004","event":"5fe2e7da09c5fc611c72e82f","slug":"return_bag_picked-event","created_at":"2020-12-23T06:46:52.214Z","updated_at":"2021-03-03T09:00:48.141Z","__v":0},{"template":{"sms":{"subscribed":true,"template":"5fe2e7da09c5fc4cde72e829"},"email":{"subscribed":true,"template":"null"}},"is_default":true,"_id":"5fe2e7dc09c5fcf4fc72e83e","application":"000000000000000000000004","event":"5fe2e7da09c5fc72d272e82a","slug":"bag_picked-event","created_at":"2020-12-23T06:46:52.214Z","updated_at":"2021-03-03T09:00:48.141Z","__v":0}],"page":{"type":"number","current":1,"size":200,"item_total":28,"has_next":false}}},"GlobalVariablesGetResponse":{"value":{"read_only":{"app.address.address_line":[],"app.shipping_policy":"","app.returns_policy":"","app.terms_policy":"","app.copyright_text":null,"app.address_line":"","app.city_pincode":"","app.logo_url":null,"app.support_email":null,"app.support_mobile":null,"app.contact_us":"","app.domain":"","app.privacy_policy":"https://fynd.freshdesk.com/support/solutions/articles/33000214398-privacy-policy"},"editable":{"service_country":"uzbekistan","service_name":"fynd","service_platform":"fynd platform"}}},"GlobalVariablesPostResponse":{"value":{"_id":"64a2be215cc595c57fa0e40a","category":"website","application":"637b6355dc65337da9b5c951","global_variables":{"service_country":"uzbekistan","service_name":"fynd-plato","service_platform":"fynd platform"},"created_at":"2023-07-03T12:25:05.819Z"}},"GlobalVariablesReq":{"value":{"global_variables":{"service_country":"uzbekistan","service_name":"fynd-plato","service_platform":"fynd platform"}}},"Jobs":{"value":{"items":[{"completed":true,"is_active":false,"_id":"6044be260c92a7be0624f1cf","campaign":"6044be1e0c92a7026924f1ce","application":"000000000000000000000001","created_at":"2021-03-07T11:51:02.234Z","updated_at":"2021-03-07T12:12:36.587Z","__v":0}],"page":{"type":"number","current":1,"size":50,"item_total":1,"has_next":false}}},"CreateJobsReq":{"value":{"campaign":"656c9cad5638b4af9e2329af"}},"CreateJobsRes":{"value":{"application":"000000000000000000000004","campaign":"656c9cad5638b4af9e2329af","completed":true,"is_active":true,"_id":"5fd9fd44c474a7e3d5d376d6","created_at":"2020-12-16T12:27:48.051Z","updated_at":"2020-12-16T12:27:48.051Z","__v":0}},"JobLogs":{"value":{"items":[{"imported":{"count":61135},"processed":{"email":{"success":0,"failed":0,"suppressed":0},"sms":{"success":61313,"failed":85,"suppressed":87}},"_id":"6044be30bc5f4b79aae7b29f","job":"6044be260c92a7be0624f1cf","campaign":"6044be1e0c92a7026924f1ce","created_at":"2021-03-07T11:51:12.778Z","updated_at":"2021-03-07T12:14:11.475Z","__v":0}],"page":{"type":"number","current":1,"size":50,"item_total":1,"has_next":false}}},"TriggerJobRequest":{"value":{"job_id":"60458c3874957307e6cd5a01"}},"TriggerJobResponse":{"value":{"status":200}},"Logs":{"value":{"items":[{"sms":{"phone_number":"1234567890","country_code":"+91","template":"603e00649014219f87943213","provider":"5f8ee2234d70f7c5624f0413"},"pushnotification":{"pushtokens":[]},"meta":{"type":"job","job":"603e021f171b19ee5a4324f4","campaign":"603e0217171b19556e4324f3","identifier":"pointblank.00395d65-c0a9-f9dc-0c46-5d65c0aa0c46"},"_id":"603e02300b9f817e1592fcbd","application":"000000000000000000000004","service":"sms-consumer","step":"MSG_SENT","status":"success","pod":"fynd-core-pointblank-smslow-cnsmr-dply-d6dbf9d7f-b6h2f","expire_at":"2021-04-01T09:15:28.526Z","created_at":"2021-03-02T09:15:28.527Z"}],"page":{"type":"cursor","next_id":"null","has_previous":false,"has_next":false}}},"SendOtpCommsReq":{"value":{"data":{"send_same_otp_to_channel":true,"mobile":"9096686804","country_code":"91","to":"parvezshaikh@gofynd.com"},"sms":{"otp_length":4,"expiry":300,"template":{"key":"event-slug","value":"verify-otp-event-platform"},"provider":{"slug":"fynd-otp-netcore"}},"email":{"otp_length":4,"expiry":300,"template":{"key":"event-slug","value":"verify-otp-event-platform"}}}},"SendOtpCommsRes":{"value":{"sms":{"success":true,"request_id":"c8d1bd63d56a2d368aae9dbd4e7d8326","message":"OTP sent","mobile":"9096686804","country_code":"91","resend_timer":30},"email":{"success":true,"request_id":"1cc79c911923971580d903039ea9ee05","message":"OTP sent","to":"parvezshaikh@gofynd.com","resend_timer":30}}},"VerifyOtpCommsReq":{"value":{"request_id":"c8d1bd63d56a2d368aae9dbd4e7d8326","otp":"3916"}},"VerifyOtpCommsSuccessRes":{"value":{"success":true,"mobile":"9096686804","country_code":"91","message":"OTP verified"}},"VerifyOtpCommsErrorRes":{"value":{"success":false,"message":"Invalid request"}},"SmsProviderReq":{"value":{"name":"Telspiel","description":"An Sms provider","sender":"GOFYND","username":"username","authkey":"TtelspielGOFYND","type":"application","provider":"telspiel","password":"telspielGOFYND","senderid":"GOFYND","feedid":"GOFYND","entityid":"GOFYND","override_dnd":true,"host":"fynd.com","port":2290,"entity_id":"GOFYND","apikey":"TtelspielGOFYND","version_id":1,"sender_id":"GOFYND","api_key":"TtelspielGOFYND"}},"SmsProvider":{"value":{"rpt":1,"type":"application","provider":"telspiel","_id":"5fd9fd07c474a7710dd376d5","name":"test telspiel","description":"test","sender":"test","username":"test","authkey":"test","application":"000000000000000000000004","created_at":"2020-12-16T12:26:47.794Z","updated_at":"2020-12-16T12:26:47.794Z","slug":"test-telspiel-application-telspiel-p9UY1r7nG","__v":0}},"SmsProviders":{"value":{"items":[{"rpt":1,"type":"application","provider":"telspiel","_id":"5fd9fd07c474a7710dd376d5","name":"test telspiel","description":"test","sender":"test","username":"test","authkey":"test","application":"000000000000000000000004","created_at":"2020-12-16T12:26:47.794Z","updated_at":"2020-12-16T12:26:47.794Z","slug":"test-telspiel-application-telspiel-p9UY1r7nG","__v":0}],"page":{"type":"number","current":1,"size":1,"item_total":1,"has_next":false}}},"DefaultSmsProviders":{"value":[{"_id":"63db8c68975237fff4f2133e","name":"Fynd timesinternet","is_default":true}]},"SmsTemplates":{"value":{"items":[{"url_shorten":{"enabled":false},"_id":"649968feca21d7edd0595b35","application":"637b6355dc65337da9b5c951","is_system":false,"is_internal":false,"meta":{"type":"cloned","template":"61963d42ce3af81bde44a67d","is_system":true},"name":"TD sms templates","description":"description","message":{"template_type":"nunjucks","template":"This is a test message"},"priority":"low","tags":["tag1","tag2"],"template_variables":{"hello":"world"},"template_id":"1234567891234567890123","published":true,"category":"website","created_at":"2023-06-26T10:31:26.212Z","updated_at":"2023-06-26T10:31:26.212Z","slug":"TD-sms-templates-KwtzEUcpn","__v":0}],"page":{"type":"number","current":1,"size":10,"item_total":17,"has_next":true}}},"SystemSmsTemplates":{"value":[{"url_shorten":{"enabled":false},"_id":"646b73e7e10612283cfd9773","is_system":true,"is_internal":false,"name":"Order Arrived at Store","description":"Use this SMS template, for notifying the customers, that their requested order has arrived at the store.","slug":"arrived_at_store-sms","message":{"template_type":"nunjucks","template":"Delivered. Your shipment for {{ articles }} with {{ orderID }} has been delivered today at {{ delivered_at }}. You can collect it from store on or before {{ collection_date }}. Notification via Fynd"},"priority":"low","tags":[],"template_variables":{"email":"care@fynd.com","orderID":"Order ID FY5E53AFAA091115C235","brand":"SAPPER","name":"Alwira Sheikh","tracking_url":"http://go.fyndi.ng/track-order","articles":"Blue Solid Slim Fit Trackpants (28)","contact":8767087087,"ordering_channel":"ECOMM","delivered_at":"GT_Store, Vashi","collection_date":"Fri, Nov 15","credits":0,"slot":"By 9:00 PM","datetime":"Feb 28","cashback":0,"ref_application":{"support_email":"care@fynd.com","app_information":{"additional_data":{"address_line":"Kurar village,Malad","city_pincode":"Mumbai - 400097","contactUs":"https://uniket-testing.addsale.link/contact-us","domain":"uniket-testing.addsale.link","privacyPolicy":"https://fynd.freshdesk.com/support/solutions/articles/33000214398-privacy-policy"}},"domain":{"name":"https://fynd.com"},"logo":{"secure_url":"https://res.cloudinary.com/dwzm9bysq/image/upload/v1587981831/production/system/pointblank/fynd_logo_square_vunk4f.png"}}},"template_id":"1007569169965694807","published":true,"category":"website","created_at":"2023-05-22T13:53:43.439Z","updated_at":"2023-05-22T13:53:43.439Z","__v":0}]},"SmsTemplate":{"value":{"url_shorten":{"enabled":false},"_id":"649968feca21d7edd0595b35","application":"637b6355dc65337da9b5c951","is_system":false,"is_internal":false,"meta":{"type":"cloned","template":"61963d42ce3af81bde44a67d","is_system":true},"name":"TD sms templates","description":"description","message":{"template_type":"nunjucks","template":"This is a test message"},"priority":"low","tags":["tag1","tag2"],"template_variables":{"hello":"world"},"template_id":"1234567891234567890123","published":true,"category":"website","created_at":"2023-06-26T10:31:26.212Z","updated_at":"2023-06-26T10:31:26.212Z","slug":"TD-sms-templates-KwtzEUcpn","__v":0}},"SmsTemplateReq":{"value":{"name":"Invite SMS","description":"Use this SMS template for inviting customers as staff in your application.","priority":"high","template_id":"1007726349081611801","meta":{"type":"cloned","template":"61963d42ce3af81bde44a67d","is_system":true},"template_variables":{"message":"Welcome to Fynd","inviteUrl":"http://fynd.com"},"published":true,"message":{"template_type":"nunjucks","template":"{{ message }}. You have been invited to join us. Click {{ inviteUrl }} to accept the invite - Team Fynd"}}},"SystemNotifications":{"value":{"items":[{"notification":{"title":"Xyz Company is verified!","body":"","subtitle":"","icon":"icon.png","deeplink":"","click_action":""},"user":{"type":"company","value":"1"},"settings":{"sound":true,"priority":"normal","time_to_live":"60"},"_id":"60619f167dbd13ff0722f6dd","group":"fynd-platform","created_at":"2021-03-29T09:34:14.182Z"}],"last_read_anchor":1616748860,"page":{"type":"number","current":1,"size":1,"item_total":1,"has_next":false}}},"GenericError":{"value":{"message":{"message":"Oops! Something went wrong. Please try later","success":false,"info":"an informational message that is general in nature regarding the error","operation":"PRO-EP-GET"},"sentry":"888c31817a054325a47ab20f4e3f8199"}},"GenericDelete":{"value":{"message":"Deletion Successfull","acknowledged":true,"affected":1,"operation":"TEMP-ST-DEL:ID"}},"OtpConfigurationRes":{"value":{"type":"numeric","otp_length":4,"expiry":{"type":"new","duration":{"time":5,"denomination":"min"}},"application_id":"6399ba6924ab1bacf0131492","company_id":"1"}},"BlogRequest":{"value":{"title":"Art of a Nature","slug":"art-of-nature","feature_image":{"secure_url":"https://google.com/feature-image-url"},"content":[{"type":"html","value":"<p>hey there!</p>"}],"seo":{"title":"my first blog","description":"hey this is my first blog","image":{"url":""}},"_schedule":{"cron":"* 10 * * *","start":"2021-03-31T23:30:00.000Z","end":"2021-03-31T23:55:00.000Z","duration":1000},"published":true,"type":"html","tags":["art"]}},"BlogResponse":{"value":{"_id":"5eaa451a21a4dd75f0fd96c5","application":"5d3ebd89f540e7506b8b3548","tags":["abhinav"],"title":"my first blog","slug":"1st_blog","feature_image":{"secure_url":"https://google.com"},"content":[{"type":"html","value":"<p>hey there!</p>"}],"_schedule":{"cron":"* 10 * * *","start":"2021-03-31T23:30:00.000Z","end":"2021-03-31T23:55:00.000Z","duration":1000,"next_schedule":[{"start":"2021-03-17T04:30:00.000Z","end":"2021-03-17T04:46:40.000Z"}]},"published":true,"author":{"name":"Fynd App"},"date_meta":{"created_on":"2021-03-14T06:49:03.945Z","modified_on":"2021-03-14T06:49:03.945Z"}}},"BlogGetResponse":{"value":{"items":[{"date_meta":{"created_on":"2021-03-14T06:49:03.945Z","modified_on":"2021-03-14T06:49:03.945Z"},"tags":[],"_id":"604db275b3ae202873964d94","content":[{"type":"html","value":"<p>test abhinav</p>"}],"title":"1st Blog","slug":"1st-blog","published":true,"_schedule":{"next_schedule":[{}],"start":"2021-04-08T07:15:13.000Z","end":"2021-04-10T02:00:00.000Z"},"feature_image":{"secure_url":""},"application":"000000000000000000000001","author":{"name":"Fynd App"}}],"page":{"type":"number","current":1,"size":1,"item_total":2,"has_next":true}}},"Announcement":{"value":{"platforms":["web","android","ios"],"_id":"6026283125f06a827dc1a5cc","title":"test","announcement":"<p>test123</p>\n","pages":[{"page_slug":"$all","type":"custom"}],"editor_meta":{"foreground_color":"#000","background_color":"#fff","content_type":"markdown","content":"test"},"_schedule":{"published":true,"next_schedule":[{"start":"2021-02-10T20:40:00.000Z","end":"2021-02-18T22:00:00.000Z"}],"cron":"","start":"2021-02-10T20:40:00.000Z","end":"2021-02-18T22:00:00.000Z","duration":0},"app":"000000000000000000000001","author":{"created_by":"5e199e6998cfe1776f1385dc","modified_by":"5e199e6998cfe1776f1385dc"},"created_at":"2021-02-12T07:03:13.503Z","modified_at":"2021-02-12T07:05:57.020Z"}},"GetAnnouncementList":{"value":{"items":[{"_id":"6026283125f06a827dc1a5cc","platforms":["web","android","ios"],"title":"test","announcement":"<p>test</p>\n","pages":[{"page_slug":"$all","type":"custom"}],"editor_meta":{"foreground_color":"#000","background_color":"#fff","content_type":"markdown","content":"test"},"_schedule":{"published":true,"cron":"","start":"2021-02-10T20:40:00.000Z","end":"2021-02-18T22:00:00.000Z","duration":0,"next_schedule":[{"start":"2021-02-10T20:40:00.000Z","end":"2021-02-18T22:00:00.000Z"}]},"app":"000000000000000000000001","author":{"created_by":"5e199e6998cfe1776f1385dc","modified_by":"5e199e6998cfe1776f1385dc"},"created_at":"2021-02-12T07:03:13.503Z","modified_at":"2021-02-12T07:03:13.503Z","id":"6026283125f06a827dc1a5cc"}],"page":{"type":"number","current":1,"size":10,"item_total":1,"has_next":false}}},"CreateAnnouncement":{"value":{"message":"Successfully saved announcement","data":{"value":{"platforms":["web","android","ios"],"_id":"6026283125f06a827dc1a5cc","title":"test","announcement":"<p>test123</p>\n","pages":[{"page_slug":"$all","type":"custom"}],"editor_meta":{"foreground_color":"#000","background_color":"#fff","content_type":"markdown","content":"test"},"_schedule":{"published":true,"next_schedule":[{"start":"2021-02-10T20:40:00.000Z","end":"2021-02-18T22:00:00.000Z"}],"cron":null,"start":"2021-02-10T20:40:00.000Z","end":"2021-02-18T22:00:00.000Z","duration":null},"app":"000000000000000000000001","author":{"created_by":"5e199e6998cfe1776f1385dc","modified_by":"5e199e6998cfe1776f1385dc"},"created_at":"2021-02-12T07:03:13.503Z","modified_at":"2021-02-12T07:05:57.020Z"}}}},"Schedule":{"value":{"published":true,"cron":"* * * * *","start":"2021-02-10T20:40:00.000Z","end":"2021-02-18T22:00:00.000Z","duration":600,"next_schedule":[]}},"UpdateAnnouncement":{"value":{"message":"Successfully updated announcement","data":{"value":{"platforms":["web","android","ios"],"_id":"6026283125f06a827dc1a5cc","title":"test","announcement":"<p>test123</p>\n","pages":[{"page_slug":"$all","type":"custom"}],"editor_meta":{"foreground_color":"#000","background_color":"#fff","content_type":"markdown","content":"test"},"_schedule":{"published":true,"next_schedule":[{"start":"2021-02-10T20:40:00.000Z","end":"2021-02-18T22:00:00.000Z"}],"cron":null,"start":"2021-02-10T20:40:00.000Z","end":"2021-02-18T22:00:00.000Z","duration":null},"app":"000000000000000000000001","author":{"created_by":"5e199e6998cfe1776f1385dc","modified_by":"5e199e6998cfe1776f1385dc"},"created_at":"2021-02-12T07:03:13.503Z","modified_at":"2021-02-12T07:05:57.020Z"}}}},"PatchAnnouncement":{"value":{"message":"Announcement unpublished","data":{"value":{"platforms":["web","android","ios"],"_id":"6026283125f06a827dc1a5cc","title":"test","announcement":"<p>test123</p>\n","pages":[{"page_slug":"$all","type":"custom"}],"editor_meta":{"foreground_color":"#000","background_color":"#fff","content_type":"markdown","content":"test"},"_schedule":{"published":false,"next_schedule":[{"start":"2021-02-10T20:40:00.000Z","end":"2021-02-18T22:00:00.000Z"}],"cron":null,"start":"2021-02-10T20:40:00.000Z","end":"2021-02-18T22:00:00.000Z","duration":null},"app":"000000000000000000000001","author":{"created_by":"5e199e6998cfe1776f1385dc","modified_by":"5e199e6998cfe1776f1385dc"},"created_at":"2021-02-12T07:03:13.503Z","modified_at":"2021-02-12T07:05:57.020Z"}}}},"DeleteAnnouncement":{"value":{"message":"Successfully deleted announcement","data":{"value":{"platforms":["web","android","ios"],"_id":"6026283125f06a827dc1a5cc","title":"test","announcement":"<p>test123</p>\n","pages":[{"page_slug":"$all","type":"custom"}],"editor_meta":{"foreground_color":"#000","background_color":"#fff","content_type":"markdown","content":"test"},"_schedule":{"published":true,"next_schedule":[{"start":"2021-02-10T20:40:00.000Z","end":"2021-02-18T22:00:00.000Z"}],"cron":null,"start":"2021-02-10T20:40:00.000Z","end":"2021-02-18T22:00:00.000Z","duration":null},"app":"000000000000000000000001","author":{"created_by":"5e199e6998cfe1776f1385dc","modified_by":"5e199e6998cfe1776f1385dc"},"created_at":"2021-02-12T07:03:13.503Z","modified_at":"2021-02-12T07:05:57.020Z"}}}},"Seo":{"value":{"seo":{"details":{"title":"Zyosa Zyosa","description":"","image_url":""},"robots_txt":"User-agent: * \nAllow: / \nsancisciasn xwsaixjowqnxwsiwjs","sitemap_enabled":false,"cannonical_enabled":false,"_id":"6009819ee463ad40de397eb2","app":"000000000000000000000001","created_at":"2021-01-21T13:29:02.543Z","updated_at":"2021-02-05T06:36:16.048Z","__v":11,"custom_meta_tags":[{"name":"test 0000","content":"<meta name=\"test\" content=\"0000 cn dcje dcj rejre cjrenurenc \">","_id":"6017c301bde3c21dbb13b284"},{"name":"cwdcdc","content":"<meta content=\"wdcewdewc\">","_id":"6017c675bde3c22cfb13b290"}]}}},"Support":{"value":{"_id":"5ea4980b87a7944094216193","config_type":"app","application":"000000000000000000000001","created_at":"2020-04-25T20:05:31.300Z","updated_at":"2020-12-04T10:48:12.194Z","contact":{"phone":{"active":true,"phone":[{"key":"Jane Doe","code":"91","number":"9988776655"}]},"email":{"active":false,"email":[]}},"created":true}},"PathMapping":{"value":{"_id":"615188e9db1e444cb0f40837","application":"000000000000000000000002","redirect_from":"/from","redirect_to":"/to","createdAt":"2021-09-27T09:03:37.053Z","updatedAt":"2021-09-27T09:09:25.587Z"}},"Legal":{"value":{"tnc":"**Terms and Conditions test**","policy":"**Privacy policy test**","shipping":"**Shipping term and conditions**","returns":"**Terms & conditions for returns **","_id":"5e8b2b96abe7dc94c02c9ac9","application":"000000000000000000000001","faq":[{"question":"New Question","answer":"New Answer"},{"question":"New","answer":"sdfghjhg"},{"question":"test","answer":"test"},{"question":"New Test","answer":"New Test answer"},{"question":"test","answer":"test"}],"created_at":"2020-04-06T13:16:06.818Z","updated_at":"2020-07-16T09:47:40.751Z","__v":260}},"LandingPageResponse":{"value":{"_id":"5eaa451a21a4dd75f0fd96c5","application":"5d3ebd89f540e7506b8b3548","_custom_json":{},"slug":"pnc-landing","action":{"page":{"type":"home"},"popup":{},"type":"page"},"platform":["web"],"created_by":{"id":"000000000000000000000000"},"date_meta":{"created_on":"2020-04-30T03:25:14.549Z","modified_on":"2020-04-30T03:25:14.549Z"},"archived":false}},"LandingPageGetResponse":{"value":{"items":[{"date_meta":{"created_on":"2021-03-12T09:26:12.157Z","modified_on":"2021-03-12T09:26:12.157Z"},"platform":["android"],"_id":"604b342e29f19310d8ae9743","slug":"landing-page-default-2","action":{"page":{"type":"default"},"popup":{},"type":"page"},"application":"5cd3db5e9d692cfe5302a7bb","archived":false,"_custom_json":{},"__v":0}],"page":{"type":"number","current":1,"size":1,"item_total":2,"has_next":true}}},"DefaultNavigationResponse":{"value":{"items":[{"name":"default-bottom","slug":"default-bottom-vIhLiJKQvUZdQvGWzDdrzLP3CTC4Hbxg","orientation":{"landscape":["bottom"]},"version":3,"navigation":[{"display":"Home","image":"https://res.cloudinary.com/dwzm9bysq/image/upload/v1567148153/production/system/icons/mystore-tab_y0dqzt.png","sort_order":1,"acl":["all"],"action":{"page":{"type":"home"},"type":"page"},"active":true},{"display":"Brands","image":"https://res.cloudinary.com/dwzm9bysq/image/upload/v1567148153/production/system/icons/brands-tab_sfinpk.png","sort_order":2,"acl":["all"],"action":{"page":{"type":"brands"},"type":"page"},"active":true},{"display":"Collections","image":"https://res.cloudinary.com/dwzm9bysq/image/upload/v1567148153/production/system/icons/collections-tab_a0tg9c.png","sort_order":3,"acl":["all"],"action":{"page":{"type":"collections"},"type":"page"},"active":true},{"display":"Categories","image":"https://res.cloudinary.com/dwzm9bysq/image/upload/v1567148154/production/system/icons/categories-tab_ss8e0q.png","sort_order":4,"acl":["all"],"action":{"page":{"type":"categories"},"type":"page"},"active":true}],"created_by":{},"_id":"6050244dbd9e072063f1586b","platform":["android"]},{"name":"default-bottom","slug":"default-bottom-SB0zLTfiPN4Z5doJQBKRagsLTDldm8Ug","orientation":{"landscape":["bottom"]},"version":3,"navigation":[{"display":"Home","image":"https://res.cloudinary.com/dwzm9bysq/image/upload/v1567148153/production/system/icons/mystore-tab_y0dqzt.png","sort_order":1,"acl":["all"],"action":{"page":{"type":"home"},"type":"page"},"active":true},{"display":"Brands","image":"https://res.cloudinary.com/dwzm9bysq/image/upload/v1567148153/production/system/icons/brands-tab_sfinpk.png","sort_order":2,"acl":["all"],"action":{"page":{"type":"brands"},"type":"page"},"active":true},{"display":"Collections","image":"https://res.cloudinary.com/dwzm9bysq/image/upload/v1567148153/production/system/icons/collections-tab_a0tg9c.png","sort_order":3,"acl":["all"],"action":{"page":{"type":"collections"},"type":"page"},"active":true},{"display":"Categories","image":"https://res.cloudinary.com/dwzm9bysq/image/upload/v1567148154/production/system/icons/categories-tab_ss8e0q.png","sort_order":4,"acl":["all"],"action":{"page":{"type":"categories"},"type":"page"},"active":true}],"created_by":{},"_id":"6050244dbd9e072063f1586c","platform":["ios"]},{"name":"default-left","slug":"default-left-dWrrfpfcNw6Arl0QtmK5VgunYYAHhGRR","orientation":{"portrait":["left"]},"version":3,"navigation":[{"display":"Profile","image":"https://res.cloudinary.com/dwzm9bysq/image/upload/v1583938091/production/applications/app_000000000000000000000001/media/navigation/icon/hv0cd5jdo0rkhsqoizmi.png","sort_order":1,"type":"","action":{"page":{"url":"/","type":"profile"},"popup":{},"type":"page"},"active":true,"acl":["registered"]},{"display":"Orders","image":"https://res.cloudinary.com/dwzm9bysq/image/upload/v1583938144/production/applications/app_000000000000000000000001/media/navigation/icon/lmv4fzpxxk0a6acitlfg.png","sort_order":2,"type":"","action":{"page":{"url":"/","type":"orders"},"popup":{},"type":"page"},"active":true,"acl":["registered"]},{"display":"Track Order","image":"https://res.cloudinary.com/dwzm9bysq/image/upload/v1583938144/production/applications/app_000000000000000000000001/media/navigation/icon/lmv4fzpxxk0a6acitlfg.png","sort_order":3,"type":"","action":{"page":{"type":"track-order"},"popup":{},"type":"page"},"active":true,"acl":["anonymous"]},{"display":"Addresses","image":"https://res.cloudinary.com/dwzm9bysq/image/upload/v1583938161/production/applications/app_000000000000000000000001/media/navigation/icon/qbod8vkjmot3qnaroibr.png","sort_order":4,"type":"","action":{"page":{"url":"/","type":"addresses"},"popup":{},"type":"page"},"active":true,"acl":["registered"]},{"display":"Wishlist","image":"https://res.cloudinary.com/dwzm9bysq/image/upload/v1583938125/production/applications/app_000000000000000000000001/media/navigation/icon/u8c7jdke4a3wwc0ftz8x.png","sort_order":5,"type":"","action":{"page":{"url":"/wishlist/","type":"wishlist"},"popup":{},"type":"page"},"active":true,"acl":["registered"]},{"display":"Settings","image":"https://res.cloudinary.com/dwzm9bysq/image/upload/v1584003256/production/applications/app_000000000000000000000001/media/navigation/icon/vywbdiio1zi7cbnltvgz.png","sort_order":6,"type":"","action":{"page":{"url":"/","type":"settings"},"popup":{},"type":"page"},"active":true,"acl":["all"]},{"display":"Policy","image":"https://res.cloudinary.com/dwzm9bysq/image/upload/v1583939301/production/applications/app_000000000000000000000001/media/navigation/icon/bygqvme7hkrd45oemzy0.png","sort_order":7,"type":"","action":{"page":{"url":"/","type":"policy"},"popup":{},"type":"page"},"active":true,"acl":["all"]},{"display":"Terms & Conditions","image":"https://res.cloudinary.com/dwzm9bysq/image/upload/v1583939382/production/applications/app_000000000000000000000001/media/navigation/icon/eaq0aagqr0xirojbuki3.png","sort_order":8,"type":"","action":{"page":{"url":"/","type":"tnc"},"popup":{},"type":"page"},"active":true,"acl":["all"]},{"display":"Need Help","image":"https://res.cloudinary.com/dwzm9bysq/image/upload/v1583939416/production/applications/app_000000000000000000000001/media/navigation/icon/xeqv7pzyxagwtxcwvxbw.png","sort_order":9,"type":"","action":{"page":{"url":"/faq/","type":"faq"},"popup":{},"type":"page"},"active":true,"acl":["all"]},{"display":"About Us","image":"https://res.cloudinary.com/dwzm9bysq/image/upload/v1583939196/production/applications/app_000000000000000000000001/media/navigation/icon/dccm5et4sgylisbug9xr.png","sort_order":10,"type":"","action":{"page":{"url":"/","type":"about-us"},"popup":{},"type":"page"},"active":true,"acl":["all"]},{"display":"Rate Us","image":"https://res.cloudinary.com/dwzm9bysq/image/upload/v1584091739/production/applications/app_000000000000000000000001/media/navigation/icon/afryyfeccqgjyeosdmbz.png","sort_order":11,"type":"","action":{"page":{"url":"/","type":"rate-us"},"popup":{},"type":"page"},"active":true,"acl":["registered"]}],"created_by":{},"_id":"6050244dbd9e072063f1586d","platform":["android"]},{"name":"default-left","slug":"default-left-tRK1fsQVUD7BmdvX30Fb4u5ZVSrSi3KW","orientation":{"portrait":["left"]},"version":3,"navigation":[{"display":"Profile","image":"https://res.cloudinary.com/dwzm9bysq/image/upload/v1583938091/production/applications/app_000000000000000000000001/media/navigation/icon/hv0cd5jdo0rkhsqoizmi.png","sort_order":1,"type":"","action":{"page":{"url":"/","type":"profile"},"popup":{},"type":"page"},"active":true,"acl":["registered"]},{"display":"Orders","image":"https://res.cloudinary.com/dwzm9bysq/image/upload/v1583938144/production/applications/app_000000000000000000000001/media/navigation/icon/lmv4fzpxxk0a6acitlfg.png","sort_order":2,"type":"","action":{"page":{"url":"/","type":"orders"},"popup":{},"type":"page"},"active":true,"acl":["registered"]},{"display":"Track Order","image":"https://res.cloudinary.com/dwzm9bysq/image/upload/v1583938144/production/applications/app_000000000000000000000001/media/navigation/icon/lmv4fzpxxk0a6acitlfg.png","sort_order":3,"type":"","action":{"page":{"type":"track-order"},"popup":{},"type":"page"},"active":true,"acl":["anonymous"]},{"display":"Addresses","image":"https://res.cloudinary.com/dwzm9bysq/image/upload/v1583938161/production/applications/app_000000000000000000000001/media/navigation/icon/qbod8vkjmot3qnaroibr.png","sort_order":4,"type":"","action":{"page":{"url":"/","type":"addresses"},"popup":{},"type":"page"},"active":true,"acl":["registered"]},{"display":"Wishlist","image":"https://res.cloudinary.com/dwzm9bysq/image/upload/v1583938125/production/applications/app_000000000000000000000001/media/navigation/icon/u8c7jdke4a3wwc0ftz8x.png","sort_order":5,"type":"","action":{"page":{"url":"/wishlist/","type":"wishlist"},"popup":{},"type":"page"},"active":true,"acl":["registered"]},{"display":"Settings","image":"https://res.cloudinary.com/dwzm9bysq/image/upload/v1584003256/production/applications/app_000000000000000000000001/media/navigation/icon/vywbdiio1zi7cbnltvgz.png","sort_order":6,"type":"","action":{"page":{"url":"/","type":"settings"},"popup":{},"type":"page"},"active":true,"acl":["all"]},{"display":"Policy","image":"https://res.cloudinary.com/dwzm9bysq/image/upload/v1583939301/production/applications/app_000000000000000000000001/media/navigation/icon/bygqvme7hkrd45oemzy0.png","sort_order":7,"type":"","action":{"page":{"url":"/","type":"policy"},"popup":{},"type":"page"},"active":true,"acl":["all"]},{"display":"Terms & Conditions","image":"https://res.cloudinary.com/dwzm9bysq/image/upload/v1583939382/production/applications/app_000000000000000000000001/media/navigation/icon/eaq0aagqr0xirojbuki3.png","sort_order":8,"type":"","action":{"page":{"url":"/","type":"tnc"},"popup":{},"type":"page"},"active":true,"acl":["all"]},{"display":"Need Help","image":"https://res.cloudinary.com/dwzm9bysq/image/upload/v1583939416/production/applications/app_000000000000000000000001/media/navigation/icon/xeqv7pzyxagwtxcwvxbw.png","sort_order":9,"type":"","action":{"page":{"url":"/faq/","type":"faq"},"popup":{},"type":"page"},"active":true,"acl":["all"]},{"display":"About Us","image":"https://res.cloudinary.com/dwzm9bysq/image/upload/v1583939196/production/applications/app_000000000000000000000001/media/navigation/icon/dccm5et4sgylisbug9xr.png","sort_order":10,"type":"","action":{"page":{"url":"/","type":"about-us"},"popup":{},"type":"page"},"active":true,"acl":["all"]},{"display":"Rate Us","image":"https://res.cloudinary.com/dwzm9bysq/image/upload/v1584091739/production/applications/app_000000000000000000000001/media/navigation/icon/afryyfeccqgjyeosdmbz.png","sort_order":11,"type":"","action":{"page":{"url":"/","type":"rate-us"},"popup":{},"type":"page"},"active":true,"acl":["registered"]}],"created_by":{},"_id":"6050244dbd9e072063f1586e","platform":["ios"]},{"name":"default-top","slug":"default-top-qrprb8dxqr3m698wwUGXWsvTfVkjt4cR","orientation":{"landscape":["top"]},"version":3,"navigation":[{"display":"Home","image":"https://res.cloudinary.com/dwzm9bysq/image/upload/v1567148153/production/system/icons/mystore-tab_y0dqzt.png","sort_order":1,"acl":["all"],"action":{"page":{"type":"home"},"type":"page"},"active":true},{"display":"Brands","image":"https://res.cloudinary.com/dwzm9bysq/image/upload/v1567148153/production/system/icons/brands-tab_sfinpk.png","sort_order":2,"acl":["all"],"action":{"page":{"type":"brands"},"type":"page"},"active":true},{"display":"Collections","image":"https://res.cloudinary.com/dwzm9bysq/image/upload/v1567148153/production/system/icons/collections-tab_a0tg9c.png","sort_order":3,"acl":["all"],"action":{"page":{"type":"collections"},"type":"page"},"active":true},{"display":"Categories","image":"https://res.cloudinary.com/dwzm9bysq/image/upload/v1567148154/production/system/icons/categories-tab_ss8e0q.png","sort_order":4,"acl":["all"],"action":{"page":{"type":"categories"},"type":"page"},"active":true}],"created_by":{},"_id":"6050244dbd9e072063f1586f","platform":["web"]}]}},"NavigationRequest":{"value":{"name":"test-nav","slug":"test-nav","platform":["ios","android"],"orientation":{"portrait":["left"]},"navigation":[{"display":"iiHome","image":"https://res.cloudinary.com/dwzm9bysq/image/upload/v1587918110/jiox0/applications/app_5ea1ad3720a2a9b35fa7aae5/media/navigation/icon/bxb8xsrrgu1pygiz5eq3.png","sort_order":1,"type":"","action":{"page":{"url":"/","type":"home"},"popup":{},"type":"page"},"active":true,"acl":["all"],"_locale_language":{"hi":{"display":"घर"},"en_us":{"display":"Home"}},"sub_navigation":[{"display":"iiSubHome","image":"https://res.cloudinary.com/dwzm9bysq/image/upload/v1587918110/jiox0/applications/app_5ea1ad3720a2a9b35fa7aae5/media/navigation/icon/bxb8xsrrgu1pygiz5eq3.png","sort_order":1,"type":"","action":{"page":{"url":"/","type":"home"},"popup":{},"type":"page"},"active":true,"acl":["all"],"_locale_language":{"hi":{"display":"विषय घर"},"en_us":{"display":"SubHome"}}}]},{"display":"Cart","image":"https://res.cloudinary.com/dwzm9bysq/image/upload/v1587915357/jiox0/applications/app_5ea1ad3720a2a9b35fa7aae5/media/navigation/icon/qb0eymobp7sznldecwci.png","sort_order":2,"type":"","action":{"page":{"url":"/cart/bag/","type":"cart"},"popup":{},"type":"page"},"active":true,"acl":["all"]},{"display":"My Orders","image":"https://res.cloudinary.com/dwzm9bysq/image/upload/v1587915397/jiox0/applications/app_5ea1ad3720a2a9b35fa7aae5/media/navigation/icon/ql6urfgroddqwufoezi0.png","sort_order":3,"type":"","action":{"page":{"url":"/profile/orders","type":"orders"},"popup":{},"type":"page"},"active":true,"acl":["all"]},{"display":"Wishlist","image":"https://res.cloudinary.com/dwzm9bysq/image/upload/v1587915413/jiox0/applications/app_5ea1ad3720a2a9b35fa7aae5/media/navigation/icon/xdon2o9xgtj0moh5nh9w.png","sort_order":4,"type":"","action":{"page":{"url":"/wishlist/","type":"wishlist"},"popup":{},"type":"page"},"active":true,"acl":["all"]}]}},"NavigationResponse":{"value":{"_id":"5ffbd9b90ac98678ae0458d7","application":"000000000000000000000001","_custom_json":null,"name":"test-nav","slug":"test-nav","platform":["ios","android"],"orientation":{"portrait":["left"]},"navigation":[{"display":"Home","image":"https://res.cloudinary.com/dwzm9bysq/image/upload/v1567148153/production/system/icons/mystore-tab_y0dqzt.png","sort_order":1,"type":"","action":{"page":{"url":"/","type":"home"},"popup":{},"type":"page"},"active":true,"tags":{"type":"array","items":{"type":"string"}},"acl":["all"],"_locale_language":{"hi":{"display":""},"ar":{"display":""},"en_us":{"display":""}},"sub_navigation":[{"display":"Brands","image":"https://res.cloudinary.com/dwzm9bysq/image/upload/v1567148153/production/system/icons/brands-tab_sfinpk.png","sort_order":1,"type":"","action":{"page":{"url":"/brands/","type":"brands"},"popup":{},"type":"page"},"active":true,"tags":null,"acl":["all"],"_locale_language":{"hi":{"display":""},"ar":{"display":""},"en_us":{"display":""}}}]},{"display":"Collections","image":"https://res.cloudinary.com/dwzm9bysq/image/upload/v1567148153/production/system/icons/collections-tab_a0tg9c.png","sort_order":2,"type":"","action":{"page":{"url":"/collections/","type":"collections"},"popup":{},"type":"page"},"active":true,"tags":null,"acl":["all"],"_locale_language":{"hi":{"display":""},"ar":{"display":""},"en_us":{"display":""}},"sub_navigation":[{"display":"Categories","image":"https://res.cloudinary.com/dwzm9bysq/image/upload/v1567148154/production/system/icons/categories-tab_ss8e0q.png","sort_order":1,"type":"","action":{"page":{"url":"/categories/","type":"categories"},"popup":{},"type":"page"},"active":true,"tags":null,"acl":["all"],"_locale_language":{"hi":{"display":""},"ar":{"display":""},"en_us":{"display":""}}}]},{"display":"Primary Menu","image":"","sort_order":3,"type":"","action":{"page":{"type":"home"},"popup":{},"type":"page"},"active":true,"tags":null,"acl":["all"],"_locale_language":{"hi":{"display":""},"ar":{"display":""},"en_us":{"display":""}}}],"created_by":{"id":"000000000000000000000000"},"date_meta":{"created_on":"2021-01-11T04:53:13.585Z","modified_on":"2021-01-14T10:24:34.485Z"},"archived":false}},"NavigationGetResponse":{"value":{"items":[{"_id":"5ffbd9b90ac98678ae0458d7","application":"000000000000000000000001","_custom_json":null,"name":"temp","slug":"temp","platform":"web","position":"top","orientation":"landscape","navigation":[{"display":"Home","image":"https://res.cloudinary.com/dwzm9bysq/image/upload/v1567148153/production/system/icons/mystore-tab_y0dqzt.png","sort_order":1,"type":"","action":{"page":{"url":"/","type":"home"},"popup":{},"type":"page"},"active":true,"tags":{"type":"array","items":{"type":"string"}},"acl":["all"],"_locale_language":{"hi":{"display":""},"ar":{"display":""},"en_us":{"display":""}},"sub_navigation":[{"display":"Brands","image":"https://res.cloudinary.com/dwzm9bysq/image/upload/v1567148153/production/system/icons/brands-tab_sfinpk.png","sort_order":1,"type":"","action":{"page":{"url":"/brands/","type":"brands"},"popup":{},"type":"page"},"active":true,"tags":null,"acl":["all"],"_locale_language":{"hi":{"display":""},"ar":{"display":""},"en_us":{"display":""}}}]},{"display":"Collections","image":"https://res.cloudinary.com/dwzm9bysq/image/upload/v1567148153/production/system/icons/collections-tab_a0tg9c.png","sort_order":2,"type":"","action":{"page":{"url":"/collections/","type":"collections"},"popup":{},"type":"page"},"active":true,"tags":null,"acl":["all"],"_locale_language":{"hi":{"display":""},"ar":{"display":""},"en_us":{"display":""}},"sub_navigation":[{"display":"Categories","image":"https://res.cloudinary.com/dwzm9bysq/image/upload/v1567148154/production/system/icons/categories-tab_ss8e0q.png","sort_order":1,"type":"","action":{"page":{"url":"/categories/","type":"categories"},"popup":{},"type":"page"},"active":true,"tags":null,"acl":["all"],"_locale_language":{"hi":{"display":""},"ar":{"display":""},"en_us":{"display":""}}}]},{"display":"Primary Menu","image":"","sort_order":3,"type":"","action":{"page":{"type":"home"},"popup":{},"type":"page"},"active":true,"tags":null,"acl":["all"],"_locale_language":{"hi":{"display":""},"ar":{"display":""},"en_us":{"display":""}}}],"created_by":{"id":"000000000000000000000000"},"date_meta":{"created_on":"2021-01-11T04:53:13.585Z","modified_on":"2021-01-14T10:24:34.485Z"}}],"page":{"type":"number","current":1,"size":1,"item_total":2,"has_next":true}}},"PageRequest":{"value":{"title":"my first page","slug":"1st_page","feature_image":{"secure_url":"https://google.com/some-image"},"reading_time":"5 minutes","content":[{"type":"html","value":"<div id=\"icfm\">Emtpy Page. Create Page here.</div><div id=\"izu5\" class=\"aa\">hello there!<div id=\"izzl\">how are you doing</div><div><br/></div></div><img id=\"ibgj\" src=\"https://hdn-1.addsale.com/x0/company/52/applications/614957b7e7a0ccc371e96094/pages/pictures/free-content/original/-zLi_CuyM-apple.jpeg\"/>"},{"type":"css","value":"* { box-sizing: border-box; } body {margin: 0;}*{box-sizing:border-box;}body{margin-top:0px;margin-right:0px;margin-bottom:0px;margin-left:0px;}*{box-sizing:border-box;}body{margin-top:0px;margin-right:0px;margin-bottom:0px;margin-left:0px;}#icfm{text-align:center;padding-top:30px;padding-right:30px;padding-bottom:30px;padding-left:30px;}#izu5{padding-top:10px;padding-right:10px;padding-bottom:10px;padding-left:10px;}#ibgj{color:black;}#izzl{float:none;display:flex;}.aa{float:right;}"},{"type":"js","value":""}],"published":true,"platform":"web","description":"hey this is my first page","visibility":{"test":true},"author":{"name":"Abhinav Maurya"},"tags":["my first page"],"seo":{"title":"my first page","description":"hey this is my first page","image":{"url":""}},"_schedule":{"cron":"50 10 * * *","start":"2021-04-23T23:50:00.000Z","end":"2021-04-30T00:55:00.000Z","duration":10},"type":"rawhtml"}},"PagePublishRequest":{"value":{"publish":true}},"4XXAPIError":{"value":{"message":"Oops! Something went wrong. Please try later","status":400,"code":"CX-1003","exception":"","info":"","request_id":"","stack_trace":"","meta":{}}},"5XXAPIError":{"value":{"message":"Oops! Something went wrong. Please try later","status":500,"code":"CX-1004","exception":"","info":"","request_id":"","stack_trace":"","meta":{}}},"PageResponse":{"value":{"date_meta":{"created_on":"2021-03-16T08:24:19.197Z","modified_on":"2021-03-16T08:24:19.197Z"},"tags":["my first page"],"published":true,"component_ids":[],"archived":false,"_id":"60506dcad18cb33946026862","title":"my first page","slug":"1st_page","feature_image":{"secure_url":"https://google.com/some-image"},"content":[{"type":"html","value":"<div id=\"icfm\">Emtpy Page. Create Page here.</div><div id=\"izu5\" class=\"aa\">hello there!<div id=\"izzl\">how are you doing</div><div><br/></div></div><img id=\"ibgj\" src=\"https://hdn-1.addsale.com/x0/company/52/applications/614957b7e7a0ccc371e96094/pages/pictures/free-content/original/-zLi_CuyM-apple.jpeg\"/>"},{"type":"css","value":"* { box-sizing: border-box; } body {margin: 0;}*{box-sizing:border-box;}body{margin-top:0px;margin-right:0px;margin-bottom:0px;margin-left:0px;}*{box-sizing:border-box;}body{margin-top:0px;margin-right:0px;margin-bottom:0px;margin-left:0px;}#icfm{text-align:center;padding-top:30px;padding-right:30px;padding-bottom:30px;padding-left:30px;}#izu5{padding-top:10px;padding-right:10px;padding-bottom:10px;padding-left:10px;}#ibgj{color:black;}#izzl{float:none;display:flex;}.aa{float:right;}"},{"type":"js","value":""}],"content_path":"https://hdn-1.fynd.com/company/1526/applications/61012f6a9250ccd1b9ef8a1d/pages/content/page_slug.html","platform":"web","description":"hey this is my first page","visibility":{"test":true},"_schedule":{"start":"2021-04-23T23:50:00.000Z","next_schedule":[{}]},"seo":{"title":"my first page","description":"hey this is my first page","image":{"url":""}},"type":"rawhtml","application":"000000000000000000000001","orientation":"portrait","page_meta":[]}},"PageGetResponse":{"value":{"items":[{"date_meta":{"created_on":"2021-03-14T06:49:03.945Z","modified_on":"2021-03-14T06:49:03.945Z"},"tags":["my first page"],"_id":"604db275b3ae202873964d94","content_path":"https://hdn-1.fynd.com/company/1526/applications/61012f6a9250ccd1b9ef8a1d/pages/content/page_slug.html","title":"test-page","slug":"test-page","published":true,"_schedule":{"next_schedule":[{}],"start":"2021-04-08T07:15:13.000Z","end":"2021-04-10T02:00:00.000Z"},"feature_image":{"secure_url":"https://google.com/some-image"},"seo":{"title":"my first page","description":"hey this is my first page","image":{"url":""}},"application":"000000000000000000000001","author":{"name":"Abhinav Maurya"}}],"page":{"type":"number","current":1,"size":1,"item_total":2,"has_next":true}}},"PageMeta":{"value":{"application_id":"000000000000000000000001","system_pages":[{"display":"Home","action":{"page":{"type":"home"},"type":"page"},"page_type":"home"},{"display":"Brands","action":{"page":{"type":"brands"},"type":"page"},"page_type":"brands"},{"display":"Collections","action":{"page":{"type":"collections"},"type":"page"},"page_type":"collections"},{"display":"Categories","action":{"page":{"type":"categories"},"type":"page"},"page_type":"categories"}],"custom_pages":[{"display":"my first page","slug":"first_page"},{"display":"my second page","slug":"second_page"}]}},"SlideshowRequest":{"value":{"configuration":{"duration":10,"sleep_time":20,"slide_direction":"horizontal"},"slug":"ss-sfsf","platform":"web","media":{"image":{"url":"https://res.cloudinary.com/dwzm9bysq/image/upload/v1567148153/production/system/icons/brands-tab_sfinpk.png","bg_color":"#ffffff","duration":10,"action":{"type":""}},"youtube":{"url1":"https://www.youtube.com/watch?v=Z1VhG7cf83M","url2":"https://www.youtube.com/watch?v=1rxDzs0zgcE&t=1942s&ab_channel=CodingTech","url":"https://www.youtube.com/embed/1rxDzs0zgcE","bg_color":"#ffffff","auto_decide_duration":true,"duration":10,"action":{"type":""}}},"active":true}},"SlideshowResponse":{"value":{"date_meta":{"created_on":"2021-03-14T05:27:12.319Z","modified_on":"2021-03-14T05:27:12.319Z"},"archived":false,"_id":"604d9eb975e9d136bb1b8b83","configuration":{"start_on_launch":false,"duration":50,"sleep_time":100,"slide_direction":"horizontal"},"slug":"ss-sfsd-updated","platform":"ios","media":[{"auto_decide_duration":false,"type":"image","url":"https://res.cloudinary.com/dwzm9bysq/image/upload/v1567148153/production/system/icons/brands-tab_sfinpk.png","bg_color":"#ffffff","duration":10,"action":{"type":""}},{"auto_decide_duration":true,"type":"youtube","url":"https://www.youtube.com/embed/9vJRopau0g0","bg_color":"#ffffff","duration":909,"action":{"type":""}}],"application":"5cd3db5e9d692cfe5302a7bb","active":true}},"SlideshowGetResponse":{"value":{"items":[{"date_meta":{"created_on":"2021-03-14T05:27:12.319Z","modified_on":"2021-03-14T05:27:12.319Z"},"archived":false,"_id":"604d9eb975e9d136bb1b8b83","configuration":{"start_on_launch":false,"duration":50,"sleep_time":100,"slide_direction":"horizontal"},"slug":"ss-sfsd-updated","platform":"ios","media":[{"auto_decide_duration":false,"type":"image","url":"https://res.cloudinary.com/dwzm9bysq/image/upload/v1567148153/production/system/icons/brands-tab_sfinpk.png","bg_color":"#ffffff","duration":10,"action":{"type":""}},{"auto_decide_duration":true,"type":"youtube","url":"https://www.youtube.com/embed/9vJRopau0g0","bg_color":"#ffffff","duration":909,"action":{"type":""}}],"application":"5cd3db5e9d692cfe5302a7bb","active":true,"__v":0}],"page":{"type":"number","current":1,"size":1,"item_total":2,"has_next":true}}},"ResourceResponse":{"value":{"resources":[{"name":"product","key":"product","definitions_count":0},{"name":"Collection","key":"collection","definitions_count":0},{"name":"Page","key":"page","definitions_count":0},{"name":"Blog","key":"blog","definitions_count":0},{"name":"Customer","key":"customer","definitions_count":0},{"name":"Store","key":"store","definitions_count":0}]}},"CustomFieldTypesResponse":{"value":{"metafield_types":{"boolean_type":{"name":"Boolean","category":"TRUE_FALSE","list_enabled":false,"supported_validations":[],"type":"boolean"},"date":{"name":"Date","category":"DATETIME","list_enabled":true,"supported_validations":[{"name":"min","display":"Minimum Date","type":"date"},{"name":"max","display":"Maximum Date","type":"date"}],"type":"date"},"datetime":{"name":"Datetime","category":"DATETIME","list_enabled":true,"supported_validations":[{"name":"min","display":"Minimum Date","type":"date"},{"name":"max","display":"Maximum Date","type":"date"}],"type":"datetime"},"dropdown":{"name":"Dropdown","category":"TEXT","list_enabled":true,"supported_validations":[{"name":"choices","display":"Choices","type":"string_array","required":true}],"type":"string"},"file":{"name":"File","category":"REFERENCE","list_enabled":true,"supported_validations":[{"name":"file_type_options","type":"string_array"}],"type":"string"},"float_type":{"name":"Decimal","category":"NUMBER","list_enabled":true,"supported_validations":[{"name":"min","display":"Minimum Value","type":"float"},{"name":"max","display":"Maximum Value","type":"float"},{"name":"choices","display":"Choices","type":"float_array"}],"type":"float"},"integer":{"name":"Integer","category":"NUMBER","list_enabled":true,"supported_validations":[{"name":"min","display":"Minimum Value","type":"integer"},{"name":"max","display":"Maximum Value","type":"integer"},{"name":"choices","display":"Choices","type":"integer_array"}],"type":"integer"},"json":{"name":"JSON","category":"ADVANCED","list_enabled":false,"supported_validations":[{"name":"schema","display":"JSON Schema","type":"json"}],"type":"json"},"metaobject":{"name":"Custom Object","category":"REFERENCE","list_enabled":true,"supported_validations":[{"name":"metaobject_definition_id","display":"Reference","type":"string","required":true}],"type":"string"},"product":{"name":"Product","category":"REFERENCE","list_enabled":true,"supported_validations":[],"type":"string"},"string_multi_line":{"name":"Multi Line Text","category":"TEXT","list_enabled":true,"supported_validations":[{"name":"min","display":"Minimum Characters","type":"integer"},{"name":"max","display":"Maximum Characters","type":"integer"}],"type":"string"},"string_single_line":{"name":"Single Line Text","category":"TEXT","list_enabled":true,"supported_validations":[{"name":"min","display":"Minimum Characters","type":"integer"},{"name":"max","display":"Maximum Characters","type":"integer"},{"name":"regex","display":"Regular Expression","type":"string"}],"type":"string"},"url":{"name":"URL","list_enabled":true,"supported_validations":[{"name":"allowed_domains","display":"Allowed Domains","type":"string_array"}],"type":"string"}}}},"CustomFieldDefinitionsResponse":{"value":{"items":[{"_id":"652e183347320aa8d8c28361","creator":"company","resource":"product","name":"new meta object","namespace":"custom","key":"new-meta-object","description":"","type":"metaobject","multi_value":false,"validations":[{"name":"metaobject_definition_id","type":"string","value":"652e1298b6ece12d06684c18"}],"company_id":"2","created_by":"5e5796c4fc10a0d133839372","updated_by":"5e5796c4fc10a0d133839372","required":false,"is_deleted":false,"created_at":"2023-10-17T05:14:27.960Z","updated_at":"2023-10-17T05:14:27.960Z","type_name":"Custom Object","invalid_fields_count":0},{"_id":"652826cd99822ff1f62cbf13","creator":"company","resource":"product","name":"single image","namespace":"custom","key":"single-image","description":"this is single","type":"file","multi_value":false,"validations":[{"name":"file_type_options","type":"string_array","value":["image","audio","video","document","pdf"]}],"company_id":"2","created_by":"5e5796c4fc10a0d133839372","updated_by":"5e5796c4fc10a0d133839372","required":false,"is_deleted":false,"created_at":"2023-10-12T17:03:09.868Z","updated_at":"2023-10-12T17:03:09.868Z","type_name":"File","invalid_fields_count":0}],"page":{"type":"number","current":1,"size":10,"item_total":15,"has_next":true}}},"CustomFieldCreationSuccessExample1":{"value":{"resource":"product","type":"string_single_line","key":"fname","namespace":"fname","multi_value":false,"name":"name","description":"First name"}},"CustomFieldCreationSuccessExample2":{"value":{"resource":"product","type":"boolean","key":"isActive","namespace":"isactive","multi_value":false,"name":"isActive","description":"Is Active"}},"CustomFieldCreationsFailureExample":{"value":{"resource":"product","type":"string_single_line","namespace":"custom","description":"product sub head","name":"subheadingp","multi_value":true,"key":"subheading","validations":[{"name":"min","type":"integer","display":"Minimum Characters","value":10,"errorText":""},{"name":"max","type":"integer","display":"Maximum Characters","value":40,"errorText":""},{"name":"regex","type":"string","display":"Regular Expression","meta":{"examples":[{"name":"Alphabet Characters","value":"^[a-zA-Z]+$"},{"name":"Alphanumeric Characters","value":"^[a-zA-Z0-9]+$"},{"name":"Numeric Characters","value":"^[0-9]+$"},{"name":"Email Address","value":"^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$"}]},"value":"^[a-zA-Z]+$","errorText":""}]}},"CustomFieldDefinitionDetailResponse":{"value":{"creator":"application","resource":"product","name":"name","namespace":"fname","key":"fname","description":"First name","type":"string_single_line","multi_value":false,"company_id":"1","application_id":"000000000000000000000001","created_by":"000000000000000000000001","updated_by":"000000000000000000000001","required":false,"is_deleted":false,"_id":"65369654d436ae0e54147e7b","validations":[],"created_at":"2023-10-23T15:50:44.143Z","updated_at":"2023-10-23T15:50:44.143Z"}},"CustomFieldDefinitionDuplicateFieldError":{"value":{"status":400,"message":"Sorry, field(s) should be unique","code":"CX-2004","exception":"","request_id":"","info":"E11000 duplicate key error collection: meta.metafield_definitions index: namespace_1_key_1_resource_1_company_id_1_application_id_1 dup key: { namespace: 'custom', key: 'test', resource: 'product', company_id: '14610', application_id: null }","stack_trace":"","meta":{}}},"CustomFieldDefinitionValidationErrorExample":{"value":{"status":400,"message":"Validation error","code":"CX-2","exception":"","request_id":"","info":{"name":{"name":"ValidatorError","message":"Path `name` is required.","properties":{"message":"Path `name` is required.","type":"required","path":"name","value":""},"kind":"required","path":"name","value":""}},"stack_trace":"","meta":{}}},"CustomDataDeleteResponse":{"value":{"success":true,"message":"Metafield definition deleted successfully"}},"CustomFieldsResponse":{"value":{"items":[{"_id":"652f8c5b6c1643cbd1659d88","namespace":"product_test_2","key":"manufacturer","resource":"product","creator":"company","value":["https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/misc/general/free/original/NWt9CSoYbo-airtel_money.png","https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/misc/general/free/original/QqkJBM4IQL-amazon-pay.png","https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/misc/general/free/original/2Ed7Pk03Z-amex.png"],"resource_id":"64bb987e9a3c4b6c29d676bc","type":"file","multi_value":true,"company_id":"1","definition_id":"650c4ea3e0e7980d14c16c06","has_invalid_values":false,"invalid_value_errors":[],"created_by":"000000000000000000000001","is_deleted":false,"created_at":"2023-10-18T07:42:19.551Z","updated_at":"2023-10-18T07:42:19.551Z"},{"_id":"652f8b4628dd2571fe5e90d8","namespace":"product_test_1","key":"manufacturer","resource":"product","creator":"company","value":["this","is","testing"],"resource_id":"64ba480fdf9cbe3a90b052f4","type":"string_single_line","multi_value":true,"company_id":"1","definition_id":"650ae0d67f9c7b2a7d56b409","has_invalid_values":false,"invalid_value_errors":[],"created_by":"000000000000000000000001","is_deleted":false,"created_at":"2023-10-18T07:37:42.797Z","updated_at":"2023-10-18T07:37:42.797Z"},{"_id":"652f8b4628dd2571fe5e90d7","namespace":"product_test","key":"manufacturer","resource":"product","creator":"company","value":["kuldeep","kumar","harshwal"],"resource_id":"64ba32fbdf9cbe3a90b052f0","type":"string_single_line","multi_value":true,"company_id":"1","definition_id":"650ae0b27f9c7b2a7d56b407","has_invalid_values":false,"invalid_value_errors":[],"created_by":"000000000000000000000001","is_deleted":false,"created_at":"2023-10-18T07:37:42.796Z","updated_at":"2023-10-18T07:37:42.796Z"}],"page":{"type":"number","current":1,"size":20,"item_total":3,"has_next":false}}},"CustomFieldsResponseByResourceId":{"value":{"items":[{"_id":"652f8c5b6c1643cbd1659d88","namespace":"product_test_2","key":"manufacturer","resource":"product","creator":"company","value":["https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/misc/general/free/original/NWt9CSoYbo-airtel_money.png","https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/misc/general/free/original/QqkJBM4IQL-amazon-pay.png","https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/misc/general/free/original/2Ed7Pk03Z-amex.png"],"resource_id":"64bb987e9a3c4b6c29d676bc","type":"file","multi_value":true,"company_id":"1","definition_id":"650c4ea3e0e7980d14c16c06","has_invalid_values":false,"invalid_value_errors":[],"created_by":"000000000000000000000001","is_deleted":false,"created_at":"2023-10-18T07:42:19.551Z","updated_at":"2023-10-18T07:42:19.551Z"}]}},"CustomFieldSuccessExample1":{"value":{"fields":[{"value":["https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/misc/general/free/original/NWt9CSoYbo-airtel_money_test.png"],"definition_id":"650c4ea3e0e7980d14c16c06"}]}},"CustomFieldSuccessExample2":{"value":{"fields":[{"value":["testing"],"definition_id":"650c4ea3e0e7980d14c16c06"}]}},"CustomFieldFailureExample":{"value":{"fields":[{"value":["test failed"],"definition_id":"650c4ea3e0e7980d14c16c06"}]}},"CustomObject":{"value":{"_id":"65392bd912376081aafa90ff","creator":"application","company_id":"1","application_id":"000000000000000000000001","created_by":"000000000000000000000001","updated_by":"000000000000000000000001","status":"active","type":"painter","display_name":"painter #65392bd912376081aafa90ff","definition_id":"653907ced878d53c1a502d92","fields":[{"_id":"65392bd912376081aafa9103","namespace":"painter","key":"name","resource":"metaobject","resource_id":"65392bd912376081aafa90ff","type":"string_single_line","multi_value":false,"company_id":"1","application_id":"000000000000000000000001","creator":"application","invalid_value_errors":[],"has_invalid_values":false,"metaobject_definition_id":"653907ced878d53c1a502d92","definition_id":"653907ced878d53c1a502d95","value":["Batman"],"created_by":"000000000000000000000001"},{"_id":"65392bd912376081aafa9104","namespace":"painter","key":"age","resource":"metaobject","resource_id":"65392bd912376081aafa90ff","type":"integer","multi_value":false,"company_id":"1","application_id":"000000000000000000000001","creator":"application","invalid_value_errors":[],"has_invalid_values":false,"metaobject_definition_id":"653907ced878d53c1a502d92","definition_id":"653907ced878d53c1a502d96","value":[50],"created_by":"000000000000000000000001"}]}},"CustomObjectByIdRes":{"value":{"_id":"653929f012376081aafa90f1","status":"active","display_name":"painter #653929f012376081aafa90f1","definition":{"_id":"653907ced878d53c1a502d92","name":"painter","type":"painter"},"references":[],"fields":[{"_id":"653929f012376081aafa90f5","key":"name","value":["Bruce Wayne"],"type":"string_single_line","definition_id":"653907ced878d53c1a502d95"},{"_id":"653929f012376081aafa90f6","key":"age","value":[5],"type":"integer","definition_id":"653907ced878d53c1a502d96"}]}},"CustomObjects":{"value":{"items":[{"_id":"653929f012376081aafa90f1","definition_id":"653907ced878d53c1a502d92","status":"active","updated_at":"2023-10-25T14:45:04.446Z","display_name":"painter #653929f012376081aafa90f1","definition":{"_id":"653907ced878d53c1a502d92","name":"painter","type":"painter"},"references":0}],"page":{"type":"number","current":1,"size":10,"item_total":1,"has_next":false}}},"CustomObjectSuccessExample1":{"value":{"status":"active","definition_id":"653907ced878d53c1a502d92","fields":[{"definition_id":"653907ced878d53c1a502d95","value":["Batman"]},{"definition_id":"653907ced878d53c1a502d96","value":[50]}]}},"CustomObjectSuccessExample2":{"value":{"status":"active","definition_id":"653907ced878d53c1a502d92","fields":[{"definition_id":"653907ced878d53c1a50er432","value":["Bruce wyan"]},{"definition_id":"653907ced878d53c1a502d96","value":[5]}]}},"CustomObjectFailureExample":{"value":{"status":"active","definition_id":"653907ced878d53c1a502d92","fields":[{"definition_id":"653907ced878","value":["Batman"]},{"definition_id":"653907ced8","value":[50]}]}},"CustomObjectDefinitionSuccessExample":{"value":{"type":"customobject1","description":"","name":"customObject1","field_definitions":[{"type":"string_single_line","description":"","name":"coCustomField1","multi_value":false,"required":false,"key":"cocustomfield1","validations":[{"name":"min","type":"integer","display":"Minimum Characters","value":2,"errorText":""},{"name":"max","type":"integer","display":"Maximum Characters","value":10,"errorText":""},{"name":"regex","type":"string","display":"Regular Expression","meta":{"examples":[{"name":"Alphabet Characters","value":"^[a-zA-Z]+$"},{"name":"Alphanumeric Characters","value":"^[a-zA-Z0-9]+$"},{"name":"Numeric Characters","value":"^[0-9]+$"},{"name":"Email Address","value":"^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\\\.[a-zA-Z]{2,}$"}]},"value":"^[a-zA-Z]+$","errorText":""}],"action":"create","tempId":1701688581381},{"type":"string_single_line","description":"this is custom field 2 of custom object","name":"coCustomField2","multi_value":false,"required":false,"key":"cocustomfield2","validations":[{"name":"min","type":"integer","display":"Minimum Characters","value":1,"errorText":""},{"name":"max","type":"integer","display":"Maximum Characters","value":100,"errorText":""}],"action":"create","tempId":1701688609037}],"display_name_key":"cocustomfield2"}},"CustomObjectDefintionFailureExample":{"value":{"type":"customobject1","description":"","name":"customObject1","field_definitions":[{"type":"string_single_line","description":"","name":"coCustomField1","multi_value":false,"required":false,"key":"cocustomfield1","validations":[{"name":"min","type":"integer","display":"Minimum Characters","value":2,"errorText":""},{"name":"max","type":"integer","display":"Maximum Characters","value":10,"errorText":""},{"name":"regex","type":"string","display":"Regular Expression","meta":{"examples":[{"name":"Alphabet Characters","value":"^[a-zA-Z]+$"},{"name":"Alphanumeric Characters","value":"^[a-zA-Z0-9]+$"},{"name":"Numeric Characters","value":"^[0-9]+$"},{"name":"Email Address","value":"^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\\\.[a-zA-Z]{2,}$"}]},"value":"^[a-zA-Z]+$","errorText":""}],"action":"create","tempId":1701688581381},{"type":"string_single_line","description":"this is custom field 2 of custom object","name":"coCustomField2","multi_value":false,"required":false,"key":"cocustomfield2","validations":[{"name":"min","type":"integer","display":"Minimum Characters","value":1,"errorText":""},{"name":"max","type":"integer","display":"Maximum Characters","value":100,"errorText":""}],"action":"create","tempId":1701688609037}],"display_name_key":"cocustomfield2"}},"CustomObjectDefintionFailureExample2":{"value":{"type":"customobject1","description":"","name":"","field_definitions":[{"type":"string_single_line","description":"","name":"coCustomField1","multi_value":false,"required":false,"key":"cocustomfield1","validations":[{"name":"min","type":"integer","display":"Minimum Characters","value":2,"errorText":""},{"name":"max","type":"integer","display":"Maximum Characters","value":10,"errorText":""},{"name":"regex","type":"string","display":"Regular Expression","meta":{"examples":[{"name":"Alphabet Characters","value":"^[a-zA-Z]+$"},{"name":"Alphanumeric Characters","value":"^[a-zA-Z0-9]+$"},{"name":"Numeric Characters","value":"^[0-9]+$"},{"name":"Email Address","value":"^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\\\.[a-zA-Z]{2,}$"}]},"value":"^[a-zA-Z]+$","errorText":""}],"action":"create","tempId":1701688581381},{"type":"string_single_line","description":"this is custom field 2 of custom object","name":"coCustomField2","multi_value":false,"required":false,"key":"cocustomfield2","validations":[{"name":"min","type":"integer","display":"Minimum Characters","value":1,"errorText":""},{"name":"max","type":"integer","display":"Maximum Characters","value":100,"errorText":""}],"action":"create","tempId":1701688609037}],"display_name_key":"cocustomfield2"}},"CustomObjectDefinitionDeleteResponse":{"value":{"success":true,"message":"MetaObjectDefinition deleted successfully"}},"CustomObjectBulkUploadExample":{"value":{"url":"https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/company/default/applications/default/meta-field/assets/original/qABURepOA-sample-(6)-(1).csv","total_records":2}},"CustomObjectBulkUploadFailureExample":{"value":{"url":"https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/company/default/applications/default/meta-field/assets/original/qABURepOA-sample-(6)-(1).csv"}},"CustomObjectRequestExample":{"value":{"status":"active","definition_id":"65718cc274f8c1b6ec2a3db6","fields":[{"definition_id":"65718cc374f8c1b6ec2a3db9","value":["some text"]}]}},"CustomObjectRequestExampleFailure":{"value":{"status":"none","definition_id":"65718cc274f8c1b6ec2a3db6","fields":[{"definition_id":"65718cc374f8c1b6ec2a3db9","value":["some text"]}]}},"CustomObjectDefinitionExample":{"value":{"description":"","name":"Designer","field_definitions":[{"type":"string_single_line","description":"","name":"city2","multi_value":false,"required":false,"key":"city","validations":[],"action":"update","_id":"656d67de766f951134509180","id":"656d67de766f951134509180"},{"_id":"656d67de766f95113450917f","creator":"company","resource":"metaobject","name":"mobile","namespace":"designer","key":"mobile","description":"","type":"string_single_line","multi_value":false,"validations":[],"company_id":"2","created_by":"9759643b65ebc6bacb5275f5","metaobject_definition_id":"656d67de766f95113450917b","required":false,"is_deleted":false,"created_at":"2023-12-04T05:47:10.569Z","updated_at":"2023-12-04T05:47:10.569Z","id":"656d67de766f95113450917f","action":"update"},{"_id":"656d67de766f95113450917e","creator":"company","resource":"metaobject","name":"name","namespace":"designer","key":"name","description":"This is name of designer","type":"string_single_line","multi_value":false,"validations":[],"company_id":"2","created_by":"9759643b65ebc6bacb5275f5","metaobject_definition_id":"656d67de766f95113450917b","required":true,"is_deleted":false,"created_at":"2023-12-04T05:47:10.569Z","updated_at":"2023-12-04T05:47:10.569Z","id":"656d67de766f95113450917e","action":"update"}],"display_name_key":"name"}},"CustomFieldsSuccess":{"value":{"fields":[{"definition_id":"656d6bc9766f9511345091a6","value":["65702b4574c5764716ee671d"]},{"definition_id":"656866a30152b0584464d547","value":["ram"]},{"definition_id":"65604cdb6a78c23f082c850b","value":["ramsons"]},{"definition_id":"655f53ddca37f5deb832a185","value":["kartik"]}]}},"uploadCopySuccessPayload":{"value":{"tracking_url":"https://api.fynd.com/public/assets/v1.0/status/copy-files/1.0","task":{"id":"1.0","name":"__default__","data":{"urls":["https://hdn-1.fynd.com/platform/pictures/free-logo/original/7qdHNTFe--platform-logo.png"],"destination":{"namespace":"test","basepath":"/test/general/free/original"}},"opts":{"attempts":2,"backoff":{"type":"fixed","delay":1000},"delay":0,"timestamp":1694812055325},"progress":0,"delay":0,"timestamp":1694812055325,"attemptsMade":0,"stacktrace":[],"returnvalue":null,"finishedOn":null,"processedOn":null}}},"InvoiceTypesResponseExample":{"value":{"data":[{"_id":"64d0cc5cc59e3f7b4ba8a246","pdf_type_id":1,"name":"invoice","format":["A4","A6","POS"],"visibility":true,"country_code":"IN","__v":0}],"success":true}},"DummyTemplateDataItemsExample":{"value":{"data":[{"_id":"64b7f52d56a0cba5231964b0","pdf_type_id":1,"payload":{"is_export":false,"app_domain_name":"https://shop.fynd.com","conversion_rate":{"base":"INR","rates":{"inr":{"name":"Indian Rupee","value":1,"symbol":"₹","sub_unit":""},"usd":{"name":"United States Dollar","value":0.01176,"symbol":"$","sub_unit":""}},"timestamp":1681117200000},"currency_code":"inr","shipment_id":"16915832909421966006","delivery_partner_detail":{"name":"fyndr","awb_number_barcode":"","awb_number":"7028792719409","eway_bill_number":null},"image":{"sales_channel_logo":""},"payments":[{"payment_type":"Cash on Delivery","amount":3010,"date":"2023-08-09","transaction_id":"TR64D383390EAD429ED3"}],"invoice_detail":{"invoice_id":"C00003929A000011","invoice_date":"09/08/2023","irn":"","external_order_id":"FY64D383390EBB4D847B","shipment_id":"16915832909421966006","signed_qrcode":"","upi_qrcode":""},"company_detail":{"name":"auto_company_120720232155193","address":"561,1430 NICO VIADUCT","city":"NICOBAR","state":"ANDAMAN AND NICOBAR ISLANDS","country":"INDIA","zip_code":739599,"state_code":"35","country_code":"IN","gstin":"27AALCA0442L1ZM","pan":null,"phone_no":"9823245916","cin":"","website_url":"https://autocompany120720232155193.hostx1.de/","email":"test@gmail.com"},"store_detail":{"store_name":"Khan Ltd lmitited","address":"52936,235 Desai Club, Thane - 127040","city":"Thane","state":"Maharashtra","country":"India","country_code":"India","zip_code":"127040","state_code":"27","gstin":"27AALCA0442L1ZM"},"customer_billing_detail":{"name":"Sonal Nalawade","phone_no":"XXXXXXX144","address":"OFFICE 101/Railway Police Quarters  Wing-D  Railway Police Quarters Sbi Bank Mumbai Maharashtra India 400093","city":"MUMBAI","state":"MAHARASHTRA","country":"India","country_code":"IND","zip_code":"400093","state_code":"27","gstin":null},"customer_shipping_detail":{"name":"Sonal Nalawade","phone_no":"XXXXXXX144","address":"OFFICE 101/Railway Police Quarters,  Wing-D,  Railway Police Quarters, Sbi Bank, Mumbai, Maharashtra, India, 400093","city":"MUMBAI","state":"MAHARASHTRA","country":"India","country_code":"IND","zip_code":"400093","state_code":"27","gstin":null},"return_detail":{"address":"52936,235 Desai Club","city":"Thane","state":"Maharashtra","country":"India","country_code":null,"zip_code":"127040","state_code":"27","gstin":"27AALCA0442L1ZM"},"product_table":{"total_items":1,"products":[{"name":"kuldeep testing webhook","seller_identifier":"DK78JSKKDJ","total":3000,"brand":{"logo":"https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/brands/pictures/square-logo/original/Wj9obvYLS-Logo.jpeg","name":"play clan555"},"hsn_code":"64011234","item_code":"123abc","total_units":1,"size":"OS","mrp":3000,"discount":0,"taxable_amount":2678.57,"total_taxable_amount":2678.57,"tax":{"cgst":{"value":160.715,"percent":6},"sgst":{"value":160.715,"percent":6},"igst":{"value":0,"percent":0}}}],"grand_total":3010,"delivery_charges":0,"delivery_charge_text":"Standard Delivery Charges (Incl of gst)","cod_charges":10,"fynd_discounts":0,"total_in_words":"Three Thousand Ten Rupees Only"},"tax_table":{"taxes":[{"hsn_code":"64011234","tax":{"cgst":{"value":160.715,"percent":6},"sgst":{"value":160.715,"percent":6},"igst":{"value":0,"percent":0}},"total_tax_value":321.43},{"hsn_code":"996819","tax":{"cgst":{"value":0,"percent":1.5},"sgst":{"value":0,"percent":1.5},"igst":{"value":0,"percent":0}},"total_tax_value":0}],"total_tax":321.43,"tax_in_words":"Three Hundred Twenty One Rupees and Forty Three Paise Only"},"declaration_texts":["1. Products being sent under this invoice are for personal consumption for the customer             and not for resale or commercial purposes.","2. Whether tax is payable under reverse charge - No","3. This invoice shows the actual price of the goods described             above and that all particulars are true and accurate.","4. In case of any queries, please reach out to care@gofynd.com.","5. The product is sold by seller via E-commerce platform i.e Fynd/Fyndstore/Fynd Platform,                            who doesn't represent or warrant or have any responsibility for claims relating to the                            products including its use","6. In the event of any loss or non-delivery, the goods                       shall be returned to the address specified below.","7. 52936,235 Desai Club, Thane, Maharashtra, India, 127040"],"registered_company_detail":{"address":"561,1430 NICO VIADUCT, NICOBAR, ANDAMAN AND NICOBAR ISLANDS, INDIA, 739599","city":"NICOBAR","state":"ANDAMAN AND NICOBAR ISLANDS","country":"INDIA","country_code":"IN","zip_code":739599,"state_code":"35"},"disclaimer":"An Electronic document issued in accordance with the provisions of the Information         Technology Act, 2000 (21 of 2000)","meta":{"generator":{"shipment_id_barcode_generator":{"method":"barcode","kwargs":{"value":"16915832909421966006"}},"signed_qrcode_generator":{"method":"signedqrcode","kwargs":{"value":""}},"upi_qrcode_generator":{"method":"qrcode","kwargs":{"qr_data":"","qr_url":""}},"digitalsignature_generator":{"method":"digital_signature","kwargs":{"value":"https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/company/2/self/legal/documents/free/original/QMx2H6a7o-deelipphoto.jpeg"}},"awb_number_label_barcode_generator":{"method":"barcode","kwargs":{"value":[]}}}},"is_self_ship":false,"mode":"live","is_self_pickup":false,"platform_name":"ECOMM","amount_to_be_collected":3010,"amount_paid":3010,"waybills":[],"total_items":1,"brand_logo":"https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/brands/pictures/square-logo/original/Wj9obvYLS-Logo.jpeg","shipment_id_barcode":"iVBORw0KGgoAAAANSUhEUgAAAJEAAABICAYAAAD26RfEAAAABmJLR0QA/wD/AP+gvaeTAAALYklEQVR4nO3Xe0yTZ9/A8W/tOM0NZRqIWnClVJEWLE4LFCwIRLKDDsw2hxKWuSlT46L/GLe47OAWs5FosuxggsrczLaoTMNwMoEZDxw2hRGkuDmcqHgoA9GNTYptf88fe9eMPOL7vs/NkydPcn0SAvfdK9d13b2/abl1gACICDqdDhEBQKfT8Ze/nxvp9b+O7/T6ncbc6e+R5vr72iO99v9ZY6TX77be/3Ydd3ufRprnbmvdbe2R7tWd1h/peKT93+39vdMeAMagKBqpiBTNVESKZioiRTMVkaKZikjRTEWkaKYiUjRTESmaqYgUzVREimYqIkUzFZGimYpI0UxFpGimIlI0UxEpmqmIFM1URIpmKiJFMxWRopmKSNFMRaRopiJSNFMRKZqpiBTNVESKZioiRTMVkaKZikjRTEWkaKYiUjRTESmaqYgUzVREimYqIkUzFZGimYpI0UxFpGimIlI0UxEpmqmIFM1URIpmKiJFMxWRopmKSNFMRaRopiJSNFMRKZqpiBTNVESKZioiRTMVkaKZikjRTEWkaKYiUjRTESmaqYgUzVREimY6EZH/9CaU/27qk0jRTEWkaKYiUjQb1YgyMzOHHVdUVGA0GomLi6OmpgYAl8tFamoqZrOZlStX4vP5AuMvXrxIUVFR4Pj48ePodLrAz2uvvQbAJ598gslkwmQysW3bNgCuXbtGVlYWZrOZ1NRUOjs7ATh69CgWi4XY2FheeOEF/H4/Q0NDPPvss5jNZtLS0vj5558BuHz5Mna7nalTp/L6668H9rF+/XrMZjM2m43m5uZh19ja2sqcOXMCx2VlZcTFxREbG8u77747bOzGjRs5duxY4Pizzz4jPj6e+Ph4du3aFTi/ZcsWDAYDSUlJuFwuAHp6enA6nRgMBlauXBkY+/bbbzN58mTsdjsXLlwAwO12k5aWRkxMDC+//HJgbE1NDWazGaPRSEVFxZ1u4b9GRkFjY6MsWrRIQkNDA+f6+/vFZDKJ2+2Wjo4OMZvNIiLicDikvr5e/H6/LFu2TCoqKkREpKysTKxWqyxZsiQwx86dO6W0tHTYWkNDQ2IwGKSvr08GBgZk2rRpcv36ddmwYYNs2bJFREQ++ugjee6550REZMaMGdLW1iZer1fy8/Pl888/l/fee09Wr14tIiK1tbVSUFAgIiLFxcWya9cuGRoakpSUFGltbZXKykrJz88Xr9crp0+fFofDMWwvDodDbDabiIj09PRIbGysXL9+XW7evCkzZsyQs2fPyrVr1+TFF1+UsLAwOXr0qIiIXLt2TeLj4+X69ety48YNmTlzpvT19UlLS4vY7Xa5deuW7N+/Xx577LHA3srLy8Xn80lWVpbU1dXJmTNnxGazyeDgoOzbt08WL14sIiIlJSWybds28Xq9kpmZKY2NjeLxeMRkMklXV5dcunRJpkyZIrdv3x6N2y+j8kkUFRXFypUriYiICJyrqalh4cKFREZGMmPGDOrq6hARurq6cDgc6HQ6CgoKAp9QiYmJLF++fNi8nZ2dfPHFFxiNRp5++ml+/fVXxowZQ1hYGD6fD7/fH/idn59PcXExAF6vl3HjxjE0NERKSgqJiYno9Xrmzp3L2bNnaW1t5ZFHHgEgJyeHkydPAnDixAkWL15MUFAQhYWFHD58mNbWVvLy8tDr9VitVn777Tf6+/sBeOedd1i0aFFgvz09PTz//PNEREQQHh6OzWajs7OTsLAwFixYQEZGRmDsDz/8QHJyMhEREYwbN46MjAyOHz9OZWUly5cvJzQ0lMcff5wPPvgAgGPHjlFUVMSYMWPYv38/s2fPpq6ujieffJKQkBDy8/NpamoC4MiRIyxduhS9Xs+SJUs4fPgwJ06cID09nalTp2IwGPj2229H49YDo/R1ZjQayc3NJSQkJHCuu7ub3t5e0tLSsNlsuFwudDodkydPpr6+Hq/Xy549e3C73QCkpKQwe/bsYfPef//9lJSU8NNPPxEdHc0bb7yBXq9n1apVGI1GDAYDTz31FBMmTCAlJYUJEyaQkJDAunXrKCkpITg4mPLycgB6e3vZuXMnOTk5WCwWDh48iIjw1Vdf0d3dze+//47P5wtcg8FgwO12Y7FYqK6uxuv10tzczNmzZ3G73bhcLr777jueeeaZwH4tFgsvvfQSAG1tbdTX12O32wkPDyc3N5dJkyYFxprNZpqbm+nr66O3t5fa2lrcbjfd3d20tLQwa9YsMjIy6O/vZ2BggKCgIJYtW0ZCQgKvvvoqY8eOxe12M2XKFAD0ej2hoaF4PB4GBwe57777hl1Hd3c3t27dwul0kpiYSENDA/fcc89o3H5GZ5Y7GBwc5Pz589TW1tLb20tWVhYdHR1s376dVatWMTg4iNPpxO/3jzjHhg0bAn+vW7eOBQsWcOnSJXbs2EFXVxfBwcEsXLiQ8+fPYzQaAejo6KCqqoqSkhKOHDkCwKFDh1izZg3r16/H4XAwa9YsVq1ahdVqZd68eURHRxMcHIxOpxu2vt/vp6CggIaGBmbOnElycjIJCQmEhISwYsUKtm/f/k97FhHef/99tm7dyq5du5gwYcIdr23y5Mls3LiRzMxMoqKiSEpK4t5772VwcBCPx8PJkydpampi2bJlHDp0iPPnz/Pxxx8zZ84cioqK+PTTTwGG7VlE8Pv9d7yOwcFBfvzxR44ePYrH4yE9PZ158+YxceLEu93G/5N/29NZZGQkjz76KGPHjmXq1KkYjUYuX76M0WjkxIkTNDc3k5ycTExMzIhzHDx4MPCPd1BQEMHBwbS1teFwOJg4cSLh4eE4nU6OHDnCK6+8Ql9fHwDz58/n3LlzAOzYsYNNmzZRU1PDihUrAnN/+OGHuFwuSktLCQkJISgoCL1ez9DQEABXrlxh0qRJ3L59m02bNuFyudi9ezc3b95k7NixtLW1kZ2dzezZs+no6CA7OxuA1atX09jYSHNzM1lZWSNe219fwe3t7dTV1REUFERMTAyRkZE88cQT6PV60tPT6enp4YEHHiA2NpbU1FT0ej0LFy6kvb2dqKgorl69GpjP4/EQFhZGaGgof/zxx7DriIyMZP78+YwfP56oqCiSk5MD75FW/7aIsrOzqa6uxuPx0N3dzaVLl4iOjqa4uJgDBw5w+/Zttm/fTn5+/ohzlJWVsWfPHgDKy8uZP38+FouFhoYGbt68ya1bt6itrSUhIYEbN26wd+9eAKqqqrDZbHg8HjZv3kxtbW3gkwrgyy+/ZOnSpcCfkT388MPAn0+XlZWV+P1+9u3bR15eHt9//z3Z2dn4fD4qKytJTEwkMjISt9vNuXPnOHXqFAkJCXzzzTe4XK5AbOPHj7/r++P1epk+fTo9PT10dXVx6tQp0tLSyM3N5cCBA4gITU1NTJkyBb1ej8lkoqWlBb/fT1VVFcnJyeTl5VFRUYHP5+Prr78mNTUVgNzcXCoqKhAR9u7dS15eHnPnzuXYsWMMDAzQ29tLW1sb06ZN+9dv8N+Nyr/n/+PBBx8cdrx161aZPn26WK1WOXz4sIiItLe3S1JSkhgMBtm8efOw8fX19cOezjo7O+Whhx4Sk8kkhYWFMjAwICJ/PsmZzWaJjY2Vt956S0RErl69Kjk5OWIymcTpdMq5c+ekra1NgGE/b775pni9XiksLJTo6GjJycmR/v5+ERG5cuWKOJ1OsVqtsmnTpsA+1q5dKzExMWK32+XixYvD9vzLL78Ens527tz5T+tVV1cHxhYXFweezkREdu/eLUajUeLi4qS2tlZERHw+n6xdu1bMZrPY7XY5ffq0iIicOXNG7Ha7xMXFyZo1a8Tn84mISGlpqVitVklPT5cLFy6IyJ9PidnZ2WKxWGTjxo2B9crLyyU+Pl7i4+MDT8Wj4R8Mn/B15sxE9gAAAABJRU5ErkJggg==","signed_qrcode":"","upi_qrcode":"https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/fyprod/wrkr/logistics/qr-code/Delhivery/original/Hv0blbPtA-16830153113571272087.png","digitalsignature":"https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/brands/pictures/square-logo/original/Wj9obvYLS-Logo.jpeg","awb_number_barcode":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAHsAAABICAYAAADWKYp8AAAABmJLR0QA/wD/AP+gvaeTAAAHTklEQVR4nO2db0hTXRzHv1elP7M/oILonKjL6dyyWMrE/FOkgSiNTCoriajAjKI3FQsFw15lrSLJwAL7B9ILEenFsNRKapVFShtRhkNp5SJXpm7Jtvt73jzdx/mnhJ584DnnA3txz/ndc7/nfHbvPe+uAIAAgIggCAKICAAgCAJ+MLntR93k9h/M5fzZrjV5rMnnTq2fOu7ULDNlmC3/bNmmzudn+WbLNjXfXNZx6nV+VTtT3p/lCgKHGbhshuCyGYLLZggumyG4bIbgshmCy2YILpshuGyG4LIZgstmCC6bIbhshuCyGYLLZggumyG4bIbgshmCy2YILpshuGyG4LIZgstmCC6bIbhshuCyGYLLZggumyG4bIbgshmCy2YILpshuGyG4LIZgstmCC6bIbhshuCyGYLLZggumyG4bIbgshmCy2YILpshuGyG4LIZgstmCC6bIbhshuCyGYLLZggumyG4bIbgshmCy2YILpshuGyG4LIZQqCpH3/k/G/hdzZDcNkMwWUzxLzIHhsbgyAIAT+DwQAAuHjxIuRyOXQ6Hfr6+gAA/f39yMzMhFKpRGFhIVwuFwCgtrYW8fHxUKlUaG5uBgDodLqAccPCwgAAjY2NSEpKglqtRlNTEwDA4/Fg69atUCqVWLNmDXp7e2G326dl27dvn5S9paUFJpNJOn769Cl0Oh0SExNhNBoDvl9NRMjPz8f9+/cBAKOjo8jLy0NMTAwOHDgAURQBAOfOnYNKpYJGo4HZbP4jaz4j9B9QWVlJd+7cocHBQUpOTqbx8XEym81UWFhIRETbt2+n69evExFRdXU1HT16lN6/f09qtZrcbjd9+vSJ4uPjSRTFgHHNZjMdP36cBgYGSKvV0sjICA0PD5NWq6XR0VG6dOkS7d+/n4iI2tvbSa/XT8tWXl5OFouFRFGkyspKioqKorNnz0r9KSkpZLPZyOfzkcFgoAcPHkh9DQ0NJJPJqLOzk4iIqqqqqKamhkRRpOLiYmptbaWenh7S6/XkdrvJ4XCQVqslr9f77y7wLMz7Y7y/vx9v3rxBYWEhOjo6sHnzZshkMmzcuBGvXr2CKIpYsmQJtmzZAgBYt24d+vr6sGjRIgQHB0MURfj9fvj9/oC7yuv1ora2FlVVVbDZbNDr9Vi2bBnCwsKQnp4Oi8UCr9eLvXv3AgCysrJgt9sDsr18+RI+nw8ZGRkAgNzcXBQXF0v9o6Oj8Pl8SElJQXBwMAwGA+7duwcAcDgcaGpqwqZNm6T69vZ2lJWVQRAElJWVoa2tDb29vVi/fj0WL16M6OhoxMXFwWq1/pnFnsK8yz516hSOHTsGAHA6nZDL5QAAQRAQERGBL1++oKGhATKZDF6vFyaTCRs2bEB4eDjy8/Mhl8uhVCphNBoRFPRP/Bs3bqCoqAihoaFISkqCxWLB169fMTQ0hM7OTjidThw+fBh6vR4AYDKZkJubG5Dt5MmTMBqNUp68vDyoVCqpf+nSpRBFEVarFRMTE2hubobT6QQAHDp0CCaTCSEhIVK90+lEdHQ0ACAmJgZDQ0NISUlBR0cH3G437HY7njx5Io3xpwn5dcm/h8PhwODgINLS0qQ2QRACan6816xWK3bv3o3s7GxUVFSgu7sbz549g8PhwNjYGAwGA0pLS7F8+XIQEerr66V3ZUJCAo4cOYK1a9dCLpdj9erVkMlkAACXy4Xy8nK4XC7cvn1buq7VakVISAgSEhJ+OofGxkbs2bMHgiAgPT0dCxYswK1bt7By5UqkpqZOq588P1EUkZaWhpKSEqSnp0OpVAZk+9PM653d1NQU8FiMjIzEx48fpePh4WGEh4fDYrGgpKQEdXV1OH/+PIKCgvD8+XMUFBQgNDQUkZGRSE5ORnd3NwCgu7sbiYmJCA0NBQD4/X6UlpbCZrOhra0NAKBQKPD582fk5OSgoKAAd+/elTZzAHDz5k1s27btl3PQarXSHy8hIQGxsbF4/Pgxrl27BqVSiZaWFuzYsQMdHR0B8/vw4QOioqLg8/lQUVEBm82G1tZWeDweKBSK31/cuTAvO4O/yc7OJrvdLh07HA5KTU2liYkJevjwobRBy8rKIpvNFnDuo0ePKCcnh75//04ul4uSkpJoYGCAiIhOnDghbeiIiMbGxigqKopcLhe9ffuW1Go1+f1+MhqNdPny5RmzaTQaGhkZmdZ+4cKFgA1aZmYmdXV10fj4OK1atYrevXsXUL9r1y5pg1ZdXU1nzpwhIqKdO3dSa2srORwOio+PJ7fbTS9evKC0tLQ5r9/vMm+yPR4PKRSKae11dXWk1WopIyOD+vr6yO/308KFCwmA9CsuLiYiopqaGlIqlbRixQq6evWqNEZWVha9fv06YNwrV65QXFwcqVQq6urqIiKivLy8gHEjIiKIiMjpdJJGo5kx91TZFouF1Go1KRQKqq+vn1Y/Wfa3b9+oqKiINBoNHTx4kPx+PxERnT59mmJjY0mr1VJPT8+c1/B3+QsIrdSMoNwxhQAAAABJRU5ErkJggg==","uid":"16915832909421966006"},"country_code":"IN","__v":0}],"success":true}},"PdfConfigSuccessExample":{"value":{"data":[{"_id":"64b7f52d56a0cba5231964b0","company_id":1,"application_id":"64aed475db2cfb5b8a9f623d","pdf_type_id":1,"format":"A4","template":"<p>Hello world</p>","__v":0}],"success":true}},"PdfConfigSaveSuccessExample":{"value":{"data":{"_id":"64dfd8fc8f3b8b5ae5beb72c","format":"A4","pdf_type_id":1,"template":"<div>\n  \n</div>","__v":0},"success":true}},"BrowseResponseExample":{"value":{"items":[{"_id":"64e1e6fe0153e1a6d3e101f4","file_name":"logo.png","file_path":"/brands/pictures/square-logo/original/uY0P_ZtIz-logo.png","success":true,"namespace":"brand-square-logo","content_type":"image/png","size":3298,"operation":"putObject","tags":[],"cdn":{"url":"https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/brands/pictures/square-logo/original/uY0P_ZtIz-logo.png","absolute_url":"https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/brands/pictures/square-logo/original/uY0P_ZtIz-logo.png","relative_url":"https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/brands/pictures/square-logo/original/uY0P_ZtIz-logo.png"},"upload":{"url":"https://fynd-staging-assets.s3-accelerate.amazonaws.com/addsale/brands/pictures/square-logo/original/uY0P_ZtIz-logo.png?Content-Type=image%2Fpng&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=%2F20230820%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20230820T101213Z&X-Amz-Expires=1800&X-Amz-Signature=04915b14aec15712abdea3c340d5dc43729e7c982a4994650488c0150c22b0ae&X-Amz-SignedHeaders=host%3Bx-amz-acl&x-amz-acl=public-read","expiry":1800},"created_by":{"username":"fp_sdet_gofynd_com_65071"},"company_id":6520,"bucket_key":"addsale/brands/pictures/square-logo/original/uY0P_ZtIz-logo.png","createdAt":"2023-08-20T10:12:14.118Z","updatedAt":"2023-08-20T10:12:14.118Z","__v":0}],"page":{"current":1,"has_previous":false,"has_next":true,"item_total":481,"type":"number"}}},"ZoneNotPresent":{"value":{"error":{"type":null,"value":null,"message":null},"success":true,"data":{"serviceability_type":"all","channel_id":"64dde7bdfee396b04bcb609b","channel_type":"application"},"summary":{"active_zones":0,"total_zones":0}}},"ZonePresent":{"value":{"error":{"type":null,"value":null,"message":null},"success":true,"data":{"serviceability_type":"zone-based","channel_id":"64d1d71dbc8340eb309a95e4","channel_type":"application"},"summary":{"active_zones":1,"total_zones":1}}},"EnableZoneBased":{"value":{"serviceability_type":"zone-based"}},"DisableZoneBased":{"value":{"serviceability_type":"all"}},"GetZoneByIdValidZoneResponse":{"value":{"name":"Test Zone","slug":"test-zone","is_active":false,"channels":[{"channel_id":"64aed475db2cfb5b8a9f623d","channel_type":"application"},{"channel_id":"64ba6650932a416fb67557fa","channel_type":"application"}],"product":{"type":"all","tags":[]},"store_ids":[2,1462,3470,3471,3475,3742,3748,3751,3752,3753],"region_type":"non-pincode","mapping":[{"country":"64aec5a93a079bd328537835","regions":["64aec5a93a079bd328537838"]}],"zone_id":"64d22858f8aafe61d79f07ea","stores_count":10,"display_name_mapping":{"64aec5a93a079bd328537835":"India","64aec5a93a079bd328537838":"GUJARAT"}}},"UpdateZoneByIdGujaratHaryanaExample":{"value":{"is_active":false,"zone_id":"64d22858f8aafe61d79f07ea","slug":"test-zone","name":"Test Zone","company_id":2,"store_ids":[2,1462,3470,3471,3475,3742,3748,3751,3752,3753],"region_type":"country-state","mapping":[{"country":"64aec5a93a079bd328537835","regions":["64aec5a93a079bd328537838","64aec5a93a079bd328537837"]}],"product":{"type":"all","tags":[]},"channels":[{"channel_id":"64aed475db2cfb5b8a9f623d","channel_type":"application"},{"channel_id":"64ba6650932a416fb67557fa","channel_type":"application"}]}},"MaharashtraPincodeZone":{"value":{"is_active":true,"slug":"maharashtra-pincode-zone","name":"Maharashtra Pincode Zone","company_id":2,"store_ids":[1462],"region_type":"pincode","mapping":[{"country":"64aec5a93a079bd328537835","regions":["64aec5aa3a079bd32853a0fb"]}],"product":{"type":"all","tags":[]},"channels":[{"channel_id":"64ba6650932a416fb67557fa","channel_type":"application"}]}},"ZoneSearchQueryIsActiveExample":{"value":{"items":[{"name":"company2 zone","slug":"company2-zone","company_id":2,"is_active":true,"channels":[{"channel_id":"64c22ef872985245a6334afa","channel_type":"application"}],"zone_id":"64c3a0926ea670363c8e2e3d","stores_count":2,"regions_count":4242,"product":{"count":0,"type":"all"}}],"page":{"type":"number","size":1,"current":1,"has_next":false,"item_total":1}}},"getAppRegionZonesExample":{"value":{"zones":[{"tags":[],"type":"all","store_ids":[1],"name":"HORECA_ZONE97","slug":"HORECA_ZONE97","is_active":false,"zone_id":"62ea282fc7da79ec49d99bf1"},{"tags":[],"type":"all","store_ids":[2000,2001,2003,1000,1001],"name":"HORECA_ZONE95","slug":"HORECA_ZONE95","is_active":false,"zone_id":"62ea28f3190e82506fbd3f7d"},{"tags":[],"type":"all","store_ids":[1,4,5],"name":"Rv zone","slug":"rv-zone","is_active":true,"zone_id":"63b3de24381ca44c37c405f8"}],"serviceability_type":"zone-based"}},"ZoneAlreadyExistsError":{"value":{"type":"SchemaValidationError","value":"slug","message":"Zone already exists for given slug"}},"ZoneRegionConflictError":{"value":{"success":false,"status_code":400,"zone_id":"64eb7e6dd29c8b4407357e39","is_overlapping":false,"error":[{"type":"ZoneRegionsConflictError","value":["64aec5a93a079bd328537835","64aec5a93a079bd3285382d2"],"message":"Some of the regions are conflicting"}]}},"ZoneOverlappingRegionError":{"value":{"success":false,"zone_id":"65080aa67b7ddcb757462d5b","status_code":400,"is_overlapping_enabled":false,"error":{"type":"ZoneOverlappingConflictError","value":[{"channel_name":"Dummy","zone_name":"Zone1","conflicting_regions":[{"display_name":"India","conflicting_uid":"64aec5aa3a079bd32853a0fb","conflicting_name":"Maharashtra"}]}],"message":"Some of the regions are conflicting across sales channels"}}},"PackageMaterial":{"value":{"id":"64b8526e5ca47d41582b9fa1","name":"Package1","item_id":1234,"company_id":1,"length":1,"height":1,"width":1,"weight":1,"error_rate":0,"store_ids":[1,9,5],"rules":[{"rule_id":"64b4337a0c607fbfbcd0156b","quantity":{"min":1,"max":2},"weight":100}],"channels":[{"id":"64b4337a0c607fbfbcd0190b","type":"application"}],"media":["https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/sandbx/wrkr/sandeepmaale/products/pictures/bundle/free/original/LOc5XW0cc-Logo.png"],"package_type":"box","size":"small","status":"active","track_inventory":false,"max_weight":100,"package_vol_weight":100,"auto_calculate":true}},"PackageRule":{"value":{"id":"64b4337a0c607fbfbcd0156b","company_id":1,"name":"Rule For Dev Contract","category_id":{"includes":[1,2]},"product_tag":{"includes":["abc","xyz"]},"product_id":{"includes":[1,2]},"type":"package","is_active":true}},"PackageMaterialRuleList":{"value":{"items":[{"id":"64b4337a0c607fbfbcd0156b","company_id":1,"name":"Rule For Dev Contract","category_id":{"includes":[1,2]},"product_tag":{"includes":["abc","xyz"]},"product_id":{"includes":[1,2]},"type":"package","is_active":true}],"page":{"type":"number","size":1,"current":1,"has_next":false,"has_previous":false,"item_total":1}}},"PackageMaterialList":{"value":{"items":[{"id":"64b8526e5ca47d41582b9fa1","name":"Package1","item_id":1234,"company_id":1,"length":1,"height":1,"width":1,"weight":1,"error_rate":0,"store_ids":[1,9,5],"rules":[{"rule_id":"64b4337a0c607fbfbcd0156b","quantity":{"min":1,"max":2},"weight":100}],"channels":[{"id":"64b4337a0c607fbfbcd0190b","type":"application"}],"media":["https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/sandbx/wrkr/sandeepmaale/products/pictures/bundle/free/original/LOc5XW0cc-Logo.png"],"package_type":"box","size":"small","status":"active","track_inventory":true,"max_weight":100,"package_vol_weight":100,"auto_calculate":true}],"page":{"type":"number","size":1,"current":1,"has_next":false,"has_previous":false,"item_total":1}}},"GiveawayResponse":{"value":{"items":[{"_id":"645c9cdd199c5232d7848bc2","application_id":"5d5c304a4df829372e2ad6d1","name":"test deacs","title":"wscws","description":"wscfws","active":true,"audience":{"header_user_id":"uid","id":"645b6c682c6786d31eac6c89"},"rule":{"amount":100},"_schedule":{"start":"2023-05-11T07:44:09.542Z","end":"2023-05-11T18:30:00.000Z"},"banner_image":{"aspect_ratio":"2:1","secure_url":""},"updated_by":"600693a01faf8695d70a15df","created_at":"2023-05-11T07:44:29.123Z","id":"645c9cdd199c5232d7848bc2"},{"_id":"645b6e9be02d1131fc06c2b4","application_id":"5d5c304a4df829372e2ad6d1","name":"yedbx","title":"wdc","description":"wdfc","active":true,"audience":{"header_user_id":"uid","id":"645b6c682c6786d31eac6c89"},"rule":{"amount":100},"_schedule":{"start":"2023-05-10T10:14:45.672Z","end":"2023-05-10T18:30:00.000Z"},"banner_image":{"aspect_ratio":"2:1","secure_url":""},"created_at":"2023-05-10T10:14:51.807Z","id":"645b6e9be02d1131fc06c2b4"}],"page":{"type":"string","item_total":2,"size":10,"current":1,"has_next":false}}},"Giveaway":{"value":{"application_id":"5d5c304a4df829372e2ad6d1","name":"abhinav test","title":"abhinav test","description":"abhinav test","active":true,"audience":{"id":"6459029c9020a3d96599c528","header_user_id":"uid"},"rule":{"amount":1000},"_schedule":{"start":"2023-05-24T09:35:02.800Z","end":"2023-05-24T18:30:00.000Z"},"banner_image":{"secure_url":"","aspect_ratio":"2:1"}}},"Offers":{"value":[{"_id":"63bfb9c1195d62ac089641cd","application_id":"5d5c304a4df829372e2ad6d1","name":"order","_schedule":{},"active":true,"banner_image":{"aspect_ratio":"2:1","secure_url":"https://hdn-1.fynd.com/company/884/applications/000000000000000000000001/rewards/pictures/landscape-banner/original/dbY4bHh9d-reward-banner.png"},"created_at":"2023-01-12T07:41:53.356Z","display":{"validity":1000,"validity_unit":"hours"},"info_action":{"type":"","page":{"type":"","params":{"slug":null},"url":""}},"rule":{"claimed":true,"value":10,"value_type":"percent","validity":60000},"share":{"default":"Hey, join me on {{application_name}} and get exciting offers and reward points. Signup today and quickly earn Rs.{{offer_amount}}. Visit {{offer_link}} now!","text":""},"sub_text":"Purchase and get reward points","text":"Order & Earn","type":"earn","updated_at":"2023-01-12T15:46:04.854Z","updated_by":"6678589f5d0df704c9996644","url":""},{"_id":"6363f62638693f31a29e51ea","application_id":"5d5c304a4df829372e2ad6d1","name":"order_discount","_schedule":{},"active":true,"banner_image":{"aspect_ratio":"2:1","secure_url":"https://hdn-1.fynd.com/company/884/applications/000000000000000000000001/rewards/pictures/landscape-banner/original/dbY4bHh9d-reward-banner.png"},"created_at":"2022-11-03T17:11:02.555Z","display":{"validity":0,"validity_unit":""},"info_action":{"type":"","page":{"type":"","params":{"slug":null},"url":""}},"rule":{"currency":"INR","buckets":[{"low":1,"high":1000,"max":10000,"value":100,"value_type":"percent"},{"low":1001,"high":-1,"max":15000,"value":1000,"value_type":"percent"}]},"share":{"default":"","text":""},"sub_text":"Get flat discounts on total order amount. Shop now!","text":"Get flat discounts on total order amount","type":"redeem","updated_at":"2022-11-03T17:11:02.557Z","updated_by":"3d20f854d736c43f7fd4a9e3","url":""},{"_id":"6321aee18c981b2d5053942a","application_id":"5d5c304a4df829372e2ad6d1","name":"referral","_schedule":{},"active":true,"banner_image":{"aspect_ratio":"2:1","secure_url":"https://hdn-1.fynd.com/company/884/applications/000000000000000000000001/rewards/pictures/landscape-banner/original/dbY4bHh9d-reward-banner.png"},"created_at":"0001-01-01T00:00:00.000Z","display":{"validity":10,"validity_unit":"days"},"info_action":{"type":"","page":{"type":"","params":{"slug":null},"url":""}},"rule":{"counter":0,"amount":100,"referrer_amount":100,"amount_validity":14400,"threshold":10000},"share":{"default":"Hey, join me on {{application_name}} and get exciting offers and reward points. Signup today and quickly earn Rs.{{offer_amount}}. Visit {{offer_link}} now!","text":""},"sub_text":"Share your referral code, invite your friends and you'll both get exciting reward points!","text":"Refer & Earn","type":"earn","updated_at":"2022-09-14T10:37:22.340Z","updated_by":"600693a01faf8695d70a15df","url":""},{"_id":"642312c095baca2e5ba4e8a7","application_id":"5d5c304a4df829372e2ad6d1","name":"refund_points","__v":0,"active":true,"banner_image":{"secure_url":"","aspect_ratio":"2:1"},"created_at":"2023-03-28T16:15:54.294Z","rule":{"amount_validity":60000,"counter":0},"sub_text":"Your wallet is configure with the points related to the most recent order cancellation. Happy shopping.","text":"Points Returned","type":"earn","updated_at":"2023-03-28T16:16:01.539Z","updated_by":"600693a01faf8695d70a15df","updated_by_name":"abhinavmaurya_gofynd_com_44493","display":{"validity":60000,"validity_unit":"minutes"},"share":{}},{"_id":"6385d7d8a30091f25bf71514","application_id":"5d5c304a4df829372e2ad6d1","name":"sign_up","_schedule":{},"active":true,"banner_image":{"aspect_ratio":"2:1","secure_url":"https://hdn-1.fynd.com/company/884/applications/000000000000000000000001/rewards/pictures/landscape-banner/original/dbY4bHh9d-reward-banner.png"},"created_at":"2022-11-29T09:58:48.487Z","display":{"validity":10,"validity_unit":"days"},"info_action":{"type":"","page":{"type":"","params":{"slug":null},"url":""}},"rule":{"counter":0,"amount":1000,"amount_validity":14400,"threshold":10000},"share":{"default":"","text":""},"sub_text":"Sign-up today and get exclusive offers and reward points!","text":"Sign Up & Win","type":"earn","updated_at":"2022-11-29T09:58:48.491Z","updated_by":"600693a01faf8695d70a15df","url":""}]},"Offer":{"value":{"_id":"63bfb9c1195d62ac089641cd","application_id":"5d5c304a4df829372e2ad6d1","name":"order","_schedule":{},"active":true,"banner_image":{"aspect_ratio":"2:1","secure_url":"https://hdn-1.fynd.com/company/884/applications/000000000000000000000001/rewards/pictures/landscape-banner/original/dbY4bHh9d-reward-banner.png"},"created_at":"2023-01-12T07:41:53.356Z","display":{"validity":1000,"validity_unit":"hours"},"info_action":{"type":"","page":{"type":"","params":{"slug":null},"url":""}},"rule":{"claimed":true,"value":10,"value_type":"percent","validity":60000},"share":{"default":"Hey, join me on {{application_name}} and get exciting offers and reward points. Signup today and quickly earn Rs.{{offer_amount}}. Visit {{offer_link}} now!","text":""},"sub_text":"Purchase and get reward points","text":"Order & Earn","type":"earn","updated_at":"2023-01-12T15:46:04.854Z","updated_by":"6678589f5d0df704c9996644","url":""}},"UpdateAppUser":{"value":{"active":true,"block_reason":"test"}},"AppUser":{"value":{"user":{"_id":"6362648a38693f31a29e51e2","user_id":"620f8234e517800d9497660d","referral":{"code":"HASE02"},"application_id":"5d5c304a4df829372e2ad6d1","created_at":"2022-11-02T12:37:30.078Z","updated_at":"2022-11-02T12:37:30.078Z","active":false,"block_reason":"test"},"points":{"available":0}}},"HistoryRes":{"value":{"items":[{"_id":"6464a9eb70e0debb8462667d","application_id":"000000000000000000000001","user_id":"000000000000000009802478","points":500,"remaining_points":500,"txn_name":"signup_credit","claimed":true,"expires_on":"2023-06-14T10:18:19.118Z","meta":{"offer_id":"630e0b8e349f3f1cfbec572f"},"created_at":"2023-05-17T10:18:19.118Z","updated_at":"2023-05-17T10:18:19.118Z","text_1":"Signup points","text_2":"Additional Points","text_3":"Will expire on 3:48 PM, 14 Jun'23"},{"_id":"6464a9d370e0debb84626677","application_id":"000000000000000000000001","user_id":"000000000000000009802478","points":500,"remaining_points":500,"txn_name":"signup_credit","claimed":true,"expires_on":"2023-06-14T10:17:55.588Z","meta":{"offer_id":"630e0b8e349f3f1cfbec572f"},"created_at":"2023-05-17T10:17:55.588Z","updated_at":"2023-05-17T10:17:55.588Z","text_1":"Signup points","text_2":"Additional Points","text_3":"Will expire on 3:47 PM, 14 Jun'23"}],"page":{"current":0,"item_total":2,"type":"cursor","size":1,"has_previous":true,"has_next":false,"next_id":""}}},"ConfigurationRes":{"value":{"success":true,"terms_conditions_link":"https://fynd.freshdesk.com/support/solutions/folders/33000111619","valid_android_packages":["co.abc.com"],"application_id":"5d5c304a4df829372e2ad6d1"}},"ConfigurationRequest":{"value":{"valid_android_packages":["co.fynd.com"],"terms_conditions_link":"https://fynd.freshdesk.com/support/solutions/folders/33000111619"}},"ThemesExample1":{"value":[{"_id":"64be4423bc7b28003211322e","applied":false,"is_private":false,"tags":[],"application_id":"6487ea376e1442284917c44e","marketplace_theme_id":"64be1f4cceb549012e93d5f4","meta":{"payment":{"is_paid":false,"amount":0},"description":"Indulge in the epitome of luxury with our expertly crafted theme, showcasing a high-end aesthetic that exudes elegance. Designed with meticulous attention to detail, our features are tailored to elevate your products and amplify your brand identity.","industry":["Arts and crafts","Baby and kids","Books, music, and video"],"release":{"notes":"<p>Emerge release notes. Fyndx1 theme submission.</p>"},"images":{"desktop":"https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/misc/pictures/free-icon/original/McHjwol_h-images_desktop.webp","mobile":"https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/misc/pictures/free-icon/original/bq6gXrmVE-images_mobile.webp"},"slug":"emerge"},"name":"Emerge","template_theme_id":"64be1fdc2139f66b3ca2e94d","version":"1.0.153","styles":{},"created_at":"2023-07-24T09:28:03.845Z","updated_at":"2023-07-31T12:14:13.097Z","theme_type":"vue2","assets":{"umd_js":{"links":["https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/organization/64b0eb01c35f990518880a82/theme/assets/yf7ijNZKa_themeBundle.umd.min.8.js","https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/organization/64b0eb01c35f990518880a82/theme/assets/yf7ijNZKa_themeBundle.umd.min.cart.js","https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/organization/64b0eb01c35f990518880a82/theme/assets/yf7ijNZKa_themeBundle.umd.min.extras.js","https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/organization/64b0eb01c35f990518880a82/theme/assets/yf7ijNZKa_themeBundle.umd.min.products-listing.js","https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/organization/64b0eb01c35f990518880a82/theme/assets/yf7ijNZKa_themeBundle.umd.min.products.js","https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/organization/64b0eb01c35f990518880a82/theme/assets/yf7ijNZKa_themeBundle.umd.min.profile.js","https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/organization/64b0eb01c35f990518880a82/theme/assets/yf7ijNZKa_themeBundle.umd.min.vendors_products-listing.js","https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/organization/64b0eb01c35f990518880a82/theme/assets/yf7ijNZKa_themeBundle.umd.min.vendors_products.js","https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/organization/64b0eb01c35f990518880a82/theme/assets/yf7ijNZKa_themeBundle.umd.min.js"],"link":""},"common_js":{"link":"https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/organization/64b0eb01c35f990518880a82/theme/assets/yf7ijNZKa_themeBundle.common.js"},"css":{"links":["https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/organization/64b0eb01c35f990518880a82/theme/assets/yf7ijNZKa_cart.1b038cd83e502f2d58bc.css","https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/organization/64b0eb01c35f990518880a82/theme/assets/yf7ijNZKa_extras.f8a9789ae6a06b0bd503.css","https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/organization/64b0eb01c35f990518880a82/theme/assets/yf7ijNZKa_products-listing.1d639747568baee211ba.css","https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/organization/64b0eb01c35f990518880a82/theme/assets/yf7ijNZKa_products.c1f151d12b3f704fe028.css","https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/organization/64b0eb01c35f990518880a82/theme/assets/yf7ijNZKa_profile.c9e6a92612e4b423dbd7.css","https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/organization/64b0eb01c35f990518880a82/theme/assets/yf7ijNZKa_themeBundle.css","https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/organization/64b0eb01c35f990518880a82/theme/assets/yf7ijNZKa_vendors_products-listing.c8fe85761d60286348e3.css"],"link":""}},"font":{"variants":{"light":{"name":"300","file":"https://fonts.gstatic.com/s/poppins/v9/pxiByp8kv8JHgFVrLDz8V1tvFP-KUEg.ttf"},"regular":{"name":"regular","file":"https://fonts.gstatic.com/s/poppins/v9/pxiEyp8kv8JHgFVrFJDUc1NECPY.ttf"},"medium":{"name":"500","file":"https://fonts.gstatic.com/s/poppins/v9/pxiByp8kv8JHgFVrLGT9V1tvFP-KUEg.ttf"},"semi_bold":{"name":"600","file":"https://fonts.gstatic.com/s/poppins/v9/pxiByp8kv8JHgFVrLEj6V1tvFP-KUEg.ttf"},"bold":{"name":"700","file":"https://fonts.gstatic.com/s/poppins/v9/pxiByp8kv8JHgFVrLCz7V1tvFP-KUEg.ttf"}},"family":"Poppins"},"config":{"current":"Default","list":[{"name":"Default","global_config":{"static":{"props":{"colors":{"primary_color":"#000000","secondary_color":"#000000","accent_color":"#000000","link_color":"#4499FF","button_secondary_color":"#000000","bg_color":"#F8F8F8"},"auth":{"show_header_auth":false,"show_footer_auth":false},"palette":{"general_setting":{"theme":{"page_background":"#F3F3ED","theme_accent":"#E1D0C8"},"text":{"text_heading":"#26201A","text_body":"#3C3131","text_label":"#7D7676","text_secondary":"#9C9C9C"},"button":{"button_primary":"#4E3F09","button_secondary":"#FFFFFF","button_link":"#B1655B"},"sale_discount":{"sale_badge_background":"#FFFFFF","sale_badge_text":"#1C958F","sale_discount_text":"#1C958F","sale_timer":"#994449"},"header":{"header_background":"#F3F3ED","header_nav":"#261A1A","header_icon":"#261A1A"},"footer":{"footer_background":"#2C231E","footer_bottom_background":"#231812","footer_heading_text":"#FFFFFF","footer_body_text":"#FFFFFF","footer_icon":"#FFFFFF"}},"advance_setting":{"overlay_popup":{"dialog_backgroung":"#FFFFFF","overlay":"#14130E"},"divider_stroke_highlight":{"divider_strokes":"#D4D1D1","highlight":"#EDECE9"},"user_alerts":{"success_background":"#C2DBC9","success_text":"#1C958F","error_background":"#E6D5D5","error_text":"#B24141","info_background":"#EBD3BC","info_text":"#D28F51"}}},"extension":{"header_top":[],"header_bottom":[],"footer_top":[],"footer_bottom":[]}}},"custom":{"props":{"header_bg_color":"#ffffff","header_text_color":"#000000","header_border_color":"#e1e1e1","header_icon_color":"#000000","header_cart_notification_bg_color":"#e8a76c","header_cart_notification_text_color":"#ffffff","header_nav_hover_color":"#999999","button_primary_color":"#ffffff","button_primary_label_color":"#000000","button_add_to_cart_color":"#000000","button_add_to_cart_label_color":"#ffffff","button_secondary_color":"#000000","button_secondary_label_color":"#ffffff","button_tertiary_color":"#000000","button_tertiary_label_color":"#000000","button_tertiary_hover_color":"#000000","button_tertiary_hover_text_color":"#ffffff","text_heading_link_color":"#000000","text_body_color":"#000000","text_price_color":"#000000","text_sale_price_color":"#fb406b","text_strikethrough_price_color":"#9b9b9b","text_discount_color":"#ee478d","footer_bg_color":"#ffffff","footer_text_color":"#999999","footer_border_color":"#e1e1e1","footer_nav_hover_color":"#000000","disable_cart":false,"is_menu_below_logo":false,"menu_position":"left"}}},"page":[]},{"name":"Dark","global_config":{"static":{"props":{"colors":{"primary_color":"#000000","secondary_color":"#000000","accent_color":"#000000","link_color":"#4499FF","button_secondary_color":"#000000","bg_color":"#F8F8F8"},"auth":{"show_header_auth":false,"show_footer_auth":false},"palette":{"general_setting":{"theme":{"page_background":"#F3F3ED","theme_accent":"#E1D0C8"},"text":{"text_heading":"#26201A","text_body":"#3C3131","text_label":"#7D7676","text_secondary":"#9C9C9C"},"button":{"button_primary":"#4E3F09","button_secondary":"#FFFFFF","button_link":"#B1655B"},"sale_discount":{"sale_badge_background":"#FFFFFF","sale_badge_text":"#1C958F","sale_discount_text":"#1C958F","sale_timer":"#994449"},"header":{"header_background":"#F3F3ED","header_nav":"#261A1A","header_icon":"#261A1A"},"footer":{"footer_background":"#2C231E","footer_bottom_background":"#231812","footer_heading_text":"#FFFFFF","footer_body_text":"#FFFFFF","footer_icon":"#FFFFFF"}},"advance_setting":{"overlay_popup":{"dialog_backgroung":"#FFFFFF","overlay":"#14130E"},"divider_stroke_highlight":{"divider_strokes":"#D4D1D1","highlight":"#EDECE9"},"user_alerts":{"success_background":"#C2DBC9","success_text":"#1C958F","error_background":"#E6D5D5","error_text":"#B24141","info_background":"#EBD3BC","info_text":"#D28F51"}}},"extension":{"header_top":[],"header_bottom":[],"footer_top":[],"footer_bottom":[]}}},"custom":{"props":{"header_bg_color":"#2e3032","header_text_color":"#ffffff","header_border_color":"#FFFFFF","header_icon_color":"#ffffff","header_cart_notification_bg_color":"#FFFFFF","header_cart_notification_text_color":"#2e3032","header_nav_hover_color":"#000000","button_primary_color":"#000000","button_primary_label_color":"#ffffff","button_add_to_cart_color":"#000000","button_add_to_cart_label_color":"#ffffff","button_secondary_color":"#000000","button_secondary_label_color":"#ffffff","button_tertiary_color":"#000000","button_tertiary_label_color":"#000000","button_tertiary_hover_color":"#000000","button_tertiary_hover_text_color":"#ffffff","text_heading_link_color":"#000000","text_body_color":"#000000","text_price_color":"#000000","text_sale_price_color":"#fb406b","text_strikethrough_price_color":"#9b9b9b","text_discount_color":"#ee478d","footer_bg_color":"#2e3032","footer_text_color":"#ffffff","footer_border_color":"#FFFFFF","footer_nav_hover_color":"#ffffff"}}},"page":[]},{"name":"Blue","global_config":{"static":{"props":{"colors":{"primary_color":"#000000","secondary_color":"#000000","accent_color":"#000000","link_color":"#4499FF","button_secondary_color":"#000000","bg_color":"#F8F8F8"},"auth":{"show_header_auth":false,"show_footer_auth":false},"palette":{"general_setting":{"theme":{"page_background":"#F3F3ED","theme_accent":"#E1D0C8"},"text":{"text_heading":"#26201A","text_body":"#3C3131","text_label":"#7D7676","text_secondary":"#9C9C9C"},"button":{"button_primary":"#4E3F09","button_secondary":"#FFFFFF","button_link":"#B1655B"},"sale_discount":{"sale_badge_background":"#FFFFFF","sale_badge_text":"#1C958F","sale_discount_text":"#1C958F","sale_timer":"#994449"},"header":{"header_background":"#F3F3ED","header_nav":"#261A1A","header_icon":"#261A1A"},"footer":{"footer_background":"#2C231E","footer_bottom_background":"#231812","footer_heading_text":"#FFFFFF","footer_body_text":"#FFFFFF","footer_icon":"#FFFFFF"}},"advance_setting":{"overlay_popup":{"dialog_backgroung":"#FFFFFF","overlay":"#14130E"},"divider_stroke_highlight":{"divider_strokes":"#D4D1D1","highlight":"#EDECE9"},"user_alerts":{"success_background":"#C2DBC9","success_text":"#1C958F","error_background":"#E6D5D5","error_text":"#B24141","info_background":"#EBD3BC","info_text":"#D28F51"}}},"extension":{"header_top":[],"header_bottom":[],"footer_top":[],"footer_bottom":[]}}},"custom":{"props":{"header_bg_color":"#7f9ed0","header_text_color":"#FFFFFF","header_border_color":"#FFFFFF","header_icon_color":"#FFFFFF","header_cart_notification_bg_color":"#2e3032","header_cart_notification_text_color":"#FFFFFF","header_nav_hover_color":"#2e3032","button_primary_color":"#ffffff","button_primary_label_color":"#000000","button_add_to_cart_color":"#000000","button_add_to_cart_label_color":"#ffffff","button_secondary_color":"#000000","button_secondary_label_color":"#ffffff","button_tertiary_color":"#000000","button_tertiary_label_color":"#000000","button_tertiary_hover_color":"#000000","button_tertiary_hover_text_color":"#ffffff","text_heading_link_color":"#000000","text_body_color":"#000000","text_price_color":"#000000","text_sale_price_color":"#fb406b","text_strikethrough_price_color":"#9b9b9b","text_discount_color":"#ee478d","footer_bg_color":"#7f9ed0","footer_text_color":"#FFFFFF","footer_border_color":"#FFFFFF","footer_nav_hover_color":"#2e3032"}}},"page":[]}],"preset":{"pages":[{"sections":[{"blocks":[],"predicate":{"screen":{"mobile":true,"desktop":true,"tablet":true},"user":{"authenticated":true,"anonymous":true},"route":{"selected":"none","exact_url":""}},"name":"hero_image","props":{"image":{"value":"","type":"image_picker"},"overlay_layout":{"type":"select","value":"center"},"overlay_image":{"value":"","type":"image_picker"},"overlay_text":{"value":"","type":"text"},"text_color":{"value":"#000","type":"color"},"button_link":{"type":"url","value":""},"button_text":{"value":"Shop Now","type":"text"},"full_width":{"value":true,"type":"checkbox"}}},{"blocks":[],"predicate":{"screen":{"mobile":true,"desktop":true,"tablet":true},"user":{"authenticated":true,"anonymous":true},"route":{"selected":"none","exact_url":""}},"name":"image_slideshow","props":{"autoplay":{"value":false,"type":"checkbox"},"full_width":{"value":false,"type":"checkbox"},"slide_height":{"value":"adapt","type":"select"},"slide_interval":{"value":2,"type":"range"},"title":{"value":"Trending","type":"text"}},"preset":{"blocks":[{"name":"Slide"},{"name":"Slide"},{"name":"Slide"}]}},{"blocks":[{"type":"gallery_image","name":"Image","props":{"image":{"type":"image_picker","value":""},"caption":{"type":"text","value":""},"link":{"type":"url","value":""}}},{"type":"gallery_image","name":"Image","props":{"image":{"type":"image_picker","value":""},"caption":{"type":"text","value":""},"link":{"type":"url","value":""}}},{"type":"gallery_image","name":"Image","props":{"image":{"type":"image_picker","value":""},"caption":{"type":"text","value":""},"link":{"type":"url","value":""}}},{"type":"gallery_image","name":"Image","props":{"image":{"type":"image_picker","value":""},"caption":{"type":"text","value":""},"link":{"type":"url","value":""}}}],"predicate":{"screen":{"mobile":true,"desktop":true,"tablet":true},"user":{"authenticated":true,"anonymous":true},"route":{"selected":"none","exact_url":""}},"name":"image_gallery","props":{"title":{"type":"text","value":"Popular Brands"},"layout":{"value":"grid","type":"select"},"item_count":{"value":4,"type":"range"},"cta_text":{"value":"","type":"text"},"cta_link":{"type":"url","value":""},"full_width":{"value":false,"type":"checkbox"}},"preset":{"blocks":[{"name":"Image"},{"name":"Image"},{"name":"Image"},{"name":"Image"}]}},{"blocks":[],"predicate":{"screen":{"mobile":true,"desktop":true,"tablet":true},"user":{"authenticated":true,"anonymous":true},"route":{"selected":"none","exact_url":""}},"name":"brands_listing","props":{"brand_type":{"value":"all","type":"radio"},"cta_text":{"value":"View all","type":"text"},"department":{"type":"department"},"header":{"type":"header"},"items_per_row":{"value":5,"type":"range"},"layout":{"value":"horizontal","type":"select"},"title":{"type":"text","value":"Brands"},"view_options":{"value":"fullview","type":"select"}}},{"blocks":[{"type":"testimonial","name":"Testimonial","props":{"testimonialText":{"type":"textarea","value":""},"author_name":{"type":"text"},"author_description":{"type":"text","value":""},"author_image":{"type":"image_picker","value":""}}},{"type":"testimonial","name":"Testimonial","props":{"testimonialText":{"type":"textarea","value":""},"author_name":{"type":"text"},"author_description":{"type":"text","value":""},"author_image":{"type":"image_picker","value":""}}},{"type":"testimonial","name":"Testimonial","props":{"testimonialText":{"type":"textarea","value":""},"author_name":{"type":"text"},"author_description":{"type":"text","value":""},"author_image":{"type":"image_picker","value":""}}}],"predicate":{"screen":{"mobile":true,"desktop":true,"tablet":true},"user":{"authenticated":true,"anonymous":true},"route":{"selected":"none","exact_url":""}},"name":"testimonials","props":{"autoplay":{"value":false,"type":"checkbox"},"slide_interval":{"value":2,"type":"range"}},"preset":{"blocks":[{"name":"Testimonial"},{"name":"Testimonial"},{"name":"Testimonial"}]}}],"value":"home"}]},"global_schema":{"props":[{"type":"checkbox","id":"disable_cart","category":"Colors","label":"header"}]}},"available_sections":[{"props":[{"type":"url","id":"banner_link","label":"Redirect Link"},{"type":"checkbox","id":"full_width","label":"Full width","info":"Check to allow items to take entire width of the viewport"},{"type":"range","id":"margin_top","min":0,"max":1000,"step":1,"unit":"px","label":"Section Top Margin"},{"type":"range","id":"margin_bottom","min":0,"max":1000,"step":1,"unit":"px","label":"Section Bottom Margin"}],"blocks":[],"name":"application_banner","label":"Application Banner"},{"props":[{"type":"text","id":"title","label":"Title"},{"type":"range","id":"margin_top","min":0,"max":1000,"step":1,"unit":"px","label":"Section Top Margin"},{"type":"range","id":"margin_bottom","min":0,"max":1000,"step":1,"unit":"px","label":"Section Bottom Margin"},{"type":"header","id":"header","value":"Choose Brands to Show"},{"id":"view_options","type":"select","options":[{"value":"logo","text":"Logo View"},{"value":"fullview","text":"Logo and Banner View"}],"label":"View Options","info":"Brand card view options"},{"type":"radio","id":"brand_type","options":[{"value":"all","text":"All"},{"value":"department","text":"Department"},{"value":"handpicked","text":"Handpicked"}]},{"type":"department","id":"department","label":"Department","info":"Select a department of brands","note":"Department only applies if 'department' type is selected"},{"type":"range","id":"items_per_row","min":3,"max":5,"step":1,"unit":"","label":"Items per row","info":"Maximum items allowed per row"},{"id":"layout","type":"select","options":[{"value":"grid","text":"Grid View"},{"value":"horizontal","text":"Horizontal View"}],"label":"Layout","info":"Alignment of content"},{"type":"text","id":"cta_text","label":"CTA Text"}],"blocks":[{"type":"brand_item","name":"Brand Item","props":[{"type":"brand","id":"brand","label":"Select Brand"}]}],"name":"brands_listing","label":"Brands Listing"},{"props":[{"type":"text","id":"title","label":"Title"},{"type":"range","id":"margin_top","min":0,"max":1000,"step":1,"unit":"px","label":"Section Top Margin"},{"type":"range","id":"margin_bottom","min":0,"max":1000,"step":1,"unit":"px","label":"Section Bottom Margin"},{"type":"radio","id":"collection_type","options":[{"value":"all","text":"All"},{"value":"handpicked","text":"Handpicked"}]},{"type":"text","id":"tags_filter","label":"Filter by tags","info":"Filter by Tags "},{"type":"range","id":"items_per_row","min":3,"max":5,"step":1,"unit":"","label":"Max items per row","info":"Maximum items allowed per row"},{"id":"layout","type":"select","options":[{"value":"grid","text":"Grid View"},{"value":"horizontal","text":"Horizontal View"}],"label":"Layout","info":"Alignment of content"},{"type":"text","id":"cta_text","label":"CTA Text"}],"blocks":[{"type":"collection-item","name":"collection Item","props":[{"type":"collection","id":"collection","label":"Select Collection"}]}],"name":"collections_listing","label":"Collections Listing"},{"props":[{"type":"code","id":"code","label":"Custom HTML","info":"Add Your custom HTML Code below. You can also use the full screen icon to open a code editor and add your code"},{"type":"range","id":"margin_top","min":0,"max":1000,"step":1,"unit":"px","label":"Section Top Margin"},{"type":"range","id":"margin_bottom","min":0,"max":1000,"step":1,"unit":"px","label":"Section Bottom Margin"}],"blocks":[],"name":"custom_html","label":"Custom HTML"},{"props":[{"type":"extension","id":"extension","label":"Extension Positions","info":"Handle extension in these positions","positions":[{"value":"section_extension","text":""}]},{"type":"range","id":"margin_top","min":0,"max":1000,"step":1,"unit":"px","label":"Section Top Margin"},{"type":"range","id":"margin_bottom","min":0,"max":1000,"step":1,"unit":"px","label":"Section Bottom Margin"}],"blocks":[],"name":"section_extension","label":"Extensions"},{"props":[{"type":"text","id":"title","label":"Title"},{"type":"range","id":"margin_top","min":0,"max":1000,"step":1,"unit":"px","label":"Section Top Margin"},{"type":"range","id":"margin_bottom","min":0,"max":1000,"step":1,"unit":"px","label":"Section Bottom Margin"},{"type":"collection","id":"collection","label":"Collection","info":"Select a collection to display its products"},{"type":"range","id":"items_per_row","min":2,"max":5,"step":1,"unit":"","label":"Products per row","info":"Maximum items allowed per row"},{"id":"layout","type":"select","options":[{"value":"grid","text":"Grid View"},{"value":"horizontal","text":"Horizontal View"}],"label":"Layout","info":"Alignment of content"},{"type":"checkbox","id":"autoplay","label":"AutoPlay Slides","info":"Check to autoplay slides"},{"type":"range","id":"slide_interval","min":1,"max":10,"step":1,"unit":"sec","label":"Change slides after every","info":"Autoplay slide duration"}],"blocks":[],"name":"featured_collection","label":"Featured Collection"},{"props":[{"id":"image","type":"image_picker","label":"Hero Image"},{"type":"range","id":"margin_top","min":0,"max":1000,"step":1,"unit":"px","label":"Section Top Margin"},{"type":"range","id":"margin_bottom","min":0,"max":1000,"step":1,"unit":"px","label":"Section Bottom Margin"},{"id":"overlay_layout","type":"select","options":[{"value":"left","text":"Align Left"},{"value":"center","text":"Align Center"},{"value":"right","text":"Align Right"}],"label":"Overlay Layout","info":"Alignment of overlay content"},{"type":"image_picker","id":"overlay_image","label":"Overlay image","info":"Overlay Image"},{"type":"text","id":"overlay_text","label":"Overlay Text"},{"type":"color","id":"text_color","label":"Text Color"},{"type":"url","id":"button_link","label":"Redirect Link"},{"type":"text","id":"button_text","label":"Button Text"},{"type":"checkbox","id":"full_width","label":"Full width","info":"Check to allow items to take entire width of the viewport"},{"type":"checkbox","id":"fullscreen_image","label":"Fullscreen Banner ","info":"Check to allow items to take entire viewport"}],"blocks":[],"name":"hero_image","label":"Hero Image"},{"props":[{"type":"video","id":"videoFile","label":"Primary Video"},{"id":"videoUrl","type":"text","label":"Video URL","info":"Supports MP4 Video & Youtube Video URL"},{"type":"checkbox","id":"autoplay","label":"Autoplay","info":"Check to enable autoplay (Video will be muted if autoplay is active)"},{"type":"checkbox","id":"hidecontrols","label":"Hide Video Controls","info":"check to disable video controls"},{"type":"checkbox","id":"showloop","label":"Play Video in Loop","info":"check to disable Loop"},{"type":"text","id":"title","label":"Heading"},{"id":"coverUrl","type":"image_picker","label":"Thumbnail Image"}],"blocks":[],"name":"hero_video-v2","label":"Hero Video V2"},{"props":[{"id":"video_url","type":"text","label":"Video URL","info":"Supports MP4 Video & Youtube Video URL"},{"type":"range","id":"margin_top","min":0,"max":1000,"step":1,"unit":"px","label":"Section Top Margin"},{"type":"range","id":"margin_bottom","min":0,"max":1000,"step":1,"unit":"px","label":"Section Bottom Margin"},{"type":"checkbox","id":"autoplay","label":"Autoplay","info":"Check to enable autoplay (Video will be muted if autoplay is active)"},{"type":"checkbox","id":"controls","label":"Video Controls","info":"Uncheck to disable video controls"},{"type":"checkbox","id":"full_width","label":"Full width","info":"Check to allow items to take entire width of the viewport"},{"type":"checkbox","id":"bg_video","label":"Video In Background","info":"Use video in background with overlay (Overlay Image & Video Controls will be disabled by default on website)"},{"type":"select","id":"size","options":[{"value":"small","text":"Small"},{"value":"medium","text":"Medium"},{"value":"large","text":"Large"},{"value":"adapt","text":"Adapt"},{"value":"fullscreen","text":"Fullscreen"}],"label":"Video Height","info":"Height of Video"},{"type":"checkbox","id":"enable_overlay_image","label":"Enable Overlay Image"},{"id":"cover_url","type":"image_picker","label":"Video Overlay Image"},{"type":"checkbox","id":"enable_overlay_color","label":"Enable Overlay Colour"},{"type":"color","id":"overlay_color","label":"Overlay Color"},{"type":"range","id":"overlay_opacity","min":0,"max":1,"step":0.1,"unit":"","label":"Overlay Opacity"},{"type":"select","id":"overlay_size","options":[{"value":"container","text":"Container (Default)"},{"value":"content","text":"Content"}],"label":"Overlay Size"},{"id":"overlay_position","type":"select","options":[{"value":"top-left","text":"Top Left"},{"value":"top-center","text":"Top Center"},{"value":"top-right","text":"Top Right"},{"value":"center-left","text":"Center Left"},{"value":"center-center","text":"Center (Default)"},{"value":"center-right","text":"Center Right"},{"value":"bottom-left","text":"Bottom Left"},{"value":"bottom-center","text":"Bottom Center"},{"value":"bottom-right","text":"Bottom right"}],"label":"Overlay position","info":"Alignment of Overlay content(heading, sub-heading, button)"},{"type":"text","id":"heading","label":"Heading"},{"type":"color","id":"heading_color","label":"Heading Text Color"},{"type":"text","id":"sub_heading","label":"Sub-heading"},{"type":"color","id":"sub_heading_color","label":"Sub-heading Text Color"},{"type":"url","id":"button_link","label":"Redirect Link"},{"type":"text","id":"button_text","label":"Button Text"}],"blocks":[],"name":"hero_video","label":"Hero Video"},{"props":[{"type":"text","id":"title","label":"Title"},{"type":"range","id":"margin_top","min":0,"max":1000,"step":1,"unit":"px","label":"Section Top Margin"},{"type":"range","id":"margin_bottom","min":0,"max":1000,"step":1,"unit":"px","label":"Section Bottom Margin"},{"id":"layout","type":"select","options":[{"value":"grid","text":"Grid View"},{"value":"horizontal","text":"Horizontal View"}],"label":"Layout","info":"Alignment of content"},{"type":"range","id":"item_count","min":3,"max":4,"step":1,"unit":"","label":"No of items","info":"Maximum items allowed per row for Horizontal view, for gallery max 5 are viewable and only 5 blocks are required"},{"type":"text","id":"cta_text","label":"CTA Text"},{"type":"url","id":"cta_link","label":"CTA Link","info":"Link to redirect"},{"type":"checkbox","id":"full_width","label":"Full width","info":"Check to allow items to take entire width of the viewport"}],"blocks":[{"type":"gallery_image","name":"Image","props":[{"type":"image_picker","id":"image","label":"Gallery Image"},{"type":"text","id":"caption","label":"Image Caption"},{"type":"url","id":"link","label":"Link","info":"Link to redirect"}]}],"name":"image_gallery","label":"Image Gallery","preset":{"blocks":[{"name":"Image"},{"name":"Image"},{"name":"Image"},{"name":"Image"}]}},{"props":[{"type":"text","id":"title","label":"Title"},{"type":"range","id":"margin_top","min":0,"max":1000,"step":1,"unit":"px","label":"Section Top Margin"},{"type":"range","id":"margin_bottom","min":0,"max":1000,"step":1,"unit":"px","label":"Section Bottom Margin"},{"type":"checkbox","id":"autoplay","label":"AutoPlay Slides","info":"Check to autoplay slides"},{"type":"range","id":"slide_interval","min":1,"max":10,"step":1,"unit":"sec","label":"Change slides after every","info":"Autoplay slide duration"},{"type":"select","id":"slide_height","options":[{"value":"adapt","text":"Adapt to first image"},{"value":"small","text":"Small"},{"value":"medium","text":"Medium"},{"value":"large","text":"Large"}],"label":"Slide height","info":"Size of the slide"},{"type":"checkbox","id":"full_width","label":"Full width","info":"Check to allow items to take entire width of the viewport"}],"blocks":[{"type":"image_slide","name":"Slide","props":[{"type":"image_picker","id":"image","label":"Image"},{"type":"url","id":"slide_link","label":"Slide Link"}]}],"name":"image_slideshow","label":"Image Slideshow","preset":{"blocks":[{"name":"Slide"},{"name":"Slide"},{"name":"Slide"}]}},{"props":[{"type":"image_picker","id":"image","label":"Image"},{"id":"video","type":"url","label":"Video"},{"type":"range","id":"margin_top","min":0,"max":1000,"step":1,"unit":"px","label":"Section Top Margin"},{"type":"range","id":"margin_bottom","min":0,"max":1000,"step":1,"unit":"px","label":"Section Bottom Margin"},{"id":"cover","type":"url","label":"Video Cover Image"},{"type":"select","id":"media_alignment","options":[{"value":"left","text":"Left"},{"value":"center","text":"Center"},{"value":"right","text":"Right"}],"label":"Media Alignment"},{"type":"text","id":"heading","label":"Heading"},{"type":"text","id":"text Pair large text with an image to give focus to your chosen product, collection, or blog post. Add details on availability, style, or even provide a review.","label":"Text"},{"type":"select","id":"text_alignment","options":[{"value":"left","text":"Left"},{"value":"center","text":"Center"},{"value":"right","text":"Right"}],"label":"Text Alignment"}],"blocks":[],"name":"media_with_text","label":"Media with text"},{"props":[{"type":"text","id":"title","label":"Title"},{"type":"range","id":"margin_top","min":0,"max":1000,"step":1,"unit":"px","label":"Section Top Margin"},{"type":"range","id":"margin_bottom","min":0,"max":1000,"step":1,"unit":"px","label":"Section Bottom Margin"},{"type":"checkbox","id":"autoplay","label":"AutoPlay Slides"},{"type":"range","id":"slide_interval","min":1,"max":10,"step":1,"unit":"sec","label":"Change slides every"}],"blocks":[{"type":"testimonial","name":"Testimonial","props":[{"type":"textarea","id":"testimonialText","label":"Text for Testimonial","info":"Text for testimonial","placeholder":"Text"},{"type":"text","id":"author_name","label":"Author name"},{"type":"text","id":"author_description","label":"Author Description"},{"type":"image_picker","id":"author_image","label":"Author Image"}]}],"name":"testimonials","label":"Testimonial","preset":{"blocks":[{"name":"Testimonial"},{"name":"Testimonial"},{"name":"Testimonial"}]}}],"src":"https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/organization/64b0eb01c35f990518880a82/theme/assets/7yuL57qP2-archive.zip","company_id":1}]},"ThemesExample2":{"value":[{"_id":"64b91fe317422a1e1392f85b","applied":true,"is_private":true,"tags":[],"name":"Astra","version":"1.0.11","application_id":"7487ea376e1442284917c44e","styles":{},"template_theme_id":"64be264c0347c5002279b75f","created_at":"2023-07-24T07:20:44.629Z","updated_at":"2023-08-01T11:09:25.857Z","theme_type":"vue2","assets":{"umd_js":{"links":["https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/organization/64aec4634bc407961ed265c5/theme/assets/O3s2Kmnsc_themeBundle.umd.min.9.js","https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/organization/64aec4634bc407961ed265c5/theme/assets/O3s2Kmnsc_themeBundle.umd.min.cart.js","https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/organization/64aec4634bc407961ed265c5/theme/assets/O3s2Kmnsc_themeBundle.umd.min.extras.js","https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/organization/64aec4634bc407961ed265c5/theme/assets/O3s2Kmnsc_themeBundle.umd.min.products-listing_profile.js","https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/organization/64aec4634bc407961ed265c5/theme/assets/O3s2Kmnsc_themeBundle.umd.min.products-listing.js","https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/organization/64aec4634bc407961ed265c5/theme/assets/O3s2Kmnsc_themeBundle.umd.min.products.js","https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/organization/64aec4634bc407961ed265c5/theme/assets/O3s2Kmnsc_themeBundle.umd.min.profile.js","https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/organization/64aec4634bc407961ed265c5/theme/assets/O3s2Kmnsc_themeBundle.umd.min.vendors_products-listing.js","https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/organization/64aec4634bc407961ed265c5/theme/assets/O3s2Kmnsc_themeBundle.umd.min.vendors_products.js","https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/organization/64aec4634bc407961ed265c5/theme/assets/O3s2Kmnsc_themeBundle.umd.min.js"],"link":""},"common_js":{"link":"https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/organization/64aec4634bc407961ed265c5/theme/assets/O3s2Kmnsc_themeBundle.common.js"},"css":{"links":["https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/organization/64aec4634bc407961ed265c5/theme/assets/O3s2Kmnsc_extras.8604b743eb82cd74e4bb.css","https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/organization/64aec4634bc407961ed265c5/theme/assets/O3s2Kmnsc_products-listing_profile.944723408675f52ed297.css","https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/organization/64aec4634bc407961ed265c5/theme/assets/O3s2Kmnsc_products-listing.ca493ea7d081b4b575f7.css","https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/organization/64aec4634bc407961ed265c5/theme/assets/O3s2Kmnsc_products.2c64f7731dab64227f0b.css","https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/organization/64aec4634bc407961ed265c5/theme/assets/O3s2Kmnsc_profile.1b1467735927e188d272.css","https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/organization/64aec4634bc407961ed265c5/theme/assets/O3s2Kmnsc_themeBundle.css","https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/organization/64aec4634bc407961ed265c5/theme/assets/O3s2Kmnsc_vendors_products-listing.c8fe85761d60286348e3.css"],"link":""}},"font":{"variants":{"light":{"name":"300","file":"https://fonts.gstatic.com/s/poppins/v20/pxiByp8kv8JHgFVrLDz8V1tvFP-KUEg.ttf"},"regular":{"name":"regular","file":"https://fonts.gstatic.com/s/poppins/v20/pxiEyp8kv8JHgFVrFJDUc1NECPY.ttf"},"medium":{"name":"500","file":"https://fonts.gstatic.com/s/poppins/v20/pxiByp8kv8JHgFVrLGT9V1tvFP-KUEg.ttf"},"semi_bold":{"name":"600","file":"https://fonts.gstatic.com/s/poppins/v20/pxiByp8kv8JHgFVrLEj6V1tvFP-KUEg.ttf"},"bold":{"name":"700","file":"https://fonts.gstatic.com/s/poppins/v20/pxiByp8kv8JHgFVrLCz7V1tvFP-KUEg.ttf"}},"family":"Poppins"},"config":{"current":"Default","list":[{"name":"Default","global_config":{"static":{"props":{"colors":{"primary_color":"#000000","secondary_color":"#000000","accent_color":"#000000","link_color":"#4499FF","button_secondary_color":"#000000","bg_color":"#F8F8F8"},"auth":{"show_header_auth":false,"show_footer_auth":false},"palette":{"general_setting":{"theme":{"page_background":"#F3F3ED","theme_accent":"#E1D0C8"},"text":{"text_heading":"#26201A","text_body":"#3C3131","text_label":"#7D7676","text_secondary":"#9C9C9C"},"button":{"button_primary":"#4E3F09","button_secondary":"#FFFFFF","button_link":"#B1655B"},"sale_discount":{"sale_badge_background":"#FFFFFF","sale_badge_text":"#1C958F","sale_discount_text":"#1C958F","sale_timer":"#994449"},"header":{"header_background":"#F3F3ED","header_nav":"#261A1A","header_icon":"#261A1A"},"footer":{"footer_background":"#2C231E","footer_bottom_background":"#231812","footer_heading_text":"#FFFFFF","footer_body_text":"#FFFFFF","footer_icon":"#FFFFFF"}},"advance_setting":{"overlay_popup":{"dialog_backgroung":"#FFFFFF","overlay":"#14130E"},"divider_stroke_highlight":{"divider_strokes":"#D4D1D1","highlight":"#EDECE9"},"user_alerts":{"success_background":"#C2DBC9","success_text":"#1C958F","error_background":"#E6D5D5","error_text":"#B24141","info_background":"#EBD3BC","info_text":"#D28F51"}}},"extension":{"header_top":[],"header_bottom":[],"footer_top":[],"footer_bottom":[]}}},"custom":{"props":{"header_bg_color":"#ffffff","header_text_color":"#000000","header_border_color":"#e1e1e1","header_icon_color":"#000000","header_cart_notification_bg_color":"#e8a76c","header_cart_notification_text_color":"#ffffff","header_nav_hover_color":"#999999","button_primary_color":"#ffffff","button_primary_label_color":"#000000","button_add_to_cart_color":"#000000","button_add_to_cart_label_color":"#ffffff","button_secondary_color":"#000000","button_secondary_label_color":"#ffffff","button_tertiary_color":"#000000","button_tertiary_label_color":"#000000","button_tertiary_hover_color":"#000000","button_tertiary_hover_text_color":"#ffffff","text_heading_link_color":"#000000","text_body_color":"#000000","text_price_color":"#000000","text_sale_price_color":"#fb406b","text_strikethrough_price_color":"#9b9b9b","text_discount_color":"#ee478d","footer_bg_color":"#ffffff","footer_text_color":"#999999","footer_border_color":"#e1e1e1","footer_nav_hover_color":"#000000","disable_cart":false,"is_menu_below_logo":false,"menu_position":"left"}}},"page":[]},{"name":"Dark","global_config":{"static":{"props":{"colors":{"primary_color":"#000000","secondary_color":"#000000","accent_color":"#000000","link_color":"#4499FF","button_secondary_color":"#000000","bg_color":"#F8F8F8"},"auth":{"show_header_auth":false,"show_footer_auth":false},"palette":{"general_setting":{"theme":{"page_background":"#F3F3ED","theme_accent":"#E1D0C8"},"text":{"text_heading":"#26201A","text_body":"#3C3131","text_label":"#7D7676","text_secondary":"#9C9C9C"},"button":{"button_primary":"#4E3F09","button_secondary":"#FFFFFF","button_link":"#B1655B"},"sale_discount":{"sale_badge_background":"#FFFFFF","sale_badge_text":"#1C958F","sale_discount_text":"#1C958F","sale_timer":"#994449"},"header":{"header_background":"#F3F3ED","header_nav":"#261A1A","header_icon":"#261A1A"},"footer":{"footer_background":"#2C231E","footer_bottom_background":"#231812","footer_heading_text":"#FFFFFF","footer_body_text":"#FFFFFF","footer_icon":"#FFFFFF"}},"advance_setting":{"overlay_popup":{"dialog_backgroung":"#FFFFFF","overlay":"#14130E"},"divider_stroke_highlight":{"divider_strokes":"#D4D1D1","highlight":"#EDECE9"},"user_alerts":{"success_background":"#C2DBC9","success_text":"#1C958F","error_background":"#E6D5D5","error_text":"#B24141","info_background":"#EBD3BC","info_text":"#D28F51"}}},"extension":{"header_top":[],"header_bottom":[],"footer_top":[],"footer_bottom":[]}}},"custom":{"props":{"header_bg_color":"#2e3032","header_text_color":"#ffffff","header_border_color":"#FFFFFF","header_icon_color":"#ffffff","header_cart_notification_bg_color":"#FFFFFF","header_cart_notification_text_color":"#2e3032","header_nav_hover_color":"#000000","button_primary_color":"#000000","button_primary_label_color":"#ffffff","button_add_to_cart_color":"#000000","button_add_to_cart_label_color":"#ffffff","button_secondary_color":"#000000","button_secondary_label_color":"#ffffff","button_tertiary_color":"#000000","button_tertiary_label_color":"#000000","button_tertiary_hover_color":"#000000","button_tertiary_hover_text_color":"#ffffff","text_heading_link_color":"#000000","text_body_color":"#000000","text_price_color":"#000000","text_sale_price_color":"#fb406b","text_strikethrough_price_color":"#9b9b9b","text_discount_color":"#ee478d","footer_bg_color":"#2e3032","footer_text_color":"#ffffff","footer_border_color":"#FFFFFF","footer_nav_hover_color":"#ffffff"}}},"page":[]},{"name":"Blue","global_config":{"static":{"props":{"colors":{"primary_color":"#000000","secondary_color":"#000000","accent_color":"#000000","link_color":"#4499FF","button_secondary_color":"#000000","bg_color":"#F8F8F8"},"auth":{"show_header_auth":false,"show_footer_auth":false},"palette":{"general_setting":{"theme":{"page_background":"#F3F3ED","theme_accent":"#E1D0C8"},"text":{"text_heading":"#26201A","text_body":"#3C3131","text_label":"#7D7676","text_secondary":"#9C9C9C"},"button":{"button_primary":"#4E3F09","button_secondary":"#FFFFFF","button_link":"#B1655B"},"sale_discount":{"sale_badge_background":"#FFFFFF","sale_badge_text":"#1C958F","sale_discount_text":"#1C958F","sale_timer":"#994449"},"header":{"header_background":"#F3F3ED","header_nav":"#261A1A","header_icon":"#261A1A"},"footer":{"footer_background":"#2C231E","footer_bottom_background":"#231812","footer_heading_text":"#FFFFFF","footer_body_text":"#FFFFFF","footer_icon":"#FFFFFF"}},"advance_setting":{"overlay_popup":{"dialog_backgroung":"#FFFFFF","overlay":"#14130E"},"divider_stroke_highlight":{"divider_strokes":"#D4D1D1","highlight":"#EDECE9"},"user_alerts":{"success_background":"#C2DBC9","success_text":"#1C958F","error_background":"#E6D5D5","error_text":"#B24141","info_background":"#EBD3BC","info_text":"#D28F51"}}},"extension":{"header_top":[],"header_bottom":[],"footer_top":[],"footer_bottom":[]}}},"custom":{"props":{"header_bg_color":"#7f9ed0","header_text_color":"#FFFFFF","header_border_color":"#FFFFFF","header_icon_color":"#FFFFFF","header_cart_notification_bg_color":"#2e3032","header_cart_notification_text_color":"#FFFFFF","header_nav_hover_color":"#2e3032","button_primary_color":"#ffffff","button_primary_label_color":"#000000","button_add_to_cart_color":"#000000","button_add_to_cart_label_color":"#ffffff","button_secondary_color":"#000000","button_secondary_label_color":"#ffffff","button_tertiary_color":"#000000","button_tertiary_label_color":"#000000","button_tertiary_hover_color":"#000000","button_tertiary_hover_text_color":"#ffffff","text_heading_link_color":"#000000","text_body_color":"#000000","text_price_color":"#000000","text_sale_price_color":"#fb406b","text_strikethrough_price_color":"#9b9b9b","text_discount_color":"#ee478d","footer_bg_color":"#7f9ed0","footer_text_color":"#FFFFFF","footer_border_color":"#FFFFFF","footer_nav_hover_color":"#2e3032"}}},"page":[]}],"preset":{"pages":[{"sections":[{"blocks":[],"predicate":{"screen":{"mobile":true,"desktop":true,"tablet":true},"user":{"authenticated":true,"anonymous":true},"route":{"selected":"none","exact_url":""}},"name":"hero_image","props":{"image":{"value":"","type":"image_picker"},"overlay_layout":{"type":"select","value":"center"},"overlay_image":{"value":"","type":"image_picker"},"overlay_text":{"value":"","type":"text"},"text_color":{"value":"#000","type":"color"},"button_link":{"type":"url","value":""},"button_text":{"value":"Shop Now","type":"text"},"full_width":{"value":true,"type":"checkbox"}}},{"blocks":[],"predicate":{"screen":{"mobile":true,"desktop":true,"tablet":true},"user":{"authenticated":true,"anonymous":true},"route":{"selected":"none","exact_url":""}},"name":"image_slideshow","props":{"autoplay":{"value":false,"type":"checkbox"},"full_width":{"value":false,"type":"checkbox"},"slide_height":{"value":"adapt","type":"select"},"slide_interval":{"value":2,"type":"range"},"title":{"value":"Trending","type":"text"}},"preset":{"blocks":[{"name":"Slide"},{"name":"Slide"},{"name":"Slide"}]}},{"blocks":[{"type":"gallery_image","name":"Image","props":{"image":{"type":"image_picker","value":""},"caption":{"type":"text","value":""},"link":{"type":"url","value":""}}},{"type":"gallery_image","name":"Image","props":{"image":{"type":"image_picker","value":""},"caption":{"type":"text","value":""},"link":{"type":"url","value":""}}},{"type":"gallery_image","name":"Image","props":{"image":{"type":"image_picker","value":""},"caption":{"type":"text","value":""},"link":{"type":"url","value":""}}},{"type":"gallery_image","name":"Image","props":{"image":{"type":"image_picker","value":""},"caption":{"type":"text","value":""},"link":{"type":"url","value":""}}}],"predicate":{"screen":{"mobile":true,"desktop":true,"tablet":true},"user":{"authenticated":true,"anonymous":true},"route":{"selected":"none","exact_url":""}},"name":"image_gallery","props":{"title":{"type":"text","value":"Popular Brands"},"layout":{"value":"grid","type":"select"},"item_count":{"value":4,"type":"range"},"cta_text":{"value":"","type":"text"},"cta_link":{"type":"url","value":""},"full_width":{"value":false,"type":"checkbox"}},"preset":{"blocks":[{"name":"Image"},{"name":"Image"},{"name":"Image"},{"name":"Image"}]}},{"blocks":[],"predicate":{"screen":{"mobile":true,"desktop":true,"tablet":true},"user":{"authenticated":true,"anonymous":true},"route":{"selected":"none","exact_url":""}},"name":"brands_listing","props":{"brand_type":{"value":"all","type":"radio"},"cta_text":{"value":"View all","type":"text"},"department":{"type":"department"},"header":{"type":"header"},"items_per_row":{"value":5,"type":"range"},"layout":{"value":"horizontal","type":"select"},"title":{"type":"text","value":"Brands"},"view_options":{"value":"fullview","type":"select"}}},{"blocks":[{"type":"testimonial","name":"Testimonial","props":{"testimonialText":{"type":"textarea","value":""},"author_name":{"type":"text"},"author_description":{"type":"text","value":""},"author_image":{"type":"image_picker","value":""}}},{"type":"testimonial","name":"Testimonial","props":{"testimonialText":{"type":"textarea","value":""},"author_name":{"type":"text"},"author_description":{"type":"text","value":""},"author_image":{"type":"image_picker","value":""}}},{"type":"testimonial","name":"Testimonial","props":{"testimonialText":{"type":"textarea","value":""},"author_name":{"type":"text"},"author_description":{"type":"text","value":""},"author_image":{"type":"image_picker","value":""}}}],"predicate":{"screen":{"mobile":true,"desktop":true,"tablet":true},"user":{"authenticated":true,"anonymous":true},"route":{"selected":"none","exact_url":""}},"name":"testimonials","props":{"autoplay":{"value":false,"type":"checkbox"},"slide_interval":{"value":2,"type":"range"}},"preset":{"blocks":[{"name":"Testimonial"},{"name":"Testimonial"},{"name":"Testimonial"}]}}],"value":"home"}]},"global_schema":{"props":[{"type":"checkbox","id":"disable_cart","category":"Colors","label":"header"}]}},"available_sections":[{"props":[{"type":"url","id":"banner_link","label":"Redirect Link"},{"type":"checkbox","id":"full_width","label":"Full width","info":"Check to allow items to take entire width of the viewport"},{"type":"range","id":"margin_top","min":0,"max":1000,"step":1,"unit":"px","label":"Section Top Margin"},{"type":"range","id":"margin_bottom","min":0,"max":1000,"step":1,"unit":"px","label":"Section Bottom Margin"}],"blocks":[],"name":"application_banner","label":"Application Banner"},{"props":[{"type":"text","id":"title","label":"Title"},{"type":"range","id":"margin_top","min":0,"max":1000,"step":1,"unit":"px","label":"Section Top Margin"},{"type":"range","id":"margin_bottom","min":0,"max":1000,"step":1,"unit":"px","label":"Section Bottom Margin"},{"type":"header","id":"header","value":"Choose Brands to Show"},{"id":"view_options","type":"select","options":[{"value":"logo","text":"Logo View"},{"value":"fullview","text":"Logo and Banner View"}],"label":"View Options","info":"Brand card view options"},{"type":"radio","id":"brand_type","options":[{"value":"all","text":"All"},{"value":"department","text":"Department"},{"value":"handpicked","text":"Handpicked"}]},{"type":"department","id":"department","label":"Department","info":"Select a department of brands","note":"Department only applies if 'department' type is selected"},{"type":"range","id":"items_per_row","min":3,"max":5,"step":1,"unit":"","label":"Items per row","info":"Maximum items allowed per row"},{"id":"layout","type":"select","options":[{"value":"grid","text":"Grid View"},{"value":"horizontal","text":"Horizontal View"}],"label":"Layout","info":"Alignment of content"},{"type":"text","id":"cta_text","label":"CTA Text"}],"blocks":[{"type":"brand_item","name":"Brand Item","props":[{"type":"brand","id":"brand","label":"Select Brand"}]}],"name":"brands_listing","label":"Brands Listing"},{"props":[{"type":"text","id":"title","label":"Title"},{"type":"range","id":"margin_top","min":0,"max":1000,"step":1,"unit":"px","label":"Section Top Margin"},{"type":"range","id":"margin_bottom","min":0,"max":1000,"step":1,"unit":"px","label":"Section Bottom Margin"},{"type":"radio","id":"collection_type","options":[{"value":"all","text":"All"},{"value":"handpicked","text":"Handpicked"}]},{"type":"text","id":"tags_filter","label":"Filter by tags","info":"Filter by Tags "},{"type":"range","id":"items_per_row","min":3,"max":5,"step":1,"unit":"","label":"Max items per row","info":"Maximum items allowed per row"},{"id":"layout","type":"select","options":[{"value":"grid","text":"Grid View"},{"value":"horizontal","text":"Horizontal View"}],"label":"Layout","info":"Alignment of content"},{"type":"text","id":"cta_text","label":"CTA Text"}],"blocks":[{"type":"collection-item","name":"collection Item","props":[{"type":"collection","id":"collection","label":"Select Collection"}]}],"name":"collections_listing","label":"Collections Listing"},{"props":[{"type":"code","id":"code","label":"Custom HTML","info":"Add Your custom HTML Code below. You can also use the full screen icon to open a code editor and add your code"},{"type":"range","id":"margin_top","min":0,"max":1000,"step":1,"unit":"px","label":"Section Top Margin"},{"type":"range","id":"margin_bottom","min":0,"max":1000,"step":1,"unit":"px","label":"Section Bottom Margin"}],"blocks":[],"name":"custom_html","label":"Custom HTML"},{"props":[{"type":"extension","id":"extension","label":"Extension Positions","info":"Handle extension in these positions","positions":[{"value":"section_extension","text":""}]},{"type":"range","id":"margin_top","min":0,"max":1000,"step":1,"unit":"px","label":"Section Top Margin"},{"type":"range","id":"margin_bottom","min":0,"max":1000,"step":1,"unit":"px","label":"Section Bottom Margin"}],"blocks":[],"name":"section_extension","label":"Extensions"},{"props":[{"type":"text","id":"title","label":"Title"},{"type":"range","id":"margin_top","min":0,"max":1000,"step":1,"unit":"px","label":"Section Top Margin"},{"type":"range","id":"margin_bottom","min":0,"max":1000,"step":1,"unit":"px","label":"Section Bottom Margin"},{"type":"collection","id":"collection","label":"Collection","info":"Select a collection to display its products"},{"type":"range","id":"items_per_row","min":2,"max":5,"step":1,"unit":"","label":"Products per row","info":"Maximum items allowed per row"},{"id":"layout","type":"select","options":[{"value":"grid","text":"Grid View"},{"value":"horizontal","text":"Horizontal View"}],"label":"Layout","info":"Alignment of content"},{"type":"checkbox","id":"autoplay","label":"AutoPlay Slides","info":"Check to autoplay slides"},{"type":"range","id":"slide_interval","min":1,"max":10,"step":1,"unit":"sec","label":"Change slides after every","info":"Autoplay slide duration"}],"blocks":[],"name":"featured_collection","label":"Featured Collection"},{"props":[{"id":"image","type":"image_picker","label":"Hero Image"},{"type":"range","id":"margin_top","min":0,"max":1000,"step":1,"unit":"px","label":"Section Top Margin"},{"type":"range","id":"margin_bottom","min":0,"max":1000,"step":1,"unit":"px","label":"Section Bottom Margin"},{"id":"overlay_layout","type":"select","options":[{"value":"left","text":"Align Left"},{"value":"center","text":"Align Center"},{"value":"right","text":"Align Right"}],"label":"Overlay Layout","info":"Alignment of overlay content"},{"type":"image_picker","id":"overlay_image","label":"Overlay image","info":"Overlay Image"},{"type":"text","id":"overlay_text","label":"Overlay Text"},{"type":"color","id":"text_color","label":"Text Color"},{"type":"url","id":"button_link","label":"Redirect Link"},{"type":"text","id":"button_text","label":"Button Text"},{"type":"checkbox","id":"full_width","label":"Full width","info":"Check to allow items to take entire width of the viewport"},{"type":"checkbox","id":"fullscreen_image","label":"Fullscreen Banner ","info":"Check to allow items to take entire viewport"}],"blocks":[],"name":"hero_image","label":"Hero Image"},{"props":[{"type":"video","id":"videoFile","label":"Primary Video"},{"id":"videoUrl","type":"text","label":"Video URL","info":"Supports MP4 Video & Youtube Video URL"},{"type":"checkbox","id":"autoplay","label":"Autoplay","info":"Check to enable autoplay (Video will be muted if autoplay is active)"},{"type":"checkbox","id":"hidecontrols","label":"Hide Video Controls","info":"check to disable video controls"},{"type":"checkbox","id":"showloop","label":"Play Video in Loop","info":"check to disable Loop"},{"type":"text","id":"title","label":"Heading"},{"id":"coverUrl","type":"image_picker","label":"Thumbnail Image"}],"blocks":[],"name":"hero_video-v2","label":"Hero Video V2"},{"props":[{"id":"video_url","type":"text","label":"Video URL","info":"Supports MP4 Video & Youtube Video URL"},{"type":"range","id":"margin_top","min":0,"max":1000,"step":1,"unit":"px","label":"Section Top Margin"},{"type":"range","id":"margin_bottom","min":0,"max":1000,"step":1,"unit":"px","label":"Section Bottom Margin"},{"type":"checkbox","id":"autoplay","label":"Autoplay","info":"Check to enable autoplay (Video will be muted if autoplay is active)"},{"type":"checkbox","id":"controls","label":"Video Controls","info":"Uncheck to disable video controls"},{"type":"checkbox","id":"full_width","label":"Full width","info":"Check to allow items to take entire width of the viewport"},{"type":"checkbox","id":"bg_video","label":"Video In Background","info":"Use video in background with overlay (Overlay Image & Video Controls will be disabled by default on website)"},{"type":"select","id":"size","options":[{"value":"small","text":"Small"},{"value":"medium","text":"Medium"},{"value":"large","text":"Large"},{"value":"adapt","text":"Adapt"},{"value":"fullscreen","text":"Fullscreen"}],"label":"Video Height","info":"Height of Video"},{"type":"checkbox","id":"enable_overlay_image","label":"Enable Overlay Image"},{"id":"cover_url","type":"image_picker","label":"Video Overlay Image"},{"type":"checkbox","id":"enable_overlay_color","label":"Enable Overlay Colour"},{"type":"color","id":"overlay_color","label":"Overlay Color"},{"type":"range","id":"overlay_opacity","min":0,"max":1,"step":0.1,"unit":"","label":"Overlay Opacity"},{"type":"select","id":"overlay_size","options":[{"value":"container","text":"Container (Default)"},{"value":"content","text":"Content"}],"label":"Overlay Size"},{"id":"overlay_position","type":"select","options":[{"value":"top-left","text":"Top Left"},{"value":"top-center","text":"Top Center"},{"value":"top-right","text":"Top Right"},{"value":"center-left","text":"Center Left"},{"value":"center-center","text":"Center (Default)"},{"value":"center-right","text":"Center Right"},{"value":"bottom-left","text":"Bottom Left"},{"value":"bottom-center","text":"Bottom Center"},{"value":"bottom-right","text":"Bottom right"}],"label":"Overlay position","info":"Alignment of Overlay content(heading, sub-heading, button)"},{"type":"text","id":"heading","label":"Heading"},{"type":"color","id":"heading_color","label":"Heading Text Color"},{"type":"text","id":"sub_heading","label":"Sub-heading"},{"type":"color","id":"sub_heading_color","label":"Sub-heading Text Color"},{"type":"url","id":"button_link","label":"Redirect Link"},{"type":"text","id":"button_text","label":"Button Text"}],"blocks":[],"name":"hero_video","label":"Hero Video"},{"props":[{"type":"text","id":"title","label":"Title"},{"type":"range","id":"margin_top","min":0,"max":1000,"step":1,"unit":"px","label":"Section Top Margin"},{"type":"range","id":"margin_bottom","min":0,"max":1000,"step":1,"unit":"px","label":"Section Bottom Margin"},{"id":"layout","type":"select","options":[{"value":"grid","text":"Grid View"},{"value":"horizontal","text":"Horizontal View"}],"label":"Layout","info":"Alignment of content"},{"type":"range","id":"item_count","min":3,"max":4,"step":1,"unit":"","label":"No of items","info":"Maximum items allowed per row for Horizontal view, for gallery max 5 are viewable and only 5 blocks are required"},{"type":"text","id":"cta_text","label":"CTA Text"},{"type":"url","id":"cta_link","label":"CTA Link","info":"Link to redirect"},{"type":"checkbox","id":"full_width","label":"Full width","info":"Check to allow items to take entire width of the viewport"}],"blocks":[{"type":"gallery_image","name":"Image","props":[{"type":"image_picker","id":"image","label":"Gallery Image"},{"type":"text","id":"caption","label":"Image Caption"},{"type":"url","id":"link","label":"Link","info":"Link to redirect"}]}],"name":"image_gallery","label":"Image Gallery","preset":{"blocks":[{"name":"Image"},{"name":"Image"},{"name":"Image"},{"name":"Image"}]}},{"props":[{"type":"text","id":"title","label":"Title"},{"type":"range","id":"margin_top","min":0,"max":1000,"step":1,"unit":"px","label":"Section Top Margin"},{"type":"range","id":"margin_bottom","min":0,"max":1000,"step":1,"unit":"px","label":"Section Bottom Margin"},{"type":"checkbox","id":"autoplay","label":"AutoPlay Slides","info":"Check to autoplay slides"},{"type":"range","id":"slide_interval","min":1,"max":10,"step":1,"unit":"sec","label":"Change slides after every","info":"Autoplay slide duration"},{"type":"select","id":"slide_height","options":[{"value":"adapt","text":"Adapt to first image"},{"value":"small","text":"Small"},{"value":"medium","text":"Medium"},{"value":"large","text":"Large"}],"label":"Slide height","info":"Size of the slide"},{"type":"checkbox","id":"full_width","label":"Full width","info":"Check to allow items to take entire width of the viewport"}],"blocks":[{"type":"image_slide","name":"Slide","props":[{"type":"image_picker","id":"image","label":"Image"},{"type":"url","id":"slide_link","label":"Slide Link"}]}],"name":"image_slideshow","label":"Image Slideshow","preset":{"blocks":[{"name":"Slide"},{"name":"Slide"},{"name":"Slide"}]}},{"props":[{"type":"image_picker","id":"image","label":"Image"},{"id":"video","type":"url","label":"Video"},{"type":"range","id":"margin_top","min":0,"max":1000,"step":1,"unit":"px","label":"Section Top Margin"},{"type":"range","id":"margin_bottom","min":0,"max":1000,"step":1,"unit":"px","label":"Section Bottom Margin"},{"id":"cover","type":"url","label":"Video Cover Image"},{"type":"select","id":"media_alignment","options":[{"value":"left","text":"Left"},{"value":"center","text":"Center"},{"value":"right","text":"Right"}],"label":"Media Alignment"},{"type":"text","id":"heading","label":"Heading"},{"type":"text","id":"text Pair large text with an image to give focus to your chosen product, collection, or blog post. Add details on availability, style, or even provide a review.","label":"Text"},{"type":"select","id":"text_alignment","options":[{"value":"left","text":"Left"},{"value":"center","text":"Center"},{"value":"right","text":"Right"}],"label":"Text Alignment"}],"blocks":[],"name":"media_with_text","label":"Media with text"},{"props":[{"type":"text","id":"title","label":"Title"},{"type":"range","id":"margin_top","min":0,"max":1000,"step":1,"unit":"px","label":"Section Top Margin"},{"type":"range","id":"margin_bottom","min":0,"max":1000,"step":1,"unit":"px","label":"Section Bottom Margin"},{"type":"checkbox","id":"autoplay","label":"AutoPlay Slides"},{"type":"range","id":"slide_interval","min":1,"max":10,"step":1,"unit":"sec","label":"Change slides every"}],"blocks":[{"type":"testimonial","name":"Testimonial","props":[{"type":"textarea","id":"testimonialText","label":"Text for Testimonial","info":"Text for testimonial","placeholder":"Text"},{"type":"text","id":"author_name","label":"Author name"},{"type":"text","id":"author_description","label":"Author Description"},{"type":"image_picker","id":"author_image","label":"Author Image"}]}],"name":"testimonials","label":"Testimonial","preset":{"blocks":[{"name":"Testimonial"},{"name":"Testimonial"},{"name":"Testimonial"}]}}],"src":"https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/organization/64aec4634bc407961ed265c5/theme/assets/Gpbt5naNG-archive.zip","company_id":1}]},"ThemeExample1":{"value":{"_id":"64be4423bc7b28003211322e","applied":false,"is_private":false,"tags":[],"application_id":"6487ea376e1442284917c44e","meta":{"payment":{"is_paid":false,"amount":0},"description":"Indulge in the epitome of luxury with our expertly crafted theme, showcasing a high-end aesthetic that exudes elegance. Designed with meticulous attention to detail, our features are tailored to elevate your products and amplify your brand identity.","industry":["Arts and crafts","Baby and kids","Books, music, and video"],"release":{"notes":"<p>Emerge release notes. Fyndx1 theme submission.</p>"},"images":{"desktop":"https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/misc/pictures/free-icon/original/McHjwol_h-images_desktop.webp","mobile":"https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/misc/pictures/free-icon/original/bq6gXrmVE-images_mobile.webp"},"slug":"emerge"},"name":"Emerge","template_theme_id":"64be1fdc2139f66b3ca2e94d","version":"1.0.153","styles":{},"created_at":"2023-07-24T09:28:03.845Z","updated_at":"2023-07-31T12:14:13.097Z","theme_type":"vue2","assets":{"umd_js":{"links":["https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/organization/64b0eb01c35f990518880a82/theme/assets/yf7ijNZKa_themeBundle.umd.min.8.js","https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/organization/64b0eb01c35f990518880a82/theme/assets/yf7ijNZKa_themeBundle.umd.min.cart.js","https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/organization/64b0eb01c35f990518880a82/theme/assets/yf7ijNZKa_themeBundle.umd.min.extras.js","https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/organization/64b0eb01c35f990518880a82/theme/assets/yf7ijNZKa_themeBundle.umd.min.products-listing.js","https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/organization/64b0eb01c35f990518880a82/theme/assets/yf7ijNZKa_themeBundle.umd.min.products.js","https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/organization/64b0eb01c35f990518880a82/theme/assets/yf7ijNZKa_themeBundle.umd.min.profile.js","https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/organization/64b0eb01c35f990518880a82/theme/assets/yf7ijNZKa_themeBundle.umd.min.vendors_products-listing.js","https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/organization/64b0eb01c35f990518880a82/theme/assets/yf7ijNZKa_themeBundle.umd.min.vendors_products.js","https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/organization/64b0eb01c35f990518880a82/theme/assets/yf7ijNZKa_themeBundle.umd.min.js"],"link":""},"common_js":{"link":"https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/organization/64b0eb01c35f990518880a82/theme/assets/yf7ijNZKa_themeBundle.common.js"},"css":{"links":["https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/organization/64b0eb01c35f990518880a82/theme/assets/yf7ijNZKa_cart.1b038cd83e502f2d58bc.css","https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/organization/64b0eb01c35f990518880a82/theme/assets/yf7ijNZKa_extras.f8a9789ae6a06b0bd503.css","https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/organization/64b0eb01c35f990518880a82/theme/assets/yf7ijNZKa_products-listing.1d639747568baee211ba.css","https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/organization/64b0eb01c35f990518880a82/theme/assets/yf7ijNZKa_products.c1f151d12b3f704fe028.css","https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/organization/64b0eb01c35f990518880a82/theme/assets/yf7ijNZKa_profile.c9e6a92612e4b423dbd7.css","https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/organization/64b0eb01c35f990518880a82/theme/assets/yf7ijNZKa_themeBundle.css","https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/organization/64b0eb01c35f990518880a82/theme/assets/yf7ijNZKa_vendors_products-listing.c8fe85761d60286348e3.css"],"link":""}},"font":{"variants":{"light":{"name":"300","file":"https://fonts.gstatic.com/s/poppins/v9/pxiByp8kv8JHgFVrLDz8V1tvFP-KUEg.ttf"},"regular":{"name":"regular","file":"https://fonts.gstatic.com/s/poppins/v9/pxiEyp8kv8JHgFVrFJDUc1NECPY.ttf"},"medium":{"name":"500","file":"https://fonts.gstatic.com/s/poppins/v9/pxiByp8kv8JHgFVrLGT9V1tvFP-KUEg.ttf"},"semi_bold":{"name":"600","file":"https://fonts.gstatic.com/s/poppins/v9/pxiByp8kv8JHgFVrLEj6V1tvFP-KUEg.ttf"},"bold":{"name":"700","file":"https://fonts.gstatic.com/s/poppins/v9/pxiByp8kv8JHgFVrLCz7V1tvFP-KUEg.ttf"}},"family":"Poppins"},"config":{"current":"Default","list":[{"name":"Default","global_config":{"static":{"props":{"colors":{"primary_color":"#000000","secondary_color":"#000000","accent_color":"#000000","link_color":"#4499FF","button_secondary_color":"#000000","bg_color":"#F8F8F8"},"auth":{"show_header_auth":false,"show_footer_auth":false},"palette":{"general_setting":{"theme":{"page_background":"#F3F3ED","theme_accent":"#E1D0C8"},"text":{"text_heading":"#26201A","text_body":"#3C3131","text_label":"#7D7676","text_secondary":"#9C9C9C"},"button":{"button_primary":"#4E3F09","button_secondary":"#FFFFFF","button_link":"#B1655B"},"sale_discount":{"sale_badge_background":"#FFFFFF","sale_badge_text":"#1C958F","sale_discount_text":"#1C958F","sale_timer":"#994449"},"header":{"header_background":"#F3F3ED","header_nav":"#261A1A","header_icon":"#261A1A"},"footer":{"footer_background":"#2C231E","footer_bottom_background":"#231812","footer_heading_text":"#FFFFFF","footer_body_text":"#FFFFFF","footer_icon":"#FFFFFF"}},"advance_setting":{"overlay_popup":{"dialog_backgroung":"#FFFFFF","overlay":"#14130E"},"divider_stroke_highlight":{"divider_strokes":"#D4D1D1","highlight":"#EDECE9"},"user_alerts":{"success_background":"#C2DBC9","success_text":"#1C958F","error_background":"#E6D5D5","error_text":"#B24141","info_background":"#EBD3BC","info_text":"#D28F51"}}},"extension":{"header_top":[],"header_bottom":[],"footer_top":[],"footer_bottom":[]}}},"custom":{"props":{"header_bg_color":"#ffffff","header_text_color":"#000000","header_border_color":"#e1e1e1","header_icon_color":"#000000","header_cart_notification_bg_color":"#e8a76c","header_cart_notification_text_color":"#ffffff","header_nav_hover_color":"#999999","button_primary_color":"#ffffff","button_primary_label_color":"#000000","button_add_to_cart_color":"#000000","button_add_to_cart_label_color":"#ffffff","button_secondary_color":"#000000","button_secondary_label_color":"#ffffff","button_tertiary_color":"#000000","button_tertiary_label_color":"#000000","button_tertiary_hover_color":"#000000","button_tertiary_hover_text_color":"#ffffff","text_heading_link_color":"#000000","text_body_color":"#000000","text_price_color":"#000000","text_sale_price_color":"#fb406b","text_strikethrough_price_color":"#9b9b9b","text_discount_color":"#ee478d","footer_bg_color":"#ffffff","footer_text_color":"#999999","footer_border_color":"#e1e1e1","footer_nav_hover_color":"#000000","disable_cart":false,"is_menu_below_logo":false,"menu_position":"left"}}},"page":[]},{"name":"Dark","global_config":{"static":{"props":{"colors":{"primary_color":"#000000","secondary_color":"#000000","accent_color":"#000000","link_color":"#4499FF","button_secondary_color":"#000000","bg_color":"#F8F8F8"},"auth":{"show_header_auth":false,"show_footer_auth":false},"palette":{"general_setting":{"theme":{"page_background":"#F3F3ED","theme_accent":"#E1D0C8"},"text":{"text_heading":"#26201A","text_body":"#3C3131","text_label":"#7D7676","text_secondary":"#9C9C9C"},"button":{"button_primary":"#4E3F09","button_secondary":"#FFFFFF","button_link":"#B1655B"},"sale_discount":{"sale_badge_background":"#FFFFFF","sale_badge_text":"#1C958F","sale_discount_text":"#1C958F","sale_timer":"#994449"},"header":{"header_background":"#F3F3ED","header_nav":"#261A1A","header_icon":"#261A1A"},"footer":{"footer_background":"#2C231E","footer_bottom_background":"#231812","footer_heading_text":"#FFFFFF","footer_body_text":"#FFFFFF","footer_icon":"#FFFFFF"}},"advance_setting":{"overlay_popup":{"dialog_backgroung":"#FFFFFF","overlay":"#14130E"},"divider_stroke_highlight":{"divider_strokes":"#D4D1D1","highlight":"#EDECE9"},"user_alerts":{"success_background":"#C2DBC9","success_text":"#1C958F","error_background":"#E6D5D5","error_text":"#B24141","info_background":"#EBD3BC","info_text":"#D28F51"}}},"extension":{"header_top":[],"header_bottom":[],"footer_top":[],"footer_bottom":[]}}},"custom":{"props":{"header_bg_color":"#2e3032","header_text_color":"#ffffff","header_border_color":"#FFFFFF","header_icon_color":"#ffffff","header_cart_notification_bg_color":"#FFFFFF","header_cart_notification_text_color":"#2e3032","header_nav_hover_color":"#000000","button_primary_color":"#000000","button_primary_label_color":"#ffffff","button_add_to_cart_color":"#000000","button_add_to_cart_label_color":"#ffffff","button_secondary_color":"#000000","button_secondary_label_color":"#ffffff","button_tertiary_color":"#000000","button_tertiary_label_color":"#000000","button_tertiary_hover_color":"#000000","button_tertiary_hover_text_color":"#ffffff","text_heading_link_color":"#000000","text_body_color":"#000000","text_price_color":"#000000","text_sale_price_color":"#fb406b","text_strikethrough_price_color":"#9b9b9b","text_discount_color":"#ee478d","footer_bg_color":"#2e3032","footer_text_color":"#ffffff","footer_border_color":"#FFFFFF","footer_nav_hover_color":"#ffffff"}}},"page":[]},{"name":"Blue","global_config":{"static":{"props":{"colors":{"primary_color":"#000000","secondary_color":"#000000","accent_color":"#000000","link_color":"#4499FF","button_secondary_color":"#000000","bg_color":"#F8F8F8"},"auth":{"show_header_auth":false,"show_footer_auth":false},"palette":{"general_setting":{"theme":{"page_background":"#F3F3ED","theme_accent":"#E1D0C8"},"text":{"text_heading":"#26201A","text_body":"#3C3131","text_label":"#7D7676","text_secondary":"#9C9C9C"},"button":{"button_primary":"#4E3F09","button_secondary":"#FFFFFF","button_link":"#B1655B"},"sale_discount":{"sale_badge_background":"#FFFFFF","sale_badge_text":"#1C958F","sale_discount_text":"#1C958F","sale_timer":"#994449"},"header":{"header_background":"#F3F3ED","header_nav":"#261A1A","header_icon":"#261A1A"},"footer":{"footer_background":"#2C231E","footer_bottom_background":"#231812","footer_heading_text":"#FFFFFF","footer_body_text":"#FFFFFF","footer_icon":"#FFFFFF"}},"advance_setting":{"overlay_popup":{"dialog_backgroung":"#FFFFFF","overlay":"#14130E"},"divider_stroke_highlight":{"divider_strokes":"#D4D1D1","highlight":"#EDECE9"},"user_alerts":{"success_background":"#C2DBC9","success_text":"#1C958F","error_background":"#E6D5D5","error_text":"#B24141","info_background":"#EBD3BC","info_text":"#D28F51"}}},"extension":{"header_top":[],"header_bottom":[],"footer_top":[],"footer_bottom":[]}}},"custom":{"props":{"header_bg_color":"#7f9ed0","header_text_color":"#FFFFFF","header_border_color":"#FFFFFF","header_icon_color":"#FFFFFF","header_cart_notification_bg_color":"#2e3032","header_cart_notification_text_color":"#FFFFFF","header_nav_hover_color":"#2e3032","button_primary_color":"#ffffff","button_primary_label_color":"#000000","button_add_to_cart_color":"#000000","button_add_to_cart_label_color":"#ffffff","button_secondary_color":"#000000","button_secondary_label_color":"#ffffff","button_tertiary_color":"#000000","button_tertiary_label_color":"#000000","button_tertiary_hover_color":"#000000","button_tertiary_hover_text_color":"#ffffff","text_heading_link_color":"#000000","text_body_color":"#000000","text_price_color":"#000000","text_sale_price_color":"#fb406b","text_strikethrough_price_color":"#9b9b9b","text_discount_color":"#ee478d","footer_bg_color":"#7f9ed0","footer_text_color":"#FFFFFF","footer_border_color":"#FFFFFF","footer_nav_hover_color":"#2e3032"}}},"page":[]}],"preset":{"pages":[{"sections":[{"blocks":[],"predicate":{"screen":{"mobile":true,"desktop":true,"tablet":true},"user":{"authenticated":true,"anonymous":true},"route":{"selected":"none","exact_url":""}},"name":"hero_image","props":{"image":{"value":"","type":"image_picker"},"overlay_layout":{"type":"select","value":"center"},"overlay_image":{"value":"","type":"image_picker"},"overlay_text":{"value":"","type":"text"},"text_color":{"value":"#000","type":"color"},"button_link":{"type":"url","value":""},"button_text":{"value":"Shop Now","type":"text"},"full_width":{"value":true,"type":"checkbox"}}},{"blocks":[],"predicate":{"screen":{"mobile":true,"desktop":true,"tablet":true},"user":{"authenticated":true,"anonymous":true},"route":{"selected":"none","exact_url":""}},"name":"image_slideshow","props":{"autoplay":{"value":false,"type":"checkbox"},"full_width":{"value":false,"type":"checkbox"},"slide_height":{"value":"adapt","type":"select"},"slide_interval":{"value":2,"type":"range"},"title":{"value":"Trending","type":"text"}},"preset":{"blocks":[{"name":"Slide"},{"name":"Slide"},{"name":"Slide"}]}},{"blocks":[{"type":"gallery_image","name":"Image","props":{"image":{"type":"image_picker","value":""},"caption":{"type":"text","value":""},"link":{"type":"url","value":""}}},{"type":"gallery_image","name":"Image","props":{"image":{"type":"image_picker","value":""},"caption":{"type":"text","value":""},"link":{"type":"url","value":""}}},{"type":"gallery_image","name":"Image","props":{"image":{"type":"image_picker","value":""},"caption":{"type":"text","value":""},"link":{"type":"url","value":""}}},{"type":"gallery_image","name":"Image","props":{"image":{"type":"image_picker","value":""},"caption":{"type":"text","value":""},"link":{"type":"url","value":""}}}],"predicate":{"screen":{"mobile":true,"desktop":true,"tablet":true},"user":{"authenticated":true,"anonymous":true},"route":{"selected":"none","exact_url":""}},"name":"image_gallery","props":{"title":{"type":"text","value":"Popular Brands"},"layout":{"value":"grid","type":"select"},"item_count":{"value":4,"type":"range"},"cta_text":{"value":"","type":"text"},"cta_link":{"type":"url","value":""},"full_width":{"value":false,"type":"checkbox"}},"preset":{"blocks":[{"name":"Image"},{"name":"Image"},{"name":"Image"},{"name":"Image"}]}},{"blocks":[],"predicate":{"screen":{"mobile":true,"desktop":true,"tablet":true},"user":{"authenticated":true,"anonymous":true},"route":{"selected":"none","exact_url":""}},"name":"brands_listing","props":{"brand_type":{"value":"all","type":"radio"},"cta_text":{"value":"View all","type":"text"},"department":{"type":"department"},"header":{"type":"header"},"items_per_row":{"value":5,"type":"range"},"layout":{"value":"horizontal","type":"select"},"title":{"type":"text","value":"Brands"},"view_options":{"value":"fullview","type":"select"}}},{"blocks":[{"type":"testimonial","name":"Testimonial","props":{"testimonialText":{"type":"textarea","value":""},"author_name":{"type":"text"},"author_description":{"type":"text","value":""},"author_image":{"type":"image_picker","value":""}}},{"type":"testimonial","name":"Testimonial","props":{"testimonialText":{"type":"textarea","value":""},"author_name":{"type":"text"},"author_description":{"type":"text","value":""},"author_image":{"type":"image_picker","value":""}}},{"type":"testimonial","name":"Testimonial","props":{"testimonialText":{"type":"textarea","value":""},"author_name":{"type":"text"},"author_description":{"type":"text","value":""},"author_image":{"type":"image_picker","value":""}}}],"predicate":{"screen":{"mobile":true,"desktop":true,"tablet":true},"user":{"authenticated":true,"anonymous":true},"route":{"selected":"none","exact_url":""}},"name":"testimonials","props":{"autoplay":{"value":false,"type":"checkbox"},"slide_interval":{"value":2,"type":"range"}},"preset":{"blocks":[{"name":"Testimonial"},{"name":"Testimonial"},{"name":"Testimonial"}]}}],"value":"home"}]},"global_schema":{"props":[{"type":"checkbox","id":"disable_cart","category":"Colors","label":"header"}]}},"available_sections":[{"props":[{"type":"url","id":"banner_link","label":"Redirect Link"},{"type":"checkbox","id":"full_width","label":"Full width","info":"Check to allow items to take entire width of the viewport"},{"type":"range","id":"margin_top","min":0,"max":1000,"step":1,"unit":"px","label":"Section Top Margin"},{"type":"range","id":"margin_bottom","min":0,"max":1000,"step":1,"unit":"px","label":"Section Bottom Margin"}],"blocks":[],"name":"application_banner","label":"Application Banner"},{"props":[{"type":"text","id":"title","label":"Title"},{"type":"range","id":"margin_top","min":0,"max":1000,"step":1,"unit":"px","label":"Section Top Margin"},{"type":"range","id":"margin_bottom","min":0,"max":1000,"step":1,"unit":"px","label":"Section Bottom Margin"},{"type":"header","id":"header","value":"Choose Brands to Show"},{"id":"view_options","type":"select","options":[{"value":"logo","text":"Logo View"},{"value":"fullview","text":"Logo and Banner View"}],"label":"View Options","info":"Brand card view options"},{"type":"radio","id":"brand_type","options":[{"value":"all","text":"All"},{"value":"department","text":"Department"},{"value":"handpicked","text":"Handpicked"}]},{"type":"department","id":"department","label":"Department","info":"Select a department of brands","note":"Department only applies if 'department' type is selected"},{"type":"range","id":"items_per_row","min":3,"max":5,"step":1,"unit":"","label":"Items per row","info":"Maximum items allowed per row"},{"id":"layout","type":"select","options":[{"value":"grid","text":"Grid View"},{"value":"horizontal","text":"Horizontal View"}],"label":"Layout","info":"Alignment of content"},{"type":"text","id":"cta_text","label":"CTA Text"}],"blocks":[{"type":"brand_item","name":"Brand Item","props":[{"type":"brand","id":"brand","label":"Select Brand"}]}],"name":"brands_listing","label":"Brands Listing"},{"props":[{"type":"text","id":"title","label":"Title"},{"type":"range","id":"margin_top","min":0,"max":1000,"step":1,"unit":"px","label":"Section Top Margin"},{"type":"range","id":"margin_bottom","min":0,"max":1000,"step":1,"unit":"px","label":"Section Bottom Margin"},{"type":"radio","id":"collection_type","options":[{"value":"all","text":"All"},{"value":"handpicked","text":"Handpicked"}]},{"type":"text","id":"tags_filter","label":"Filter by tags","info":"Filter by Tags "},{"type":"range","id":"items_per_row","min":3,"max":5,"step":1,"unit":"","label":"Max items per row","info":"Maximum items allowed per row"},{"id":"layout","type":"select","options":[{"value":"grid","text":"Grid View"},{"value":"horizontal","text":"Horizontal View"}],"label":"Layout","info":"Alignment of content"},{"type":"text","id":"cta_text","label":"CTA Text"}],"blocks":[{"type":"collection-item","name":"collection Item","props":[{"type":"collection","id":"collection","label":"Select Collection"}]}],"name":"collections_listing","label":"Collections Listing"},{"props":[{"type":"code","id":"code","label":"Custom HTML","info":"Add Your custom HTML Code below. You can also use the full screen icon to open a code editor and add your code"},{"type":"range","id":"margin_top","min":0,"max":1000,"step":1,"unit":"px","label":"Section Top Margin"},{"type":"range","id":"margin_bottom","min":0,"max":1000,"step":1,"unit":"px","label":"Section Bottom Margin"}],"blocks":[],"name":"custom_html","label":"Custom HTML"},{"props":[{"type":"extension","id":"extension","label":"Extension Positions","info":"Handle extension in these positions","positions":[{"value":"section_extension","text":""}]},{"type":"range","id":"margin_top","min":0,"max":1000,"step":1,"unit":"px","label":"Section Top Margin"},{"type":"range","id":"margin_bottom","min":0,"max":1000,"step":1,"unit":"px","label":"Section Bottom Margin"}],"blocks":[],"name":"section_extension","label":"Extensions"},{"props":[{"type":"text","id":"title","label":"Title"},{"type":"range","id":"margin_top","min":0,"max":1000,"step":1,"unit":"px","label":"Section Top Margin"},{"type":"range","id":"margin_bottom","min":0,"max":1000,"step":1,"unit":"px","label":"Section Bottom Margin"},{"type":"collection","id":"collection","label":"Collection","info":"Select a collection to display its products"},{"type":"range","id":"items_per_row","min":2,"max":5,"step":1,"unit":"","label":"Products per row","info":"Maximum items allowed per row"},{"id":"layout","type":"select","options":[{"value":"grid","text":"Grid View"},{"value":"horizontal","text":"Horizontal View"}],"label":"Layout","info":"Alignment of content"},{"type":"checkbox","id":"autoplay","label":"AutoPlay Slides","info":"Check to autoplay slides"},{"type":"range","id":"slide_interval","min":1,"max":10,"step":1,"unit":"sec","label":"Change slides after every","info":"Autoplay slide duration"}],"blocks":[],"name":"featured_collection","label":"Featured Collection"},{"props":[{"id":"image","type":"image_picker","label":"Hero Image"},{"type":"range","id":"margin_top","min":0,"max":1000,"step":1,"unit":"px","label":"Section Top Margin"},{"type":"range","id":"margin_bottom","min":0,"max":1000,"step":1,"unit":"px","label":"Section Bottom Margin"},{"id":"overlay_layout","type":"select","options":[{"value":"left","text":"Align Left"},{"value":"center","text":"Align Center"},{"value":"right","text":"Align Right"}],"label":"Overlay Layout","info":"Alignment of overlay content"},{"type":"image_picker","id":"overlay_image","label":"Overlay image","info":"Overlay Image"},{"type":"text","id":"overlay_text","label":"Overlay Text"},{"type":"color","id":"text_color","label":"Text Color"},{"type":"url","id":"button_link","label":"Redirect Link"},{"type":"text","id":"button_text","label":"Button Text"},{"type":"checkbox","id":"full_width","label":"Full width","info":"Check to allow items to take entire width of the viewport"},{"type":"checkbox","id":"fullscreen_image","label":"Fullscreen Banner ","info":"Check to allow items to take entire viewport"}],"blocks":[],"name":"hero_image","label":"Hero Image"},{"props":[{"type":"video","id":"videoFile","label":"Primary Video"},{"id":"videoUrl","type":"text","label":"Video URL","info":"Supports MP4 Video & Youtube Video URL"},{"type":"checkbox","id":"autoplay","label":"Autoplay","info":"Check to enable autoplay (Video will be muted if autoplay is active)"},{"type":"checkbox","id":"hidecontrols","label":"Hide Video Controls","info":"check to disable video controls"},{"type":"checkbox","id":"showloop","label":"Play Video in Loop","info":"check to disable Loop"},{"type":"text","id":"title","label":"Heading"},{"id":"coverUrl","type":"image_picker","label":"Thumbnail Image"}],"blocks":[],"name":"hero_video-v2","label":"Hero Video V2"},{"props":[{"id":"video_url","type":"text","label":"Video URL","info":"Supports MP4 Video & Youtube Video URL"},{"type":"range","id":"margin_top","min":0,"max":1000,"step":1,"unit":"px","label":"Section Top Margin"},{"type":"range","id":"margin_bottom","min":0,"max":1000,"step":1,"unit":"px","label":"Section Bottom Margin"},{"type":"checkbox","id":"autoplay","label":"Autoplay","info":"Check to enable autoplay (Video will be muted if autoplay is active)"},{"type":"checkbox","id":"controls","label":"Video Controls","info":"Uncheck to disable video controls"},{"type":"checkbox","id":"full_width","label":"Full width","info":"Check to allow items to take entire width of the viewport"},{"type":"checkbox","id":"bg_video","label":"Video In Background","info":"Use video in background with overlay (Overlay Image & Video Controls will be disabled by default on website)"},{"type":"select","id":"size","options":[{"value":"small","text":"Small"},{"value":"medium","text":"Medium"},{"value":"large","text":"Large"},{"value":"adapt","text":"Adapt"},{"value":"fullscreen","text":"Fullscreen"}],"label":"Video Height","info":"Height of Video"},{"type":"checkbox","id":"enable_overlay_image","label":"Enable Overlay Image"},{"id":"cover_url","type":"image_picker","label":"Video Overlay Image"},{"type":"checkbox","id":"enable_overlay_color","label":"Enable Overlay Colour"},{"type":"color","id":"overlay_color","label":"Overlay Color"},{"type":"range","id":"overlay_opacity","min":0,"max":1,"step":0.1,"unit":"","label":"Overlay Opacity"},{"type":"select","id":"overlay_size","options":[{"value":"container","text":"Container (Default)"},{"value":"content","text":"Content"}],"label":"Overlay Size"},{"id":"overlay_position","type":"select","options":[{"value":"top-left","text":"Top Left"},{"value":"top-center","text":"Top Center"},{"value":"top-right","text":"Top Right"},{"value":"center-left","text":"Center Left"},{"value":"center-center","text":"Center (Default)"},{"value":"center-right","text":"Center Right"},{"value":"bottom-left","text":"Bottom Left"},{"value":"bottom-center","text":"Bottom Center"},{"value":"bottom-right","text":"Bottom right"}],"label":"Overlay position","info":"Alignment of Overlay content(heading, sub-heading, button)"},{"type":"text","id":"heading","label":"Heading"},{"type":"color","id":"heading_color","label":"Heading Text Color"},{"type":"text","id":"sub_heading","label":"Sub-heading"},{"type":"color","id":"sub_heading_color","label":"Sub-heading Text Color"},{"type":"url","id":"button_link","label":"Redirect Link"},{"type":"text","id":"button_text","label":"Button Text"}],"blocks":[],"name":"hero_video","label":"Hero Video"},{"props":[{"type":"text","id":"title","label":"Title"},{"type":"range","id":"margin_top","min":0,"max":1000,"step":1,"unit":"px","label":"Section Top Margin"},{"type":"range","id":"margin_bottom","min":0,"max":1000,"step":1,"unit":"px","label":"Section Bottom Margin"},{"id":"layout","type":"select","options":[{"value":"grid","text":"Grid View"},{"value":"horizontal","text":"Horizontal View"}],"label":"Layout","info":"Alignment of content"},{"type":"range","id":"item_count","min":3,"max":4,"step":1,"unit":"","label":"No of items","info":"Maximum items allowed per row for Horizontal view, for gallery max 5 are viewable and only 5 blocks are required"},{"type":"text","id":"cta_text","label":"CTA Text"},{"type":"url","id":"cta_link","label":"CTA Link","info":"Link to redirect"},{"type":"checkbox","id":"full_width","label":"Full width","info":"Check to allow items to take entire width of the viewport"}],"blocks":[{"type":"gallery_image","name":"Image","props":[{"type":"image_picker","id":"image","label":"Gallery Image"},{"type":"text","id":"caption","label":"Image Caption"},{"type":"url","id":"link","label":"Link","info":"Link to redirect"}]}],"name":"image_gallery","label":"Image Gallery","preset":{"blocks":[{"name":"Image"},{"name":"Image"},{"name":"Image"},{"name":"Image"}]}},{"props":[{"type":"text","id":"title","label":"Title"},{"type":"range","id":"margin_top","min":0,"max":1000,"step":1,"unit":"px","label":"Section Top Margin"},{"type":"range","id":"margin_bottom","min":0,"max":1000,"step":1,"unit":"px","label":"Section Bottom Margin"},{"type":"checkbox","id":"autoplay","label":"AutoPlay Slides","info":"Check to autoplay slides"},{"type":"range","id":"slide_interval","min":1,"max":10,"step":1,"unit":"sec","label":"Change slides after every","info":"Autoplay slide duration"},{"type":"select","id":"slide_height","options":[{"value":"adapt","text":"Adapt to first image"},{"value":"small","text":"Small"},{"value":"medium","text":"Medium"},{"value":"large","text":"Large"}],"label":"Slide height","info":"Size of the slide"},{"type":"checkbox","id":"full_width","label":"Full width","info":"Check to allow items to take entire width of the viewport"}],"blocks":[{"type":"image_slide","name":"Slide","props":[{"type":"image_picker","id":"image","label":"Image"},{"type":"url","id":"slide_link","label":"Slide Link"}]}],"name":"image_slideshow","label":"Image Slideshow","preset":{"blocks":[{"name":"Slide"},{"name":"Slide"},{"name":"Slide"}]}},{"props":[{"type":"image_picker","id":"image","label":"Image"},{"id":"video","type":"url","label":"Video"},{"type":"range","id":"margin_top","min":0,"max":1000,"step":1,"unit":"px","label":"Section Top Margin"},{"type":"range","id":"margin_bottom","min":0,"max":1000,"step":1,"unit":"px","label":"Section Bottom Margin"},{"id":"cover","type":"url","label":"Video Cover Image"},{"type":"select","id":"media_alignment","options":[{"value":"left","text":"Left"},{"value":"center","text":"Center"},{"value":"right","text":"Right"}],"label":"Media Alignment"},{"type":"text","id":"heading","label":"Heading"},{"type":"text","id":"text Pair large text with an image to give focus to your chosen product, collection, or blog post. Add details on availability, style, or even provide a review.","label":"Text"},{"type":"select","id":"text_alignment","options":[{"value":"left","text":"Left"},{"value":"center","text":"Center"},{"value":"right","text":"Right"}],"label":"Text Alignment"}],"blocks":[],"name":"media_with_text","label":"Media with text"},{"props":[{"type":"text","id":"title","label":"Title"},{"type":"range","id":"margin_top","min":0,"max":1000,"step":1,"unit":"px","label":"Section Top Margin"},{"type":"range","id":"margin_bottom","min":0,"max":1000,"step":1,"unit":"px","label":"Section Bottom Margin"},{"type":"checkbox","id":"autoplay","label":"AutoPlay Slides"},{"type":"range","id":"slide_interval","min":1,"max":10,"step":1,"unit":"sec","label":"Change slides every"}],"blocks":[{"type":"testimonial","name":"Testimonial","props":[{"type":"textarea","id":"testimonialText","label":"Text for Testimonial","info":"Text for testimonial","placeholder":"Text"},{"type":"text","id":"author_name","label":"Author name"},{"type":"text","id":"author_description","label":"Author Description"},{"type":"image_picker","id":"author_image","label":"Author Image"}]}],"name":"testimonials","label":"Testimonial","preset":{"blocks":[{"name":"Testimonial"},{"name":"Testimonial"},{"name":"Testimonial"}]}}],"src":"https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/organization/64b0eb01c35f990518880a82/theme/assets/7yuL57qP2-archive.zip"}},"ThemeExample2":{"value":{"_id":"64b91fe317422a1e1392f85b","applied":true,"is_private":true,"tags":[],"name":"Astra","version":"1.0.11","application_id":"7487ea376e1442284917c44e","styles":{},"template_theme_id":"64be264c0347c5002279b75f","created_at":"2023-07-24T07:20:44.629Z","updated_at":"2023-08-01T11:09:25.857Z","theme_type":"vue2","assets":{"umd_js":{"links":["https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/organization/64aec4634bc407961ed265c5/theme/assets/O3s2Kmnsc_themeBundle.umd.min.9.js","https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/organization/64aec4634bc407961ed265c5/theme/assets/O3s2Kmnsc_themeBundle.umd.min.cart.js","https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/organization/64aec4634bc407961ed265c5/theme/assets/O3s2Kmnsc_themeBundle.umd.min.extras.js","https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/organization/64aec4634bc407961ed265c5/theme/assets/O3s2Kmnsc_themeBundle.umd.min.products-listing_profile.js","https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/organization/64aec4634bc407961ed265c5/theme/assets/O3s2Kmnsc_themeBundle.umd.min.products-listing.js","https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/organization/64aec4634bc407961ed265c5/theme/assets/O3s2Kmnsc_themeBundle.umd.min.products.js","https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/organization/64aec4634bc407961ed265c5/theme/assets/O3s2Kmnsc_themeBundle.umd.min.profile.js","https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/organization/64aec4634bc407961ed265c5/theme/assets/O3s2Kmnsc_themeBundle.umd.min.vendors_products-listing.js","https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/organization/64aec4634bc407961ed265c5/theme/assets/O3s2Kmnsc_themeBundle.umd.min.vendors_products.js","https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/organization/64aec4634bc407961ed265c5/theme/assets/O3s2Kmnsc_themeBundle.umd.min.js"],"link":""},"common_js":{"link":"https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/organization/64aec4634bc407961ed265c5/theme/assets/O3s2Kmnsc_themeBundle.common.js"},"css":{"links":["https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/organization/64aec4634bc407961ed265c5/theme/assets/O3s2Kmnsc_extras.8604b743eb82cd74e4bb.css","https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/organization/64aec4634bc407961ed265c5/theme/assets/O3s2Kmnsc_products-listing_profile.944723408675f52ed297.css","https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/organization/64aec4634bc407961ed265c5/theme/assets/O3s2Kmnsc_products-listing.ca493ea7d081b4b575f7.css","https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/organization/64aec4634bc407961ed265c5/theme/assets/O3s2Kmnsc_products.2c64f7731dab64227f0b.css","https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/organization/64aec4634bc407961ed265c5/theme/assets/O3s2Kmnsc_profile.1b1467735927e188d272.css","https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/organization/64aec4634bc407961ed265c5/theme/assets/O3s2Kmnsc_themeBundle.css","https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/organization/64aec4634bc407961ed265c5/theme/assets/O3s2Kmnsc_vendors_products-listing.c8fe85761d60286348e3.css"],"link":""}},"font":{"variants":{"light":{"name":"300","file":"https://fonts.gstatic.com/s/poppins/v20/pxiByp8kv8JHgFVrLDz8V1tvFP-KUEg.ttf"},"regular":{"name":"regular","file":"https://fonts.gstatic.com/s/poppins/v20/pxiEyp8kv8JHgFVrFJDUc1NECPY.ttf"},"medium":{"name":"500","file":"https://fonts.gstatic.com/s/poppins/v20/pxiByp8kv8JHgFVrLGT9V1tvFP-KUEg.ttf"},"semi_bold":{"name":"600","file":"https://fonts.gstatic.com/s/poppins/v20/pxiByp8kv8JHgFVrLEj6V1tvFP-KUEg.ttf"},"bold":{"name":"700","file":"https://fonts.gstatic.com/s/poppins/v20/pxiByp8kv8JHgFVrLCz7V1tvFP-KUEg.ttf"}},"family":"Poppins"},"config":{"current":"Default","list":[{"name":"Default","global_config":{"static":{"props":{"colors":{"primary_color":"#000000","secondary_color":"#000000","accent_color":"#000000","link_color":"#4499FF","button_secondary_color":"#000000","bg_color":"#F8F8F8"},"auth":{"show_header_auth":false,"show_footer_auth":false},"palette":{"general_setting":{"theme":{"page_background":"#F3F3ED","theme_accent":"#E1D0C8"},"text":{"text_heading":"#26201A","text_body":"#3C3131","text_label":"#7D7676","text_secondary":"#9C9C9C"},"button":{"button_primary":"#4E3F09","button_secondary":"#FFFFFF","button_link":"#B1655B"},"sale_discount":{"sale_badge_background":"#FFFFFF","sale_badge_text":"#1C958F","sale_discount_text":"#1C958F","sale_timer":"#994449"},"header":{"header_background":"#F3F3ED","header_nav":"#261A1A","header_icon":"#261A1A"},"footer":{"footer_background":"#2C231E","footer_bottom_background":"#231812","footer_heading_text":"#FFFFFF","footer_body_text":"#FFFFFF","footer_icon":"#FFFFFF"}},"advance_setting":{"overlay_popup":{"dialog_backgroung":"#FFFFFF","overlay":"#14130E"},"divider_stroke_highlight":{"divider_strokes":"#D4D1D1","highlight":"#EDECE9"},"user_alerts":{"success_background":"#C2DBC9","success_text":"#1C958F","error_background":"#E6D5D5","error_text":"#B24141","info_background":"#EBD3BC","info_text":"#D28F51"}}},"extension":{"header_top":[],"header_bottom":[],"footer_top":[],"footer_bottom":[]}}},"custom":{"props":{"header_bg_color":"#ffffff","header_text_color":"#000000","header_border_color":"#e1e1e1","header_icon_color":"#000000","header_cart_notification_bg_color":"#e8a76c","header_cart_notification_text_color":"#ffffff","header_nav_hover_color":"#999999","button_primary_color":"#ffffff","button_primary_label_color":"#000000","button_add_to_cart_color":"#000000","button_add_to_cart_label_color":"#ffffff","button_secondary_color":"#000000","button_secondary_label_color":"#ffffff","button_tertiary_color":"#000000","button_tertiary_label_color":"#000000","button_tertiary_hover_color":"#000000","button_tertiary_hover_text_color":"#ffffff","text_heading_link_color":"#000000","text_body_color":"#000000","text_price_color":"#000000","text_sale_price_color":"#fb406b","text_strikethrough_price_color":"#9b9b9b","text_discount_color":"#ee478d","footer_bg_color":"#ffffff","footer_text_color":"#999999","footer_border_color":"#e1e1e1","footer_nav_hover_color":"#000000","disable_cart":false,"is_menu_below_logo":false,"menu_position":"left"}}},"page":[]},{"name":"Dark","global_config":{"static":{"props":{"colors":{"primary_color":"#000000","secondary_color":"#000000","accent_color":"#000000","link_color":"#4499FF","button_secondary_color":"#000000","bg_color":"#F8F8F8"},"auth":{"show_header_auth":false,"show_footer_auth":false},"palette":{"general_setting":{"theme":{"page_background":"#F3F3ED","theme_accent":"#E1D0C8"},"text":{"text_heading":"#26201A","text_body":"#3C3131","text_label":"#7D7676","text_secondary":"#9C9C9C"},"button":{"button_primary":"#4E3F09","button_secondary":"#FFFFFF","button_link":"#B1655B"},"sale_discount":{"sale_badge_background":"#FFFFFF","sale_badge_text":"#1C958F","sale_discount_text":"#1C958F","sale_timer":"#994449"},"header":{"header_background":"#F3F3ED","header_nav":"#261A1A","header_icon":"#261A1A"},"footer":{"footer_background":"#2C231E","footer_bottom_background":"#231812","footer_heading_text":"#FFFFFF","footer_body_text":"#FFFFFF","footer_icon":"#FFFFFF"}},"advance_setting":{"overlay_popup":{"dialog_backgroung":"#FFFFFF","overlay":"#14130E"},"divider_stroke_highlight":{"divider_strokes":"#D4D1D1","highlight":"#EDECE9"},"user_alerts":{"success_background":"#C2DBC9","success_text":"#1C958F","error_background":"#E6D5D5","error_text":"#B24141","info_background":"#EBD3BC","info_text":"#D28F51"}}},"extension":{"header_top":[],"header_bottom":[],"footer_top":[],"footer_bottom":[]}}},"custom":{"props":{"header_bg_color":"#2e3032","header_text_color":"#ffffff","header_border_color":"#FFFFFF","header_icon_color":"#ffffff","header_cart_notification_bg_color":"#FFFFFF","header_cart_notification_text_color":"#2e3032","header_nav_hover_color":"#000000","button_primary_color":"#000000","button_primary_label_color":"#ffffff","button_add_to_cart_color":"#000000","button_add_to_cart_label_color":"#ffffff","button_secondary_color":"#000000","button_secondary_label_color":"#ffffff","button_tertiary_color":"#000000","button_tertiary_label_color":"#000000","button_tertiary_hover_color":"#000000","button_tertiary_hover_text_color":"#ffffff","text_heading_link_color":"#000000","text_body_color":"#000000","text_price_color":"#000000","text_sale_price_color":"#fb406b","text_strikethrough_price_color":"#9b9b9b","text_discount_color":"#ee478d","footer_bg_color":"#2e3032","footer_text_color":"#ffffff","footer_border_color":"#FFFFFF","footer_nav_hover_color":"#ffffff"}}},"page":[]},{"name":"Blue","global_config":{"static":{"props":{"colors":{"primary_color":"#000000","secondary_color":"#000000","accent_color":"#000000","link_color":"#4499FF","button_secondary_color":"#000000","bg_color":"#F8F8F8"},"auth":{"show_header_auth":false,"show_footer_auth":false},"palette":{"general_setting":{"theme":{"page_background":"#F3F3ED","theme_accent":"#E1D0C8"},"text":{"text_heading":"#26201A","text_body":"#3C3131","text_label":"#7D7676","text_secondary":"#9C9C9C"},"button":{"button_primary":"#4E3F09","button_secondary":"#FFFFFF","button_link":"#B1655B"},"sale_discount":{"sale_badge_background":"#FFFFFF","sale_badge_text":"#1C958F","sale_discount_text":"#1C958F","sale_timer":"#994449"},"header":{"header_background":"#F3F3ED","header_nav":"#261A1A","header_icon":"#261A1A"},"footer":{"footer_background":"#2C231E","footer_bottom_background":"#231812","footer_heading_text":"#FFFFFF","footer_body_text":"#FFFFFF","footer_icon":"#FFFFFF"}},"advance_setting":{"overlay_popup":{"dialog_backgroung":"#FFFFFF","overlay":"#14130E"},"divider_stroke_highlight":{"divider_strokes":"#D4D1D1","highlight":"#EDECE9"},"user_alerts":{"success_background":"#C2DBC9","success_text":"#1C958F","error_background":"#E6D5D5","error_text":"#B24141","info_background":"#EBD3BC","info_text":"#D28F51"}}},"extension":{"header_top":[],"header_bottom":[],"footer_top":[],"footer_bottom":[]}}},"custom":{"props":{"header_bg_color":"#7f9ed0","header_text_color":"#FFFFFF","header_border_color":"#FFFFFF","header_icon_color":"#FFFFFF","header_cart_notification_bg_color":"#2e3032","header_cart_notification_text_color":"#FFFFFF","header_nav_hover_color":"#2e3032","button_primary_color":"#ffffff","button_primary_label_color":"#000000","button_add_to_cart_color":"#000000","button_add_to_cart_label_color":"#ffffff","button_secondary_color":"#000000","button_secondary_label_color":"#ffffff","button_tertiary_color":"#000000","button_tertiary_label_color":"#000000","button_tertiary_hover_color":"#000000","button_tertiary_hover_text_color":"#ffffff","text_heading_link_color":"#000000","text_body_color":"#000000","text_price_color":"#000000","text_sale_price_color":"#fb406b","text_strikethrough_price_color":"#9b9b9b","text_discount_color":"#ee478d","footer_bg_color":"#7f9ed0","footer_text_color":"#FFFFFF","footer_border_color":"#FFFFFF","footer_nav_hover_color":"#2e3032"}}},"page":[]}],"preset":{"pages":[{"sections":[{"blocks":[],"predicate":{"screen":{"mobile":true,"desktop":true,"tablet":true},"user":{"authenticated":true,"anonymous":true},"route":{"selected":"none","exact_url":""}},"name":"hero_image","props":{"image":{"value":"","type":"image_picker"},"overlay_layout":{"type":"select","value":"center"},"overlay_image":{"value":"","type":"image_picker"},"overlay_text":{"value":"","type":"text"},"text_color":{"value":"#000","type":"color"},"button_link":{"type":"url","value":""},"button_text":{"value":"Shop Now","type":"text"},"full_width":{"value":true,"type":"checkbox"}}},{"blocks":[],"predicate":{"screen":{"mobile":true,"desktop":true,"tablet":true},"user":{"authenticated":true,"anonymous":true},"route":{"selected":"none","exact_url":""}},"name":"image_slideshow","props":{"autoplay":{"value":false,"type":"checkbox"},"full_width":{"value":false,"type":"checkbox"},"slide_height":{"value":"adapt","type":"select"},"slide_interval":{"value":2,"type":"range"},"title":{"value":"Trending","type":"text"}},"preset":{"blocks":[{"name":"Slide"},{"name":"Slide"},{"name":"Slide"}]}},{"blocks":[{"type":"gallery_image","name":"Image","props":{"image":{"type":"image_picker","value":""},"caption":{"type":"text","value":""},"link":{"type":"url","value":""}}},{"type":"gallery_image","name":"Image","props":{"image":{"type":"image_picker","value":""},"caption":{"type":"text","value":""},"link":{"type":"url","value":""}}},{"type":"gallery_image","name":"Image","props":{"image":{"type":"image_picker","value":""},"caption":{"type":"text","value":""},"link":{"type":"url","value":""}}},{"type":"gallery_image","name":"Image","props":{"image":{"type":"image_picker","value":""},"caption":{"type":"text","value":""},"link":{"type":"url","value":""}}}],"predicate":{"screen":{"mobile":true,"desktop":true,"tablet":true},"user":{"authenticated":true,"anonymous":true},"route":{"selected":"none","exact_url":""}},"name":"image_gallery","props":{"title":{"type":"text","value":"Popular Brands"},"layout":{"value":"grid","type":"select"},"item_count":{"value":4,"type":"range"},"cta_text":{"value":"","type":"text"},"cta_link":{"type":"url","value":""},"full_width":{"value":false,"type":"checkbox"}},"preset":{"blocks":[{"name":"Image"},{"name":"Image"},{"name":"Image"},{"name":"Image"}]}},{"blocks":[],"predicate":{"screen":{"mobile":true,"desktop":true,"tablet":true},"user":{"authenticated":true,"anonymous":true},"route":{"selected":"none","exact_url":""}},"name":"brands_listing","props":{"brand_type":{"value":"all","type":"radio"},"cta_text":{"value":"View all","type":"text"},"department":{"type":"department"},"header":{"type":"header"},"items_per_row":{"value":5,"type":"range"},"layout":{"value":"horizontal","type":"select"},"title":{"type":"text","value":"Brands"},"view_options":{"value":"fullview","type":"select"}}},{"blocks":[{"type":"testimonial","name":"Testimonial","props":{"testimonialText":{"type":"textarea","value":""},"author_name":{"type":"text"},"author_description":{"type":"text","value":""},"author_image":{"type":"image_picker","value":""}}},{"type":"testimonial","name":"Testimonial","props":{"testimonialText":{"type":"textarea","value":""},"author_name":{"type":"text"},"author_description":{"type":"text","value":""},"author_image":{"type":"image_picker","value":""}}},{"type":"testimonial","name":"Testimonial","props":{"testimonialText":{"type":"textarea","value":""},"author_name":{"type":"text"},"author_description":{"type":"text","value":""},"author_image":{"type":"image_picker","value":""}}}],"predicate":{"screen":{"mobile":true,"desktop":true,"tablet":true},"user":{"authenticated":true,"anonymous":true},"route":{"selected":"none","exact_url":""}},"name":"testimonials","props":{"autoplay":{"value":false,"type":"checkbox"},"slide_interval":{"value":2,"type":"range"}},"preset":{"blocks":[{"name":"Testimonial"},{"name":"Testimonial"},{"name":"Testimonial"}]}}],"value":"home"}]},"global_schema":{"props":[{"type":"checkbox","id":"disable_cart","category":"Colors","label":"header"}]}},"available_sections":[{"props":[{"type":"url","id":"banner_link","label":"Redirect Link"},{"type":"checkbox","id":"full_width","label":"Full width","info":"Check to allow items to take entire width of the viewport"},{"type":"range","id":"margin_top","min":0,"max":1000,"step":1,"unit":"px","label":"Section Top Margin"},{"type":"range","id":"margin_bottom","min":0,"max":1000,"step":1,"unit":"px","label":"Section Bottom Margin"}],"blocks":[],"name":"application_banner","label":"Application Banner"},{"props":[{"type":"text","id":"title","label":"Title"},{"type":"range","id":"margin_top","min":0,"max":1000,"step":1,"unit":"px","label":"Section Top Margin"},{"type":"range","id":"margin_bottom","min":0,"max":1000,"step":1,"unit":"px","label":"Section Bottom Margin"},{"type":"header","id":"header","value":"Choose Brands to Show"},{"id":"view_options","type":"select","options":[{"value":"logo","text":"Logo View"},{"value":"fullview","text":"Logo and Banner View"}],"label":"View Options","info":"Brand card view options"},{"type":"radio","id":"brand_type","options":[{"value":"all","text":"All"},{"value":"department","text":"Department"},{"value":"handpicked","text":"Handpicked"}]},{"type":"department","id":"department","label":"Department","info":"Select a department of brands","note":"Department only applies if 'department' type is selected"},{"type":"range","id":"items_per_row","min":3,"max":5,"step":1,"unit":"","label":"Items per row","info":"Maximum items allowed per row"},{"id":"layout","type":"select","options":[{"value":"grid","text":"Grid View"},{"value":"horizontal","text":"Horizontal View"}],"label":"Layout","info":"Alignment of content"},{"type":"text","id":"cta_text","label":"CTA Text"}],"blocks":[{"type":"brand_item","name":"Brand Item","props":[{"type":"brand","id":"brand","label":"Select Brand"}]}],"name":"brands_listing","label":"Brands Listing"},{"props":[{"type":"text","id":"title","label":"Title"},{"type":"range","id":"margin_top","min":0,"max":1000,"step":1,"unit":"px","label":"Section Top Margin"},{"type":"range","id":"margin_bottom","min":0,"max":1000,"step":1,"unit":"px","label":"Section Bottom Margin"},{"type":"radio","id":"collection_type","options":[{"value":"all","text":"All"},{"value":"handpicked","text":"Handpicked"}]},{"type":"text","id":"tags_filter","label":"Filter by tags","info":"Filter by Tags "},{"type":"range","id":"items_per_row","min":3,"max":5,"step":1,"unit":"","label":"Max items per row","info":"Maximum items allowed per row"},{"id":"layout","type":"select","options":[{"value":"grid","text":"Grid View"},{"value":"horizontal","text":"Horizontal View"}],"label":"Layout","info":"Alignment of content"},{"type":"text","id":"cta_text","label":"CTA Text"}],"blocks":[{"type":"collection-item","name":"collection Item","props":[{"type":"collection","id":"collection","label":"Select Collection"}]}],"name":"collections_listing","label":"Collections Listing"},{"props":[{"type":"code","id":"code","label":"Custom HTML","info":"Add Your custom HTML Code below. You can also use the full screen icon to open a code editor and add your code"},{"type":"range","id":"margin_top","min":0,"max":1000,"step":1,"unit":"px","label":"Section Top Margin"},{"type":"range","id":"margin_bottom","min":0,"max":1000,"step":1,"unit":"px","label":"Section Bottom Margin"}],"blocks":[],"name":"custom_html","label":"Custom HTML"},{"props":[{"type":"extension","id":"extension","label":"Extension Positions","info":"Handle extension in these positions","positions":[{"value":"section_extension","text":""}]},{"type":"range","id":"margin_top","min":0,"max":1000,"step":1,"unit":"px","label":"Section Top Margin"},{"type":"range","id":"margin_bottom","min":0,"max":1000,"step":1,"unit":"px","label":"Section Bottom Margin"}],"blocks":[],"name":"section_extension","label":"Extensions"},{"props":[{"type":"text","id":"title","label":"Title"},{"type":"range","id":"margin_top","min":0,"max":1000,"step":1,"unit":"px","label":"Section Top Margin"},{"type":"range","id":"margin_bottom","min":0,"max":1000,"step":1,"unit":"px","label":"Section Bottom Margin"},{"type":"collection","id":"collection","label":"Collection","info":"Select a collection to display its products"},{"type":"range","id":"items_per_row","min":2,"max":5,"step":1,"unit":"","label":"Products per row","info":"Maximum items allowed per row"},{"id":"layout","type":"select","options":[{"value":"grid","text":"Grid View"},{"value":"horizontal","text":"Horizontal View"}],"label":"Layout","info":"Alignment of content"},{"type":"checkbox","id":"autoplay","label":"AutoPlay Slides","info":"Check to autoplay slides"},{"type":"range","id":"slide_interval","min":1,"max":10,"step":1,"unit":"sec","label":"Change slides after every","info":"Autoplay slide duration"}],"blocks":[],"name":"featured_collection","label":"Featured Collection"},{"props":[{"id":"image","type":"image_picker","label":"Hero Image"},{"type":"range","id":"margin_top","min":0,"max":1000,"step":1,"unit":"px","label":"Section Top Margin"},{"type":"range","id":"margin_bottom","min":0,"max":1000,"step":1,"unit":"px","label":"Section Bottom Margin"},{"id":"overlay_layout","type":"select","options":[{"value":"left","text":"Align Left"},{"value":"center","text":"Align Center"},{"value":"right","text":"Align Right"}],"label":"Overlay Layout","info":"Alignment of overlay content"},{"type":"image_picker","id":"overlay_image","label":"Overlay image","info":"Overlay Image"},{"type":"text","id":"overlay_text","label":"Overlay Text"},{"type":"color","id":"text_color","label":"Text Color"},{"type":"url","id":"button_link","label":"Redirect Link"},{"type":"text","id":"button_text","label":"Button Text"},{"type":"checkbox","id":"full_width","label":"Full width","info":"Check to allow items to take entire width of the viewport"},{"type":"checkbox","id":"fullscreen_image","label":"Fullscreen Banner ","info":"Check to allow items to take entire viewport"}],"blocks":[],"name":"hero_image","label":"Hero Image"},{"props":[{"type":"video","id":"videoFile","label":"Primary Video"},{"id":"videoUrl","type":"text","label":"Video URL","info":"Supports MP4 Video & Youtube Video URL"},{"type":"checkbox","id":"autoplay","label":"Autoplay","info":"Check to enable autoplay (Video will be muted if autoplay is active)"},{"type":"checkbox","id":"hidecontrols","label":"Hide Video Controls","info":"check to disable video controls"},{"type":"checkbox","id":"showloop","label":"Play Video in Loop","info":"check to disable Loop"},{"type":"text","id":"title","label":"Heading"},{"id":"coverUrl","type":"image_picker","label":"Thumbnail Image"}],"blocks":[],"name":"hero_video-v2","label":"Hero Video V2"},{"props":[{"id":"video_url","type":"text","label":"Video URL","info":"Supports MP4 Video & Youtube Video URL"},{"type":"range","id":"margin_top","min":0,"max":1000,"step":1,"unit":"px","label":"Section Top Margin"},{"type":"range","id":"margin_bottom","min":0,"max":1000,"step":1,"unit":"px","label":"Section Bottom Margin"},{"type":"checkbox","id":"autoplay","label":"Autoplay","info":"Check to enable autoplay (Video will be muted if autoplay is active)"},{"type":"checkbox","id":"controls","label":"Video Controls","info":"Uncheck to disable video controls"},{"type":"checkbox","id":"full_width","label":"Full width","info":"Check to allow items to take entire width of the viewport"},{"type":"checkbox","id":"bg_video","label":"Video In Background","info":"Use video in background with overlay (Overlay Image & Video Controls will be disabled by default on website)"},{"type":"select","id":"size","options":[{"value":"small","text":"Small"},{"value":"medium","text":"Medium"},{"value":"large","text":"Large"},{"value":"adapt","text":"Adapt"},{"value":"fullscreen","text":"Fullscreen"}],"label":"Video Height","info":"Height of Video"},{"type":"checkbox","id":"enable_overlay_image","label":"Enable Overlay Image"},{"id":"cover_url","type":"image_picker","label":"Video Overlay Image"},{"type":"checkbox","id":"enable_overlay_color","label":"Enable Overlay Colour"},{"type":"color","id":"overlay_color","label":"Overlay Color"},{"type":"range","id":"overlay_opacity","min":0,"max":1,"step":0.1,"unit":"","label":"Overlay Opacity"},{"type":"select","id":"overlay_size","options":[{"value":"container","text":"Container (Default)"},{"value":"content","text":"Content"}],"label":"Overlay Size"},{"id":"overlay_position","type":"select","options":[{"value":"top-left","text":"Top Left"},{"value":"top-center","text":"Top Center"},{"value":"top-right","text":"Top Right"},{"value":"center-left","text":"Center Left"},{"value":"center-center","text":"Center (Default)"},{"value":"center-right","text":"Center Right"},{"value":"bottom-left","text":"Bottom Left"},{"value":"bottom-center","text":"Bottom Center"},{"value":"bottom-right","text":"Bottom right"}],"label":"Overlay position","info":"Alignment of Overlay content(heading, sub-heading, button)"},{"type":"text","id":"heading","label":"Heading"},{"type":"color","id":"heading_color","label":"Heading Text Color"},{"type":"text","id":"sub_heading","label":"Sub-heading"},{"type":"color","id":"sub_heading_color","label":"Sub-heading Text Color"},{"type":"url","id":"button_link","label":"Redirect Link"},{"type":"text","id":"button_text","label":"Button Text"}],"blocks":[],"name":"hero_video","label":"Hero Video"},{"props":[{"type":"text","id":"title","label":"Title"},{"type":"range","id":"margin_top","min":0,"max":1000,"step":1,"unit":"px","label":"Section Top Margin"},{"type":"range","id":"margin_bottom","min":0,"max":1000,"step":1,"unit":"px","label":"Section Bottom Margin"},{"id":"layout","type":"select","options":[{"value":"grid","text":"Grid View"},{"value":"horizontal","text":"Horizontal View"}],"label":"Layout","info":"Alignment of content"},{"type":"range","id":"item_count","min":3,"max":4,"step":1,"unit":"","label":"No of items","info":"Maximum items allowed per row for Horizontal view, for gallery max 5 are viewable and only 5 blocks are required"},{"type":"text","id":"cta_text","label":"CTA Text"},{"type":"url","id":"cta_link","label":"CTA Link","info":"Link to redirect"},{"type":"checkbox","id":"full_width","label":"Full width","info":"Check to allow items to take entire width of the viewport"}],"blocks":[{"type":"gallery_image","name":"Image","props":[{"type":"image_picker","id":"image","label":"Gallery Image"},{"type":"text","id":"caption","label":"Image Caption"},{"type":"url","id":"link","label":"Link","info":"Link to redirect"}]}],"name":"image_gallery","label":"Image Gallery","preset":{"blocks":[{"name":"Image"},{"name":"Image"},{"name":"Image"},{"name":"Image"}]}},{"props":[{"type":"text","id":"title","label":"Title"},{"type":"range","id":"margin_top","min":0,"max":1000,"step":1,"unit":"px","label":"Section Top Margin"},{"type":"range","id":"margin_bottom","min":0,"max":1000,"step":1,"unit":"px","label":"Section Bottom Margin"},{"type":"checkbox","id":"autoplay","label":"AutoPlay Slides","info":"Check to autoplay slides"},{"type":"range","id":"slide_interval","min":1,"max":10,"step":1,"unit":"sec","label":"Change slides after every","info":"Autoplay slide duration"},{"type":"select","id":"slide_height","options":[{"value":"adapt","text":"Adapt to first image"},{"value":"small","text":"Small"},{"value":"medium","text":"Medium"},{"value":"large","text":"Large"}],"label":"Slide height","info":"Size of the slide"},{"type":"checkbox","id":"full_width","label":"Full width","info":"Check to allow items to take entire width of the viewport"}],"blocks":[{"type":"image_slide","name":"Slide","props":[{"type":"image_picker","id":"image","label":"Image"},{"type":"url","id":"slide_link","label":"Slide Link"}]}],"name":"image_slideshow","label":"Image Slideshow","preset":{"blocks":[{"name":"Slide"},{"name":"Slide"},{"name":"Slide"}]}},{"props":[{"type":"image_picker","id":"image","label":"Image"},{"id":"video","type":"url","label":"Video"},{"type":"range","id":"margin_top","min":0,"max":1000,"step":1,"unit":"px","label":"Section Top Margin"},{"type":"range","id":"margin_bottom","min":0,"max":1000,"step":1,"unit":"px","label":"Section Bottom Margin"},{"id":"cover","type":"url","label":"Video Cover Image"},{"type":"select","id":"media_alignment","options":[{"value":"left","text":"Left"},{"value":"center","text":"Center"},{"value":"right","text":"Right"}],"label":"Media Alignment"},{"type":"text","id":"heading","label":"Heading"},{"type":"text","id":"text Pair large text with an image to give focus to your chosen product, collection, or blog post. Add details on availability, style, or even provide a review.","label":"Text"},{"type":"select","id":"text_alignment","options":[{"value":"left","text":"Left"},{"value":"center","text":"Center"},{"value":"right","text":"Right"}],"label":"Text Alignment"}],"blocks":[],"name":"media_with_text","label":"Media with text"},{"props":[{"type":"text","id":"title","label":"Title"},{"type":"range","id":"margin_top","min":0,"max":1000,"step":1,"unit":"px","label":"Section Top Margin"},{"type":"range","id":"margin_bottom","min":0,"max":1000,"step":1,"unit":"px","label":"Section Bottom Margin"},{"type":"checkbox","id":"autoplay","label":"AutoPlay Slides"},{"type":"range","id":"slide_interval","min":1,"max":10,"step":1,"unit":"sec","label":"Change slides every"}],"blocks":[{"type":"testimonial","name":"Testimonial","props":[{"type":"textarea","id":"testimonialText","label":"Text for Testimonial","info":"Text for testimonial","placeholder":"Text"},{"type":"text","id":"author_name","label":"Author name"},{"type":"text","id":"author_description","label":"Author Description"},{"type":"image_picker","id":"author_image","label":"Author Image"}]}],"name":"testimonials","label":"Testimonial","preset":{"blocks":[{"name":"Testimonial"},{"name":"Testimonial"},{"name":"Testimonial"}]}}],"src":"https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/organization/64aec4634bc407961ed265c5/theme/assets/Gpbt5naNG-archive.zip"}},"UpdateThemeNameRequestBodyExample1":{"value":{"name":"Emerge"}},"UpdateThemeNameRequestBodyExample2":{"value":{"name":"Astra"}},"ThemeUpgradableResponseExapmple1":{"value":{"upgrade":false,"versions":{"parentTheme":"1.0.153","appliedTheme":"1.0.153"},"message":"Theme already upgraded"}},"ThemeUpgradableResponseExapmple2":{"value":{"upgrade":true,"versions":{"parentTheme":"2.0.0","appliedTheme":"1.0.153"},"message":"Upgrade avilable"}},"AvailablePageExample":{"value":{"path":"","type":"system","seo":{"title":"","description":"","canonical_url":"","breadcrumbs":[],"sitemap":{"priority":0.5,"frequency":"never"},"meta_tags":[],"_id":"60210832d7e98115b013f6ac"},"props":[],"_id":"60ab5ca6d572fed64294eafc","sections":[{"blocks":[],"predicate":{"screen":{"mobile":false,"desktop":false,"tablet":false},"user":{"authenticated":true,"anonymous":true},"route":{"selected":"none","exactURL":"","query":{"utm":"facebook"}}},"name":"customHtml","props":{"code":{"type":"code","value":"<p style=\"text-align:right;\"><a href=\"tel:+919820204442\"><img src=\"https://dabuttonfactory.com/button.png?t=For+any+queries%2C+call%3A+%2B91+98202+04442&f=Open+Sans-Bold&ts=21&tc=fff&hp=20&vp=15&c=round&bgt=unicolored&bgc=7043f7\"/> </a></p>"}}},{"blocks":[],"predicate":{"screen":{"mobile":true,"desktop":true,"tablet":true},"user":{"authenticated":true,"anonymous":true},"route":{"selected":"none","exactURL":"","query":{"udm":"vivek"}}},"name":"brands-listing","props":{"title":{"type":"text","value":"Popular rrrrr"},"header":{"type":"header"},"brand_type":{"value":"all","type":"radio"},"department":{"type":"department"},"item_count":{"value":5,"type":"range"},"layout":{"value":"horizontal","type":"select"},"view_all":{"value":false,"type":"checkbox"}}},{"blocks":[{"type":"product","name":"Product","props":{"product":{"type":"product"}}},{"type":"product","name":"Product","props":{"product":{"type":"product"}}},{"type":"product","name":"Product","props":{"product":{"type":"product"}}},{"type":"product","name":"Product","props":{"product":{"type":"product"}}}],"predicate":{"screen":{"mobile":true,"desktop":true,"tablet":true},"user":{"authenticated":false,"anonymous":true},"route":{"selected":"none","exactURL":""}},"name":"featuredProducts","props":{"heading":{"value":"Featured Products","type":"text"},"item_count":{"type":"range","value":4},"full_width":{"value":false,"type":"checkbox"}},"preset":{"blocks":[{"name":"Product"},{"name":"Product"},{"name":"Product"},{"name":"Product"}]}},{"blocks":[],"predicate":{"screen":{"mobile":true,"desktop":true,"tablet":true},"user":{"authenticated":true,"anonymous":true},"route":{"selected":"none","exactURL":"","query":{"":""}}},"name":"categoryListPage","props":{"heading":{"type":"text","value":"Explore Categories"},"layout":{"type":"select","value":"grid"},"item_count":{"value":5,"type":"range"},"view_all":{"value":false,"type":"checkbox"}}},{"blocks":[],"predicate":{"screen":{"mobile":true,"desktop":true,"tablet":true},"user":{"authenticated":true,"anonymous":true},"route":{"selected":"none","exactURL":"","query":{"":""}}},"name":"heroBanner","props":{"ctaLink":{"type":"url","value":"https://uniket.hostx0.de/about-us"}}},{"blocks":[],"predicate":{"screen":{"mobile":true,"desktop":true,"tablet":true},"user":{"authenticated":true,"anonymous":true},"route":{"selected":"none","exactURL":"","query":{"":""}}},"name":"imageBanner","props":{"image":{"value":"","type":"image_picker"},"full_width":{"value":false,"type":"checkbox"},"overlayLayout":{"value":"left","type":"select"},"overlayImage":{"value":"","type":"image_picker"},"text":{"value":"","type":"text"},"text_color":{"value":"#000","type":"color"},"ctaLink":{"value":"","type":"url"},"ctaText":{"value":"","type":"text"},"layout":{"type":"select","value":"full"},"height":{"type":"select","value":"h-auto"}}},{"blocks":[],"predicate":{"screen":{"mobile":true,"desktop":true,"tablet":true},"user":{"authenticated":true,"anonymous":true},"route":{"selected":"none","exactURL":""}},"name":"brands-listing","props":{"title":{"type":"text","value":"asdfasdf"},"header":{"type":"header"},"brand_type":{"value":"all","type":"radio"},"department":{"type":"department"},"item_count":{"value":5,"type":"range"},"layout":{"value":"horizontal","type":"select"},"view_all":{"value":false,"type":"checkbox"}}}],"value":"home","text":"Home","theme":"5fb3ee4194a5181feeeba8e5","sections_meta":[],"__v":9}},"AllAvailablePagesExample":{"value":{"pages":[{"path":"products","type":"system","seo":{"title":"","description":"","breadcrumbs":[],"sitemap":{"priority":0.5,"frequency":"never"},"meta_tags":[],"_id":"60210832d7e981639e13f6b2"},"_id":"60ab5ca6d572fed64294eb0e","value":"product-listing","text":"Product Listing","theme":"5fb3ee4194a5181feeeba8e5","sections_meta":[],"__v":9},{"path":"collection","type":"system","seo":{"title":"","description":"","canonical_url":"","breadcrumbs":[],"sitemap":{"priority":0.5,"frequency":"never"},"meta_tags":[],"_id":"60210832d7e981fc5d13f6b9"},"_id":"60ab5ca6d572fed64294eaf9","text":"Collection Listing","value":"collection-listing","theme":"5fb3ee4194a5181feeeba8e5","sections_meta":[],"__v":9},{"path":"compare","type":"system","seo":{"title":"","description":"","canonical_url":"","breadcrumbs":[],"sitemap":{"priority":0.5,"frequency":"never"},"meta_tags":[],"_id":"60210832d7e981cbca13f6b1"},"_id":"60ab5ca6d572fed64294eb0b","value":"compare-products","text":"Compare Products","theme":"5fb3ee4194a5181feeeba8e5","sections_meta":[],"__v":9},{"path":"cart/bag","type":"system","seo":{"title":"","description":"","canonical_url":"","breadcrumbs":[],"sitemap":{"priority":0.5,"frequency":"never"},"meta_tags":[],"_id":"60210832d7e9812fdf13f6ae"},"_id":"60ab5ca6d572fed64294eb02","value":"cart-landing","text":"Cart Landing","theme":"5fb3ee4194a5181feeeba8e5","sections_meta":[],"__v":9},{"path":"product","type":"system","seo":{"title":"","description":"","canonical_url":"","breadcrumbs":[],"sitemap":{"priority":0.5,"frequency":"never"},"meta_tags":[],"_id":"60210832d7e9815c9713f6ab"},"_id":"60ab5ca6d572fed64294eaf6","text":"Product Description","value":"product-description","theme":"5fb3ee4194a5181feeeba8e5","sections_meta":[],"__v":9},{"path":"product/:slug/reviews","type":"system","seo":{"title":"","description":"","canonical_url":"","breadcrumbs":[],"sitemap":{"priority":0.5,"frequency":"never"},"meta_tags":[],"_id":"60ab5ca6d572fed64294eb24"},"_id":"60ab5ca6d572fed64294eb25","sections_meta":[],"value":"product-reviews","text":"Product Reviews","theme":"5fb3ee4194a5181feeeba8e5","__v":9},{"path":"blog","type":"system","seo":{"title":"","description":"","canonical_url":"","breadcrumbs":[],"sitemap":{"priority":0.5,"frequency":"never"},"meta_tags":[],"_id":"60ab5ca6d572fed64294eb22"},"_id":"60ab5ca6d572fed64294eb23","sections_meta":[],"value":"blog","text":"Blog","theme":"5fb3ee4194a5181feeeba8e5","__v":9},{"path":"sections/cookie","type":"sections","seo":{"title":"","description":"","canonical_url":"","breadcrumbs":[],"sitemap":{"priority":0.5,"frequency":"never"},"meta_tags":[],"_id":"60210832d7e9814fed13f6b5"},"_id":"60ab5ca6d572fed64294eb17","text":"cookie","value":"cookie","theme":"5fb3ee4194a5181feeeba8e5","sections_meta":[],"__v":9},{"path":"sections/vivek","type":"sections","seo":{"title":"","description":"","canonical_url":"","breadcrumbs":[],"sitemap":{"priority":0.5,"frequency":"never"},"meta_tags":[],"_id":"60210832d7e981b32713f6b6"},"_id":"60ab5ca6d572fed64294eb1a","text":"vivek","value":"vivek","theme":"5fb3ee4194a5181feeeba8e5","sections_meta":[],"__v":9},{"path":"about-us","type":"system","seo":{"title":"","description":"","canonical_url":"","breadcrumbs":[],"sitemap":{"priority":0.5,"frequency":"never"},"meta_tags":[],"_id":"60ab5ca6d572fed64294eb28"},"_id":"60ab5ca6d572fed64294eb29","sections_meta":[],"value":"about-us","text":"About Us","theme":"5fb3ee4194a5181feeeba8e5","__v":9},{"path":"wishlist","type":"system","seo":{"title":"","description":"","canonical_url":"","breadcrumbs":[],"sitemap":{"priority":0.5,"frequency":"never"},"meta_tags":[],"_id":"60210832d7e981dd2d13f6b3"},"_id":"60ab5ca6d572fed64294eb11","value":"wishlist","text":"Wishlist","theme":"5fb3ee4194a5181feeeba8e5","sections_meta":[],"__v":9},{"path":"product/:slug/add-review","type":"system","seo":{"title":"","description":"","canonical_url":"","breadcrumbs":[],"sitemap":{"priority":0.5,"frequency":"never"},"meta_tags":[],"_id":"60ab5ca6d572fed64294eb26"},"_id":"60ab5ca6d572fed64294eb27","sections_meta":[],"value":"add-product-review","text":"Add Product Review","theme":"5fb3ee4194a5181feeeba8e5","__v":9},{"path":"brands","type":"system","seo":{"title":"","description":"","canonical_url":"","breadcrumbs":[],"sitemap":{"priority":0.5,"frequency":"never"},"meta_tags":[],"_id":"60210832d7e981161a13f6ad"},"_id":"60ab5ca6d572fed64294eaff","value":"brands","text":"Brands","theme":"5fb3ee4194a5181feeeba8e5","sections_meta":[],"__v":9},{"path":"","type":"system","seo":{"title":"","description":"","canonical_url":"","breadcrumbs":[],"sitemap":{"priority":0.5,"frequency":"never"},"meta_tags":[],"_id":"60210832d7e98115b013f6ac"},"_id":"60ab5ca6d572fed64294eafc","value":"home","text":"Home","theme":"5fb3ee4194a5181feeeba8e5","sections_meta":[],"__v":9},{"path":"collections","type":"system","seo":{"title":"","description":"","canonical_url":"","breadcrumbs":[],"sitemap":{"priority":0.5,"frequency":"never"},"meta_tags":[],"_id":"60210832d7e981ad0b13f6b0"},"_id":"60ab5ca6d572fed64294eb08","value":"collections","text":"Collections","theme":"5fb3ee4194a5181feeeba8e5","sections_meta":[],"__v":9},{"path":"categories","type":"system","seo":{"title":"","description":"","canonical_url":"","breadcrumbs":[],"sitemap":{"priority":0.5,"frequency":"never"},"meta_tags":[],"_id":"60210832d7e981872c13f6af"},"_id":"60ab5ca6d572fed64294eb05","value":"categories","text":"Categories","theme":"5fb3ee4194a5181feeeba8e5","sections_meta":[],"__v":9},{"path":"sections/test","type":"sections","seo":{"title":"","description":"","canonical_url":"","breadcrumbs":[],"sitemap":{"priority":0.5,"frequency":"never"},"meta_tags":[],"_id":"60210832d7e98177f713f6b4"},"_id":"60ab5ca6d572fed64294eb14","text":"Test","value":"test","theme":"5fb3ee4194a5181feeeba8e5","sections_meta":[],"__v":9},{"path":"sections/vinit","type":"sections","seo":{"title":"","description":"","canonical_url":"","breadcrumbs":[],"sitemap":{"priority":0.5,"frequency":"never"},"meta_tags":[],"_id":"60210832d7e98170b813f6b8"},"_id":"60ab5ca6d572fed64294eb20","text":"vinit","value":"vinit","theme":"5fb3ee4194a5181feeeba8e5","sections_meta":[],"__v":9},{"path":"sections/maggie","type":"sections","seo":{"title":"","description":"","canonical_url":"","breadcrumbs":[],"sitemap":{"priority":0.5,"frequency":"never"},"meta_tags":[],"_id":"60210832d7e981469613f6b7"},"_id":"60ab5ca6d572fed64294eb1d","text":"maggie","value":"maggie","theme":"5fb3ee4194a5181feeeba8e5","sections_meta":[],"__v":9}]}},"FontsResponse":{"value":{"kind":"webfonts#webfontList","items":{"family":"ABeeZee","variants":["regular","italic"],"subsets":["latin"],"version":"v14","last_modified":"2020-09-02","files":{"regular":"http://fonts.gstatic.com/s/abeezee/v14/esDR31xSG-6AGleN6tKukbcHCpE.ttf","italic":"http://fonts.gstatic.com/s/abeezee/v14/esDT31xSG-6AGleN2tCklZUCGpG-GQ.ttf"}}}},"SessionListResponse":{"value":{"items":[{"session_id":"134","user_agent":"134","ip":"134","domain":"134","expire_in":"134"},{"session_id":"134","user_agent":"134","ip":"134","domain":"134","expire_in":"134"}]}},"SessionDeleteResponse":{"value":{"user_id":"61f02c3dcc701256044ed6c0","session_id":"sess:123"}},"SessionsDeleteResponse":{"value":{"user_id":"61f02c3dcc701256044ed6c0","session_ids":["sess:123","sess:456"]}},"CustomersListResponse":{"value":{"items":[{"_id":"000000000000000023106198","gender":"male","active":true,"emails":[{"active":true,"primary":true,"verified":true,"email":"raaz.crzy@gmail.com"}],"username":"raaz_crzy_gmail_com_63747_23106198","__v":7,"debug":{"source":"deadlock","platform":"000000000000000000000003"},"dob":"1995-07-23T00:00:00.000Z","id":"000000000000000023106198","account_type":"user","profile_pic_url":"https://hdn-1.fynd.com/user/profile/original/000000000000000023106198/1586498418772.jpg","first_name":"Prince","last_name":"Raj","phone_numbers":[{"active":true,"primary":true,"verified":true,"phone":"7008963113","country_code":91}],"created_at":"2019-05-15T14:07:52.872Z","updated_at":"2020-09-21T06:38:41.388Z","has_old_password_hash":false}],"page":{"type":"number","current":1,"size":10,"item_total":0,"has_next":false}}}}}}