{"openapi":"3.0.0","info":{"title":"StagingPro API","version":"1.0","description":"REST API for StagingPro, the Vortex IQ app for BigCommerce staging. It migrates store data and themes between a production store and its staging copies, schedules product and promotion updates, and reports progress, errors and history for each job. Authenticate with POST /Login, then send the returned token as a Bearer token. The Vortex IQ workspace (audits, findings, KPIs) has no public REST API; agents read it through the workspace MCP server described at https://www.vortexiq.ai/.well-known/mcp.json.","contact":{"name":"StagingPro support","url":"https://www.stagingpro.com/","email":"hello@stagingpro.com"},"x-source":"Exported from the StagingPro developer portal (APIMatic) on 2026-10-11."},"servers":[{"url":"https://api.stagingpro.com/v1/api","variables":{}}],"paths":{"/BigcFunction/GetStoreDataSummary":{"get":{"tags":["Content Migration"],"summary":"Get Store Data Summary","operationId":"GetStoreDataSummary","parameters":[{"name":"storeId","in":"query","description":"","required":true,"style":"form","explode":true,"schema":{"type":"string","example":"hd2j3gh4ye"}},{"name":"Content-Type","in":"header","description":"","required":true,"style":"simple","schema":{"enum":["application/json"],"type":"string","example":"application/json"}}],"responses":{"200":{"description":"","headers":{},"content":{"text/plain":{"schema":{"type":"object","example":{"ContentData":{"Pages":47,"Widgets":2,"StoreCoupons":11,"Banners":11,"AbandonedCartEmailTemplates":5,"EmailTemplates":13,"BlogPosts":6,"ActiveTheme":1},"ProductData":{"Brands":97,"Categories":237,"Products":1938,"ProductReviews":-1,"PriceLists":5,"PriceListAssignments":7,"PriceListRecords":-1,"Promotions":5},"CustomerData":{"CustomerGroups":9,"Customers":115,"CustomerAttributes":2},"OrderData":{"OrdersByStatus":[{"Status":"Incomplete","OrderCount":7},{"Status":"Pending","OrderCount":51},{"Status":"Awaiting Payment","OrderCount":20},{"Status":"Awaiting Fulfillment","OrderCount":287},{"Status":"Awaiting Pickup","OrderCount":1},{"Status":"Partially Shipped","OrderCount":1},{"Status":"Completed","OrderCount":15},{"Status":"Shipped","OrderCount":27},{"Status":"Cancelled","OrderCount":3},{"Status":"Refunded","OrderCount":31},{"Status":"Manual Verification Required","OrderCount":1}],"Orders":444,"GlobalOrderSettings":2,"GiftCertificates":5},"StoreSettings":{"EmailStatuses":12,"SearchFiltersEnabled":25,"SearchContextualFilters":3,"StoreLocale":3,"StoreFrontRobots":1,"StoreFrontSearch":4,"StoreFrontSeo":4,"StoreFrontStatus":3,"WebAnalyticsProviders":6,"CatalogSettings":2,"InventoryNotifications":2,"StoreLogoSettings":4,"StoreProfile":1,"StorefrontCategorySettings":3,"StorefrontProductSettings":11,"StorefrontSecuritySettings":4,"ShippingZones":5,"ShippingMethods":-1},"MultiStoreData":{"Channels":["Monic Fashions (bigcommerce)","Google United Kingdom by CODISTO-9192 (google_shopping)","Amazon.co.uk - Moinc- by CODISTO-8613 (amazon)","Monic Store 2 (bigcommerce)"],"ChannelsOrderSettings":2,"ChannelsCustomerSettings":6},"B2BData":{"Companies":5,"Addresses":7,"Users":13,"Orders":11,"SuperAdmins":3,"Quotes":2,"ShoppingList":-1,"Invoices":0}}},"example":{"ContentData":{"Pages":47,"Widgets":2,"StoreCoupons":11,"Banners":11,"AbandonedCartEmailTemplates":5,"EmailTemplates":13,"BlogPosts":6,"ActiveTheme":1},"ProductData":{"Brands":97,"Categories":237,"Products":1938,"ProductReviews":-1,"PriceLists":5,"PriceListAssignments":7,"PriceListRecords":-1,"Promotions":5},"CustomerData":{"CustomerGroups":9,"Customers":115,"CustomerAttributes":2},"OrderData":{"OrdersByStatus":[{"Status":"Incomplete","OrderCount":7},{"Status":"Pending","OrderCount":51},{"Status":"Awaiting Payment","OrderCount":20},{"Status":"Awaiting Fulfillment","OrderCount":287},{"Status":"Awaiting Pickup","OrderCount":1},{"Status":"Partially Shipped","OrderCount":1},{"Status":"Completed","OrderCount":15},{"Status":"Shipped","OrderCount":27},{"Status":"Cancelled","OrderCount":3},{"Status":"Refunded","OrderCount":31},{"Status":"Manual Verification Required","OrderCount":1}],"Orders":444,"GlobalOrderSettings":2,"GiftCertificates":5},"StoreSettings":{"EmailStatuses":12,"SearchFiltersEnabled":25,"SearchContextualFilters":3,"StoreLocale":3,"StoreFrontRobots":1,"StoreFrontSearch":4,"StoreFrontSeo":4,"StoreFrontStatus":3,"WebAnalyticsProviders":6,"CatalogSettings":2,"InventoryNotifications":2,"StoreLogoSettings":4,"StoreProfile":1,"StorefrontCategorySettings":3,"StorefrontProductSettings":11,"StorefrontSecuritySettings":4,"ShippingZones":5,"ShippingMethods":-1},"MultiStoreData":{"Channels":["Monic Fashions (bigcommerce)","Google United Kingdom by CODISTO-9192 (google_shopping)","Amazon.co.uk - Moinc- by CODISTO-8613 (amazon)","Monic Store 2 (bigcommerce)"],"ChannelsOrderSettings":2,"ChannelsCustomerSettings":6},"B2BData":{"Companies":5,"Addresses":7,"Users":13,"Orders":11,"SuperAdmins":3,"Quotes":2,"ShoppingList":-1,"Invoices":0}}}}}},"deprecated":false}},"/BigcFunction/GetMigrateStoreDataProgressStatus":{"get":{"tags":["Content Migration"],"summary":"Get Migrate Store Data Progress Status","operationId":"GetMigrateStoreDataProgressStatus","parameters":[{"name":"destinationStoreId","in":"query","description":"","required":true,"style":"form","explode":true,"schema":{"type":"string","example":"fr4k54h1ye"}},{"name":"migrationId","in":"query","description":"","required":true,"style":"form","explode":true,"schema":{"type":"string","example":"B1A4F5FB-9D24-4051-973A-D08927E346D1"}},{"name":"Content-Type","in":"header","description":"","required":true,"style":"simple","schema":{"enum":["application/json"],"type":"string","example":"application/json"}}],"responses":{"200":{"description":"","headers":{},"content":{"text/plain":{"schema":{"type":"object","example":{"MigrationId":"b1a4f5fb-9d24-4051-973a-d08927e346e2","SourceStoreId":"hd2j3gh4ye","DestinationStoreId":"fr4k54h1ye","Status":"Completed","PercentCompleted":100,"Comment":"Publish Completed","ModifiedDate":"2022-04-22T10:52:33.353","IsScheduledRequest":true,"ScheduleDateTime":"2022-09-09T19:00:00"}},"example":{"MigrationId":"b1a4f5fb-9d24-4051-973a-d08927e346e2","SourceStoreId":"hd2j3gh4ye","DestinationStoreId":"fr4k54h1ye","Status":"Completed","PercentCompleted":100,"Comment":"Publish Completed","ModifiedDate":"2022-04-22T10:52:33.353","IsScheduledRequest":true,"ScheduleDateTime":"2022-09-09T19:00:00"}}}}},"deprecated":false}},"/BigcFunction/GetMigrateStoreDataEntitiesStatus":{"get":{"tags":["Content Migration"],"summary":"Get Migrate Store Data Entities Status","operationId":"GetMigrateStoreDataEntitiesStatus","parameters":[{"name":"destinationStoreId","in":"query","description":"","required":true,"style":"form","explode":true,"schema":{"type":"string","example":"fr4k54h1ye"}},{"name":"migrationId","in":"query","description":"","required":true,"style":"form","explode":true,"schema":{"type":"string","example":"7F3BF7A6-EA6F-4D84-8054-7F9F4150E17D"}},{"name":"Content-Type","in":"header","description":"","required":true,"style":"simple","schema":{"enum":["application/json"],"type":"string","example":"application/json"}}],"responses":{"200":{"description":"","headers":{},"content":{"text/plain":{"schema":{"type":"object","example":[{"MigrationId":"7f3bf7a6-ea6f-4d84-8054-7f9f4150e18e","SourceStoreId":"hd2j3gh4ye","DestinationStoreId":"fr4k54h1ye","EntityName":"Brands","SourceCount":55,"DestinationCount":55,"Status":"Completed","ModifiedDate":"2022-04-17T15:11:53.237","Error":null},{"MigrationId":"7f3bf7a6-ea6f-4d84-8054-7f9f4150e18e","SourceStoreId":"hd2j3gh4ye","DestinationStoreId":"fr4k54h1ye","EntityName":"Categories","SourceCount":122,"DestinationCount":122,"Status":"Completed","ModifiedDate":"2022-04-17T15:12:30.207","Error":null},{"MigrationId":"7f3bf7a6-ea6f-4d84-8054-7f9f4150e18e","SourceStoreId":"hd2j3gh4ye","DestinationStoreId":"fr4k54h1ye","EntityName":"Products","SourceCount":537,"DestinationCount":537,"Status":"Completed","ModifiedDate":"2022-04-17T15:19:36.643","Error":null},{"MigrationId":"7f3bf7a6-ea6f-4d84-8054-7f9f4150e18e","SourceStoreId":"hd2j3gh4ye","DestinationStoreId":"fr4k54h1ye","EntityName":"CustomerGroups","SourceCount":6,"DestinationCount":6,"Status":"Completed","ModifiedDate":"2022-04-17T15:19:38.083","Error":null},{"MigrationId":"7f3bf7a6-ea6f-4d84-8054-7f9f4150e18e","SourceStoreId":"hd2j3gh4ye","DestinationStoreId":"fr4k54h1ye","EntityName":"Customers","SourceCount":112,"DestinationCount":100,"Status":"Completed","ModifiedDate":"2022-04-17T15:20:04.023","Error":"https://api.stagingpro.com/v1/api/BigcFunction/GetEntityErrors?MigrationId=7f3bf7a6-ea6f-4d84-8054-7f9f4150e18e&EntityName=Customers"},{"MigrationId":"7f3bf7a6-ea6f-4d84-8054-7f9f4150e18e","SourceStoreId":"hd2j3gh4ye","DestinationStoreId":"fr4k54h1ye","EntityName":"PriceLists","SourceCount":2,"DestinationCount":1,"Status":"Completed","ModifiedDate":"2022-04-17T15:20:04.35","Error":"https://api.stagingpro.com/v1/api/BigcFunction/GetEntityErrors?MigrationId=7f3bf7a6-ea6f-4d84-8054-7f9f4150e18e&EntityName=PriceLists"},{"MigrationId":"7f3bf7a6-ea6f-4d84-8054-7f9f4150e18e","SourceStoreId":"hd2j3gh4ye","DestinationStoreId":"fr4k54h1ye","EntityName":"PriceListAssignments","SourceCount":2,"DestinationCount":1,"Status":"Completed","ModifiedDate":"2022-04-17T15:20:04.693","Error":"https://api.stagingpro.com/v1/api/BigcFunction/GetEntityErrors?MigrationId=7f3bf7a6-ea6f-4d84-8054-7f9f4150e18e&EntityName=PriceListAssignments"},{"MigrationId":"7f3bf7a6-ea6f-4d84-8054-7f9f4150e18e","SourceStoreId":"hd2j3gh4ye","DestinationStoreId":"fr4k54h1ye","EntityName":"EmailStatuses","SourceCount":12,"DestinationCount":12,"Status":"Completed","ModifiedDate":"2022-04-17T15:20:18.847","Error":null},{"MigrationId":"7f3bf7a6-ea6f-4d84-8054-7f9f4150e18e","SourceStoreId":"hd2j3gh4ye","DestinationStoreId":"fr4k54h1ye","EntityName":"SearchContextualFilters","SourceCount":3,"DestinationCount":3,"Status":"Completed","ModifiedDate":"2022-04-17T15:20:18.85","Error":null},{"MigrationId":"7f3bf7a6-ea6f-4d84-8054-7f9f4150e18e","SourceStoreId":"hd2j3gh4ye","DestinationStoreId":"fr4k54h1ye","EntityName":"SearchFiltersEnabled","SourceCount":31,"DestinationCount":31,"Status":"Completed","ModifiedDate":"2022-04-17T15:20:18.85","Error":null},{"MigrationId":"7f3bf7a6-ea6f-4d84-8054-7f9f4150e18e","SourceStoreId":"hd2j3gh4ye","DestinationStoreId":"fr4k54h1ye","EntityName":"StoreLocale","SourceCount":3,"DestinationCount":3,"Status":"Completed","ModifiedDate":"2022-04-17T15:20:18.85","Error":null},{"MigrationId":"7f3bf7a6-ea6f-4d84-8054-7f9f4150e18e","SourceStoreId":"hd2j3gh4ye","DestinationStoreId":"fr4k54h1ye","EntityName":"StoreFrontRobots","SourceCount":1,"DestinationCount":1,"Status":"Completed","ModifiedDate":"2022-04-17T15:20:18.853","Error":null},{"MigrationId":"7f3bf7a6-ea6f-4d84-8054-7f9f4150e18e","SourceStoreId":"hd2j3gh4ye","DestinationStoreId":"fr4k54h1ye","EntityName":"StoreFrontSearch","SourceCount":4,"DestinationCount":4,"Status":"Completed","ModifiedDate":"2022-04-17T15:20:18.853","Error":null},{"MigrationId":"7f3bf7a6-ea6f-4d84-8054-7f9f4150e18e","SourceStoreId":"hd2j3gh4ye","DestinationStoreId":"fr4k54h1ye","EntityName":"StoreFrontSeo","SourceCount":4,"DestinationCount":4,"Status":"Completed","ModifiedDate":"2022-04-17T15:20:18.853","Error":null},{"MigrationId":"7f3bf7a6-ea6f-4d84-8054-7f9f4150e18e","SourceStoreId":"hd2j3gh4ye","DestinationStoreId":"fr4k54h1ye","EntityName":"StoreFrontStatus","SourceCount":3,"DestinationCount":3,"Status":"Completed","ModifiedDate":"2022-04-17T15:20:18.857","Error":null},{"MigrationId":"7f3bf7a6-ea6f-4d84-8054-7f9f4150e18e","SourceStoreId":"hd2j3gh4ye","DestinationStoreId":"fr4k54h1ye","EntityName":"CatalogSettings","SourceCount":2,"DestinationCount":2,"Status":"Completed","ModifiedDate":"2022-04-17T15:20:18.86","Error":null},{"MigrationId":"7f3bf7a6-ea6f-4d84-8054-7f9f4150e18e","SourceStoreId":"hd2j3gh4ye","DestinationStoreId":"fr4k54h1ye","EntityName":"InventoryNotifications","SourceCount":2,"DestinationCount":2,"Status":"Completed","ModifiedDate":"2022-04-17T15:20:18.86","Error":null},{"MigrationId":"7f3bf7a6-ea6f-4d84-8054-7f9f4150e18e","SourceStoreId":"hd2j3gh4ye","DestinationStoreId":"fr4k54h1ye","EntityName":"WebAnalyticsProviders","SourceCount":6,"DestinationCount":6,"Status":"Completed","ModifiedDate":"2022-04-17T15:20:18.86","Error":null},{"MigrationId":"7f3bf7a6-ea6f-4d84-8054-7f9f4150e18e","SourceStoreId":"hd2j3gh4ye","DestinationStoreId":"fr4k54h1ye","EntityName":"StoreLogoSettings","SourceCount":4,"DestinationCount":4,"Status":"Completed","ModifiedDate":"2022-04-17T15:20:18.863","Error":null},{"MigrationId":"7f3bf7a6-ea6f-4d84-8054-7f9f4150e18e","SourceStoreId":"hd2j3gh4ye","DestinationStoreId":"fr4k54h1ye","EntityName":"StoreProfile","SourceCount":1,"DestinationCount":1,"Status":"Completed","ModifiedDate":"2022-04-17T15:20:18.863","Error":null}]},"example":[{"MigrationId":"7f3bf7a6-ea6f-4d84-8054-7f9f4150e18e","SourceStoreId":"hd2j3gh4ye","DestinationStoreId":"fr4k54h1ye","EntityName":"Brands","SourceCount":55,"DestinationCount":55,"Status":"Completed","ModifiedDate":"2022-04-17T15:11:53.237","Error":null},{"MigrationId":"7f3bf7a6-ea6f-4d84-8054-7f9f4150e18e","SourceStoreId":"hd2j3gh4ye","DestinationStoreId":"fr4k54h1ye","EntityName":"Categories","SourceCount":122,"DestinationCount":122,"Status":"Completed","ModifiedDate":"2022-04-17T15:12:30.207","Error":null},{"MigrationId":"7f3bf7a6-ea6f-4d84-8054-7f9f4150e18e","SourceStoreId":"hd2j3gh4ye","DestinationStoreId":"fr4k54h1ye","EntityName":"Products","SourceCount":537,"DestinationCount":537,"Status":"Completed","ModifiedDate":"2022-04-17T15:19:36.643","Error":null},{"MigrationId":"7f3bf7a6-ea6f-4d84-8054-7f9f4150e18e","SourceStoreId":"hd2j3gh4ye","DestinationStoreId":"fr4k54h1ye","EntityName":"CustomerGroups","SourceCount":6,"DestinationCount":6,"Status":"Completed","ModifiedDate":"2022-04-17T15:19:38.083","Error":null},{"MigrationId":"7f3bf7a6-ea6f-4d84-8054-7f9f4150e18e","SourceStoreId":"hd2j3gh4ye","DestinationStoreId":"fr4k54h1ye","EntityName":"Customers","SourceCount":112,"DestinationCount":100,"Status":"Completed","ModifiedDate":"2022-04-17T15:20:04.023","Error":"https://api.stagingpro.com/v1/api/BigcFunction/GetEntityErrors?MigrationId=7f3bf7a6-ea6f-4d84-8054-7f9f4150e18e&EntityName=Customers"},{"MigrationId":"7f3bf7a6-ea6f-4d84-8054-7f9f4150e18e","SourceStoreId":"hd2j3gh4ye","DestinationStoreId":"fr4k54h1ye","EntityName":"PriceLists","SourceCount":2,"DestinationCount":1,"Status":"Completed","ModifiedDate":"2022-04-17T15:20:04.35","Error":"https://api.stagingpro.com/v1/api/BigcFunction/GetEntityErrors?MigrationId=7f3bf7a6-ea6f-4d84-8054-7f9f4150e18e&EntityName=PriceLists"},{"MigrationId":"7f3bf7a6-ea6f-4d84-8054-7f9f4150e18e","SourceStoreId":"hd2j3gh4ye","DestinationStoreId":"fr4k54h1ye","EntityName":"PriceListAssignments","SourceCount":2,"DestinationCount":1,"Status":"Completed","ModifiedDate":"2022-04-17T15:20:04.693","Error":"https://api.stagingpro.com/v1/api/BigcFunction/GetEntityErrors?MigrationId=7f3bf7a6-ea6f-4d84-8054-7f9f4150e18e&EntityName=PriceListAssignments"},{"MigrationId":"7f3bf7a6-ea6f-4d84-8054-7f9f4150e18e","SourceStoreId":"hd2j3gh4ye","DestinationStoreId":"fr4k54h1ye","EntityName":"EmailStatuses","SourceCount":12,"DestinationCount":12,"Status":"Completed","ModifiedDate":"2022-04-17T15:20:18.847","Error":null},{"MigrationId":"7f3bf7a6-ea6f-4d84-8054-7f9f4150e18e","SourceStoreId":"hd2j3gh4ye","DestinationStoreId":"fr4k54h1ye","EntityName":"SearchContextualFilters","SourceCount":3,"DestinationCount":3,"Status":"Completed","ModifiedDate":"2022-04-17T15:20:18.85","Error":null},{"MigrationId":"7f3bf7a6-ea6f-4d84-8054-7f9f4150e18e","SourceStoreId":"hd2j3gh4ye","DestinationStoreId":"fr4k54h1ye","EntityName":"SearchFiltersEnabled","SourceCount":31,"DestinationCount":31,"Status":"Completed","ModifiedDate":"2022-04-17T15:20:18.85","Error":null},{"MigrationId":"7f3bf7a6-ea6f-4d84-8054-7f9f4150e18e","SourceStoreId":"hd2j3gh4ye","DestinationStoreId":"fr4k54h1ye","EntityName":"StoreLocale","SourceCount":3,"DestinationCount":3,"Status":"Completed","ModifiedDate":"2022-04-17T15:20:18.85","Error":null},{"MigrationId":"7f3bf7a6-ea6f-4d84-8054-7f9f4150e18e","SourceStoreId":"hd2j3gh4ye","DestinationStoreId":"fr4k54h1ye","EntityName":"StoreFrontRobots","SourceCount":1,"DestinationCount":1,"Status":"Completed","ModifiedDate":"2022-04-17T15:20:18.853","Error":null},{"MigrationId":"7f3bf7a6-ea6f-4d84-8054-7f9f4150e18e","SourceStoreId":"hd2j3gh4ye","DestinationStoreId":"fr4k54h1ye","EntityName":"StoreFrontSearch","SourceCount":4,"DestinationCount":4,"Status":"Completed","ModifiedDate":"2022-04-17T15:20:18.853","Error":null},{"MigrationId":"7f3bf7a6-ea6f-4d84-8054-7f9f4150e18e","SourceStoreId":"hd2j3gh4ye","DestinationStoreId":"fr4k54h1ye","EntityName":"StoreFrontSeo","SourceCount":4,"DestinationCount":4,"Status":"Completed","ModifiedDate":"2022-04-17T15:20:18.853","Error":null},{"MigrationId":"7f3bf7a6-ea6f-4d84-8054-7f9f4150e18e","SourceStoreId":"hd2j3gh4ye","DestinationStoreId":"fr4k54h1ye","EntityName":"StoreFrontStatus","SourceCount":3,"DestinationCount":3,"Status":"Completed","ModifiedDate":"2022-04-17T15:20:18.857","Error":null},{"MigrationId":"7f3bf7a6-ea6f-4d84-8054-7f9f4150e18e","SourceStoreId":"hd2j3gh4ye","DestinationStoreId":"fr4k54h1ye","EntityName":"CatalogSettings","SourceCount":2,"DestinationCount":2,"Status":"Completed","ModifiedDate":"2022-04-17T15:20:18.86","Error":null},{"MigrationId":"7f3bf7a6-ea6f-4d84-8054-7f9f4150e18e","SourceStoreId":"hd2j3gh4ye","DestinationStoreId":"fr4k54h1ye","EntityName":"InventoryNotifications","SourceCount":2,"DestinationCount":2,"Status":"Completed","ModifiedDate":"2022-04-17T15:20:18.86","Error":null},{"MigrationId":"7f3bf7a6-ea6f-4d84-8054-7f9f4150e18e","SourceStoreId":"hd2j3gh4ye","DestinationStoreId":"fr4k54h1ye","EntityName":"WebAnalyticsProviders","SourceCount":6,"DestinationCount":6,"Status":"Completed","ModifiedDate":"2022-04-17T15:20:18.86","Error":null},{"MigrationId":"7f3bf7a6-ea6f-4d84-8054-7f9f4150e18e","SourceStoreId":"hd2j3gh4ye","DestinationStoreId":"fr4k54h1ye","EntityName":"StoreLogoSettings","SourceCount":4,"DestinationCount":4,"Status":"Completed","ModifiedDate":"2022-04-17T15:20:18.863","Error":null},{"MigrationId":"7f3bf7a6-ea6f-4d84-8054-7f9f4150e18e","SourceStoreId":"hd2j3gh4ye","DestinationStoreId":"fr4k54h1ye","EntityName":"StoreProfile","SourceCount":1,"DestinationCount":1,"Status":"Completed","ModifiedDate":"2022-04-17T15:20:18.863","Error":null}]}}}},"deprecated":false}},"/BigcFunction/BigcProductUpdate":{"post":{"tags":["Product Update"],"summary":"Bigc Product Update","operationId":"BigcProductUpdate","parameters":[],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BigcProductUpdateRequest"},"example":{"MigrationId":"{{MigrationIdNew}}","ProductId":1389,"Brand":true,"Categories":true,"IsDestinationProduction":false,"SourceStoreCredentials":{"StoreId":"hd2j3gh4ye"},"DestinationStoreCredentials":{"StoreId":"fr4k54h1ye"},"IsScheduledRequest":true,"ScheduleDateTime":"2022-09-14T15:00:00+01:00"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"text/plain":{"schema":{"type":"object","example":{"Status":"Success","StatusComment":"Success"}},"example":{"Status":"Success","StatusComment":"Success"}}}}},"deprecated":false}},"/Login":{"post":{"tags":["Authenticate"],"summary":"Authenticate","operationId":"Authenticate","parameters":[],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticateRequest"},"example":{"AccessKey":"WN*************4X","SecretKey":"vS3y3***********************dtCeF","StoreId":"n*****1"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"text/plain":{"schema":{"type":"object","example":{"Status":"Success","StatusComment":"Success","CustomerId":1,"UserToken":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1bmlxdWVfbmFtZSI6IlN0YWdpbmdQcm8iLCJQcm9kdWN0aW9uU3Rvc***********mNvbSJ9._ATneo********Kri3hg"}},"example":{"Status":"Success","StatusComment":"Success","CustomerId":1,"UserToken":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1bmlxdWVfbmFtZSI6IlN0YWdpbmdQcm8iLCJQcm9kdWN0aW9uU3Rvc***********mNvbSJ9._ATneo********Kri3hg"}}}}},"deprecated":false,"security":[]}},"/BigcFunction/MigrateStoreData":{"post":{"tags":["Content Migration"],"summary":"Migrate Store Data","operationId":"MigrateStoreData","parameters":[],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MigrateStoreDataRequest"},"example":{"MigrationId":"40cb5644-8834-4961-84b3-aae1b40e0e9a","RemoveExistingDataInDestination":true,"MigrateEntities":["Brands","Categories","Products","Channels","Orders"],"AnonymiseCustomerData":false,"OrderStatuses":["Pending"],"Channels":["Live-1-StagingPro (bigcomeerce)","Store-2 (bigcommerce)"],"B2BData":["Companies","CompanyUsers","Addresses","SuperAdmins","Quotes","Invoices"],"SourceStoreCredentials":{"StoreId":"hd2j3gh4ye"},"DestinationStoreCredentials":{"StoreId":"fr4k54h1ye"},"IsScheduledRequest":true,"ScheduleDateTime":null}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"text/plain":{"schema":{"type":"object","example":{"Status":"Success","StatusComment":"Success"}},"example":{"Status":"Success","StatusComment":"Success"}}}}},"deprecated":false}},"/BigcFunction/GetEntityErrors":{"get":{"tags":["Content Migration"],"summary":"Get Entity Errors","operationId":"GetEntityErrors","parameters":[{"name":"destinationStoreId","in":"query","description":"","required":true,"style":"form","explode":true,"schema":{"type":"string","example":"fr4k54h1ye"}},{"name":"migrationId","in":"query","description":"","required":true,"style":"form","explode":true,"schema":{"type":"string","example":"7F3BF7A6-EA6F-4D84-8054-7F9F4150E17D"}},{"name":"entityName","in":"query","description":"","required":true,"style":"form","explode":true,"schema":{"type":"string","example":"CustomerGroups"}},{"name":"Content-Type","in":"header","description":"","required":true,"style":"simple","schema":{"enum":["application/json"],"type":"string","example":"application/json"}}],"responses":{"200":{"description":"","headers":{},"content":{"text/plain":{"schema":{"type":"object","example":[{"MigrateStoreDataErrorId":855,"MigrationId":"7f3bf7a6-ea6f-4d84-8054-7f9f4150e15g","SourceStoreId":"hd2j3gh4ye","DestinationStoreId":"fr4k54h1ye","EntityName":"CustomerGroups","Error":"Conflict: [{\"status\":409,\"message\":\"A resource conflict prevented the request from being fulfilled.\",\"details\":{\"conflict_reason\":\"A customer group with the name 'WholeSale' already exists.\",\"duplicate_customer_group_id\":1}}]","ModifiedDate":"2022-04-17T15:19:36.933"},{"MigrateStoreDataErrorId":856,"MigrationId":"7f3bf7a6-ea6f-4d84-8054-7f9f4150e15g","SourceStoreId":"hd2j3gh4ye","DestinationStoreId":"fr4k54h1ye","EntityName":"CustomerGroups","Error":"Conflict: [{\"status\":409,\"message\":\"A resource conflict prevented the request from being fulfilled.\",\"details\":{\"conflict_reason\":\"A customer group with the name 'NOT LOGGED IN' already exists.\",\"duplicate_customer_group_id\":2}}]","ModifiedDate":"2022-04-17T15:19:37.19"},{"MigrateStoreDataErrorId":857,"MigrationId":"7f3bf7a6-ea6f-4d84-8054-7f9f4150e15g","SourceStoreId":"hd2j3gh4ye","DestinationStoreId":"fr4k54h1ye","EntityName":"CustomerGroups","Error":"Conflict: [{\"status\":409,\"message\":\"A resource conflict prevented the request from being fulfilled.\",\"details\":{\"conflict_reason\":\"A customer group with the name 'General' already exists.\",\"duplicate_customer_group_id\":3}}]","ModifiedDate":"2022-04-17T15:19:37.44"},{"MigrateStoreDataErrorId":859,"MigrationId":"7f3bf7a6-ea6f-4d84-8054-7f9f4150e15g","SourceStoreId":"hd2j3gh4ye","DestinationStoreId":"fr4k54h1ye","EntityName":"CustomerGroups","Error":"Conflict: [{\"status\":409,\"message\":\"A resource conflict prevented the request from being fulfilled.\",\"details\":{\"conflict_reason\":\"A customer group with the name 'Retailer' already exists.\",\"duplicate_customer_group_id\":5}}]","ModifiedDate":"2022-04-17T15:19:37.853"}]},"example":[{"MigrateStoreDataErrorId":855,"MigrationId":"7f3bf7a6-ea6f-4d84-8054-7f9f4150e15g","SourceStoreId":"hd2j3gh4ye","DestinationStoreId":"fr4k54h1ye","EntityName":"CustomerGroups","Error":"Conflict: [{\"status\":409,\"message\":\"A resource conflict prevented the request from being fulfilled.\",\"details\":{\"conflict_reason\":\"A customer group with the name 'WholeSale' already exists.\",\"duplicate_customer_group_id\":1}}]","ModifiedDate":"2022-04-17T15:19:36.933"},{"MigrateStoreDataErrorId":856,"MigrationId":"7f3bf7a6-ea6f-4d84-8054-7f9f4150e15g","SourceStoreId":"hd2j3gh4ye","DestinationStoreId":"fr4k54h1ye","EntityName":"CustomerGroups","Error":"Conflict: [{\"status\":409,\"message\":\"A resource conflict prevented the request from being fulfilled.\",\"details\":{\"conflict_reason\":\"A customer group with the name 'NOT LOGGED IN' already exists.\",\"duplicate_customer_group_id\":2}}]","ModifiedDate":"2022-04-17T15:19:37.19"},{"MigrateStoreDataErrorId":857,"MigrationId":"7f3bf7a6-ea6f-4d84-8054-7f9f4150e15g","SourceStoreId":"hd2j3gh4ye","DestinationStoreId":"fr4k54h1ye","EntityName":"CustomerGroups","Error":"Conflict: [{\"status\":409,\"message\":\"A resource conflict prevented the request from being fulfilled.\",\"details\":{\"conflict_reason\":\"A customer group with the name 'General' already exists.\",\"duplicate_customer_group_id\":3}}]","ModifiedDate":"2022-04-17T15:19:37.44"},{"MigrateStoreDataErrorId":859,"MigrationId":"7f3bf7a6-ea6f-4d84-8054-7f9f4150e15g","SourceStoreId":"hd2j3gh4ye","DestinationStoreId":"fr4k54h1ye","EntityName":"CustomerGroups","Error":"Conflict: [{\"status\":409,\"message\":\"A resource conflict prevented the request from being fulfilled.\",\"details\":{\"conflict_reason\":\"A customer group with the name 'Retailer' already exists.\",\"duplicate_customer_group_id\":5}}]","ModifiedDate":"2022-04-17T15:19:37.853"}]}}}},"deprecated":false}},"/BigcFunction/GetBigcProductUpdateStatus":{"get":{"tags":["Product Update"],"summary":"Get Bigc Product Update Status","operationId":"GetBigcProductUpdateStatus","parameters":[{"name":"destinationStoreId","in":"query","description":"","required":true,"style":"form","explode":true,"schema":{"type":"string","example":"fr4k54h1ye"}},{"name":"migrationId","in":"query","description":"","required":true,"style":"form","explode":true,"schema":{"type":"string","example":"706DCEB7-273E-407F-A588-81598602E77E"}},{"name":"Content-Type","in":"header","description":"","required":true,"style":"simple","schema":{"enum":["application/json"],"type":"string","example":"application/json"}}],"responses":{"200":{"description":"","headers":{},"content":{"text/plain":{"schema":{"type":"object","example":{"MigrationId":"9672cc10-00e9-471d-b262-06ef6712ced1","SourceStoreId":"hd2j3gh4ye","DestinationStoreId":"fr4k54h1ye","SourceProductId":21800,"DestinationProductId":342,"Status":"Success","Comment":null,"ModifiedDate":"2022-07-11T12:06:20.84","IsScheduledRequest":true,"ScheduleDateTime":"2022-09-14T14:30:00"}},"example":{"MigrationId":"9672cc10-00e9-471d-b262-06ef6712ced1","SourceStoreId":"hd2j3gh4ye","DestinationStoreId":"fr4k54h1ye","SourceProductId":21800,"DestinationProductId":342,"Status":"Success","Comment":null,"ModifiedDate":"2022-07-11T12:06:20.84","IsScheduledRequest":true,"ScheduleDateTime":"2022-09-14T14:30:00"}}}}},"deprecated":false}},"/BigcFunction/CancelScheduledProductUpdateRequest":{"post":{"tags":["Product Update"],"summary":"Cancel Scheduled Product Update Request","operationId":"CancelScheduledProductUpdateRequest","parameters":[],"requestBody":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"DestinationStoreId":"nwdfjh4sjl1","MigrationId":"99BECC91-681A-475A-844A-914B6B593441"}},"example":{"DestinationStoreId":"nwdfjh4sjl1","MigrationId":"99BECC91-681A-475A-844A-914B6B593441"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"text/plain":{"schema":{"type":"object","example":{"MigrationId":"79b64a04-f686-420e-98be-fd8cdfa2a1a4","SourceStoreId":"v6e2r42e391","DestinationStoreId":"nw6w3ed4jl1","SourceProductId":8847,"DestinationProductId":null,"Status":"Cancelled","Comment":"Request is cancelled","ModifiedDate":"2022-09-12T16:27:29.5126573+00:00","IsScheduledRequest":true,"ScheduleDateTime":"2022-09-14T14:30:00"}},"example":{"MigrationId":"79b64a04-f686-420e-98be-fd8cdfa2a1a4","SourceStoreId":"v6e2r42e391","DestinationStoreId":"nw6w3ed4jl1","SourceProductId":8847,"DestinationProductId":null,"Status":"Cancelled","Comment":"Request is cancelled","ModifiedDate":"2022-09-12T16:27:29.5126573+00:00","IsScheduledRequest":true,"ScheduleDateTime":"2022-09-14T14:30:00"}}}}},"deprecated":false}},"/BigcFunction/CancelScheduledMigrateStoreDataRequest":{"post":{"tags":["Content Migration"],"summary":"Cancel Scheduled Migrate Store Data Request","operationId":"CancelScheduledMigrateStoreDataRequest-Copy","parameters":[],"requestBody":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"DestinationStoreId":"nwdfjh4sjl1","MigrationId":"99BECC91-681A-475A-844A-914B6B593441"}},"example":{"DestinationStoreId":"nwdfjh4sjl1","MigrationId":"99BECC91-681A-475A-844A-914B6B593441"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"text/plain":{"schema":{"type":"object","example":{"MigrationId":"99becc91-681a-475a-844a-914b6b593441","SourceStoreId":"v6dsj2j2ew","DestinationStoreId":"nwdfjh4sjl1","Status":"Cancelled","PercentCompleted":0,"Comment":"Request is cancelled"}},"example":{"MigrationId":"99becc91-681a-475a-844a-914b6b593441","SourceStoreId":"v6dsj2j2ew","DestinationStoreId":"nwdfjh4sjl1","Status":"Cancelled","PercentCompleted":0,"Comment":"Request is cancelled"}}}}},"deprecated":false}},"/BigcFunction/BigcPromotionUpdate":{"post":{"tags":["Promotion Update"],"summary":"Bigc Promotion Update","operationId":"BigcPromotionUpdate","parameters":[],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BigcPromotionUpdateRequest"},"example":{"MigrationId":"d2a04c01-8c73-46b6-8c14-45b808b04a18","PromotionId":1,"IsDestinationProduction":false,"SourceStoreCredentials":{"StoreId":"v6qs4fr3491"},"DestinationStoreCredentials":{"StoreId":"z6f6ff34d1"},"IsScheduledRequest":false,"ScheduleDateTime":null}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"text/plain":{"schema":{"type":"object","example":{"Status":"Success","StatusComment":"Success"}},"example":{"Status":"Success","StatusComment":"Success"}}}}},"deprecated":false}},"/BigcFunction/GetBigcPromotionUpdateStatus":{"get":{"tags":["Promotion Update"],"summary":"Get Bigc Promotion Update Status","operationId":"GetBigcPromotionUpdateStatus","parameters":[{"name":"destinationStoreId","in":"query","description":"","required":true,"style":"form","explode":true,"schema":{"type":"string","example":"fr4k54h1ye"}},{"name":"migrationId","in":"query","description":"","required":true,"style":"form","explode":true,"schema":{"type":"string","example":"706DCEB7-273E-407F-A588-81598602E77E"}},{"name":"Content-Type","in":"header","description":"","required":true,"style":"simple","schema":{"enum":["application/json"],"type":"string","example":"application/json"}}],"responses":{"200":{"description":"","headers":{},"content":{"text/plain":{"schema":{"type":"object","example":{"MigrationId":"d2a04c01-8c73-46b6-8c14-45b808b04a18","SourceStoreId":"v643re4491","DestinationStoreId":"z6fde4491","SourcePromotionId":1,"DestinationPromotionId":12,"Status":"InProgress","Comment":"Validating request","ModifiedDate":"2022-09-23T11:30:49.437","IsScheduledRequest":false,"ScheduleDateTime":null}},"example":{"MigrationId":"d2a04c01-8c73-46b6-8c14-45b808b04a18","SourceStoreId":"v643re4491","DestinationStoreId":"z6fde4491","SourcePromotionId":1,"DestinationPromotionId":12,"Status":"InProgress","Comment":"Validating request","ModifiedDate":"2022-09-23T11:30:49.437","IsScheduledRequest":false,"ScheduleDateTime":null}}}}},"deprecated":false}},"/BigcFunction/CancelScheduledPromotionUpdateRequest":{"post":{"tags":["Promotion Update"],"summary":"Cancel Scheduled Promotion Update Request","operationId":"CancelScheduledPromotionUpdateRequest","parameters":[],"requestBody":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"DestinationStoreId":"nwdfjh4sjl1","MigrationId":"99BECC91-681A-475A-844A-914B6B593441"}},"example":{"DestinationStoreId":"nwdfjh4sjl1","MigrationId":"99BECC91-681A-475A-844A-914B6B593441"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"text/plain":{"schema":{"type":"object","example":{"MigrationId":"cf7bf1ce-2b15-420d-bae8-18a7411aa03e","SourceStoreId":"v6qd34g5fd1","DestinationStoreId":"z6ff45d451","SourcePromotionId":1,"DestinationPromotionId":null,"Status":"Cancelled","Comment":"Request is cancelled","ModifiedDate":"2022-09-24T12:35:55.278496+00:00","IsScheduledRequest":true,"ScheduleDateTime":"2022-09-24T11:00:00"}},"example":{"MigrationId":"cf7bf1ce-2b15-420d-bae8-18a7411aa03e","SourceStoreId":"v6qd34g5fd1","DestinationStoreId":"z6ff45d451","SourcePromotionId":1,"DestinationPromotionId":null,"Status":"Cancelled","Comment":"Request is cancelled","ModifiedDate":"2022-09-24T12:35:55.278496+00:00","IsScheduledRequest":true,"ScheduleDateTime":"2022-09-24T11:00:00"}}}}},"deprecated":false}},"/BigcFunction/GetMigrationHistoryReport":{"get":{"tags":["Content Migration"],"summary":"Get Migration History Report","operationId":"GetMigrationHistoryReport","parameters":[{"name":"storeId","in":"query","description":"","required":true,"style":"form","explode":true,"schema":{"type":"string","example":"fr4k54h1ye"}},{"name":"sourceStoreId","in":"query","description":"","style":"form","explode":true,"schema":{"type":"string","example":"fr4k54h1ye"}},{"name":"destinationStoreId","in":"query","description":"","style":"form","explode":true,"schema":{"type":"string","example":"fr4k54h1ye"}},{"name":"isScheduled","in":"query","description":"","style":"form","explode":true,"schema":{"type":"boolean","example":false}},{"name":"fromDate","in":"header","description":"","style":"simple","schema":{"type":"string","example":"2022-09-01"}},{"name":"toDate","in":"query","description":"","style":"form","explode":true,"schema":{"type":"string","example":"2022-09-20"}},{"name":"migrationId","in":"query","description":"","style":"form","explode":true,"schema":{"type":"string","example":"34e2c1d0-6165-4868-8f0e-1261081171cd"}},{"name":"entityType","in":"query","description":"One of the entity types. E.g.: Content, Product, Promotion, Theme","style":"form","explode":true,"schema":{"type":"string"}},{"name":"pageNumber","in":"query","description":"","style":"form","explode":true,"schema":{"type":"integer","format":"int32","default":1,"example":1}},{"name":"pageSize","in":"query","description":"","style":"form","explode":true,"schema":{"type":"integer","format":"int32","default":10,"example":10}}],"responses":{"200":{"description":"","headers":{},"content":{"text/plain":{"schema":{"type":"object","example":{"MigrateHistoryReport":[{"MigrationId":"dd37eb5f-a************81-9ba1bb77d0a2","SourceStoreId":"v6*****n91","SourceStoreUrl":"https://bigi.247commerce.co.uk","DestinationStoreId":"6b****1w","DestinationStoreUrl":"https://bigidev-p9.mybigcommerce.com","Status":"Cancelled","Comment":"Request is cancelled","CreatedDate":"2022-11-09T15:43:28.053","ModifiedDate":"2022-11-09T15:43:50.45","IsScheduledRequest":true,"ScheduleDateTime":"2022-11-20T18:00:00","EntityType":"Theme"},{"MigrationId":"699cc6b4-5************e-df24dae4a21d","SourceStoreId":"v6q9*****1","SourceStoreUrl":"https://bigi.247commerce.co.uk","DestinationStoreId":"6b****1w","DestinationStoreUrl":"https://bigidev-p9.mybigcommerce.com","Status":"Scheduled","Comment":"Request scheduled successfully","CreatedDate":"2022-11-09T15:43:14.917","ModifiedDate":"2022-11-09T15:43:14.917","IsScheduledRequest":true,"ScheduleDateTime":"2022-11-20T18:00:00","EntityType":"Theme"},{"MigrationId":"8cbbaa8e-************-27f70eb31fa8","SourceStoreId":"v6*****91","SourceStoreUrl":"https://bigi.247commerce.co.uk","DestinationStoreId":"6b*****1w","DestinationStoreUrl":"https://bigidev-p9.mybigcommerce.com","Status":"Cancelled","Comment":"Request is cancelled","CreatedDate":"2022-11-09T15:41:32.8","ModifiedDate":"2022-11-10T11:32:48.927","IsScheduledRequest":true,"ScheduleDateTime":"2022-11-20T18:00:00","EntityType":"Theme"},{"MigrationId":"8db5f230-************1b93e669d88f","SourceStoreId":"wt****tm","SourceStoreUrl":"https://production-g9.mybigcommerce.com","DestinationStoreId":"xk******lf","DestinationStoreUrl":"https://staging-j2.mybigcommerce.com","Status":"Completed","Comment":"Publish Completed","CreatedDate":"2022-11-08T10:11:34.907","ModifiedDate":"2022-11-08T11:00:50.39","IsScheduledRequest":true,"ScheduleDateTime":"2022-11-08T11:00:00","EntityType":"Content"},{"MigrationId":"87dd7da9-************-6108d6d01cb0","SourceStoreId":"w******tm","SourceStoreUrl":"https://production-g9.mybigcommerce.com","DestinationStoreId":"xk*******lf","DestinationStoreUrl":"https://staging-j2.mybigcommerce.com","Status":"Cancelled","Comment":"Request is cancelled","CreatedDate":"2022-11-08T07:18:56.44","ModifiedDate":"2022-11-08T07:36:07.41","IsScheduledRequest":true,"ScheduleDateTime":"2022-11-08T08:00:00","EntityType":"Product"},{"MigrationId":"f782a71c-************-e6c1eba973f3","SourceStoreId":"wt********tm","SourceStoreUrl":"https://production-g9.mybigcommerce.com","DestinationStoreId":"xk******lf","DestinationStoreUrl":"https://staging-j2.mybigcommerce.com","Status":"Success","Comment":"Success","CreatedDate":"2022-11-07T17:15:10.13","ModifiedDate":"2022-11-07T18:00:08.44","IsScheduledRequest":true,"ScheduleDateTime":"2022-11-07T18:00:00","EntityType":"Product"},{"MigrationId":"a24ef7c8-************-dbd350476ffa","SourceStoreId":"wt*******tm","SourceStoreUrl":"https://production-g9.mybigcommerce.com","DestinationStoreId":"xk******f","DestinationStoreUrl":"https://staging-j2.mybigcommerce.com","Status":"Success","Comment":"Success","CreatedDate":"2022-11-07T17:08:07.313","ModifiedDate":"2022-11-07T18:00:09.85","IsScheduledRequest":true,"ScheduleDateTime":"2022-11-07T18:00:00","EntityType":"Product"},{"MigrationId":"7aff2065-************3-463cb6c5406e","SourceStoreId":"wt*****m","SourceStoreUrl":"https://production-g9.mybigcommerce.com","DestinationStoreId":"xk*******f","DestinationStoreUrl":"https://staging-j2.mybigcommerce.com","Status":"Cancelled","Comment":"Request is cancelled","CreatedDate":"2022-11-07T17:02:25.817","ModifiedDate":"2022-11-07T17:17:30.967","IsScheduledRequest":true,"ScheduleDateTime":"2022-11-07T18:00:00","EntityType":"Content"},{"MigrationId":"8d0ed7e2-************c-7d8dc1541671","SourceStoreId":"wtg*****m","SourceStoreUrl":"https://production-g9.mybigcommerce.com","DestinationStoreId":"xk********lf","DestinationStoreUrl":"https://staging-j2.mybigcommerce.com","Status":"Cancelled","Comment":"Request is cancelled","CreatedDate":"2022-11-07T14:50:59.07","ModifiedDate":"2022-11-07T14:51:26.417","IsScheduledRequest":true,"ScheduleDateTime":"2022-11-07T15:00:00","EntityType":"Content"},{"MigrationId":"e68c5062-************-5fc6d173ca08","SourceStoreId":"wt********tm","SourceStoreUrl":"https://production-g9.mybigcommerce.com","DestinationStoreId":"w*******k","DestinationStoreUrl":"https://247-commerce-sandbox-store.mybigcommerce.com","Status":"Success","Comment":"Success","CreatedDate":"2022-11-07T14:37:31.043","ModifiedDate":"2022-11-07T15:00:06.137","IsScheduledRequest":true,"ScheduleDateTime":"2022-11-07T15:00:00","EntityType":"Product"}],"MetaData":{"PageNumber":2,"PageSize":10,"NumberOfRecords":145}}},"example":{"MigrateHistoryReport":[{"MigrationId":"dd37eb5f-a************81-9ba1bb77d0a2","SourceStoreId":"v6*****n91","SourceStoreUrl":"https://bigi.247commerce.co.uk","DestinationStoreId":"6b****1w","DestinationStoreUrl":"https://bigidev-p9.mybigcommerce.com","Status":"Cancelled","Comment":"Request is cancelled","CreatedDate":"2022-11-09T15:43:28.053","ModifiedDate":"2022-11-09T15:43:50.45","IsScheduledRequest":true,"ScheduleDateTime":"2022-11-20T18:00:00","EntityType":"Theme"},{"MigrationId":"699cc6b4-5************e-df24dae4a21d","SourceStoreId":"v6q9*****1","SourceStoreUrl":"https://bigi.247commerce.co.uk","DestinationStoreId":"6b****1w","DestinationStoreUrl":"https://bigidev-p9.mybigcommerce.com","Status":"Scheduled","Comment":"Request scheduled successfully","CreatedDate":"2022-11-09T15:43:14.917","ModifiedDate":"2022-11-09T15:43:14.917","IsScheduledRequest":true,"ScheduleDateTime":"2022-11-20T18:00:00","EntityType":"Theme"},{"MigrationId":"8cbbaa8e-************-27f70eb31fa8","SourceStoreId":"v6*****91","SourceStoreUrl":"https://bigi.247commerce.co.uk","DestinationStoreId":"6b*****1w","DestinationStoreUrl":"https://bigidev-p9.mybigcommerce.com","Status":"Cancelled","Comment":"Request is cancelled","CreatedDate":"2022-11-09T15:41:32.8","ModifiedDate":"2022-11-10T11:32:48.927","IsScheduledRequest":true,"ScheduleDateTime":"2022-11-20T18:00:00","EntityType":"Theme"},{"MigrationId":"8db5f230-************1b93e669d88f","SourceStoreId":"wt****tm","SourceStoreUrl":"https://production-g9.mybigcommerce.com","DestinationStoreId":"xk******lf","DestinationStoreUrl":"https://staging-j2.mybigcommerce.com","Status":"Completed","Comment":"Publish Completed","CreatedDate":"2022-11-08T10:11:34.907","ModifiedDate":"2022-11-08T11:00:50.39","IsScheduledRequest":true,"ScheduleDateTime":"2022-11-08T11:00:00","EntityType":"Content"},{"MigrationId":"87dd7da9-************-6108d6d01cb0","SourceStoreId":"w******tm","SourceStoreUrl":"https://production-g9.mybigcommerce.com","DestinationStoreId":"xk*******lf","DestinationStoreUrl":"https://staging-j2.mybigcommerce.com","Status":"Cancelled","Comment":"Request is cancelled","CreatedDate":"2022-11-08T07:18:56.44","ModifiedDate":"2022-11-08T07:36:07.41","IsScheduledRequest":true,"ScheduleDateTime":"2022-11-08T08:00:00","EntityType":"Product"},{"MigrationId":"f782a71c-************-e6c1eba973f3","SourceStoreId":"wt********tm","SourceStoreUrl":"https://production-g9.mybigcommerce.com","DestinationStoreId":"xk******lf","DestinationStoreUrl":"https://staging-j2.mybigcommerce.com","Status":"Success","Comment":"Success","CreatedDate":"2022-11-07T17:15:10.13","ModifiedDate":"2022-11-07T18:00:08.44","IsScheduledRequest":true,"ScheduleDateTime":"2022-11-07T18:00:00","EntityType":"Product"},{"MigrationId":"a24ef7c8-************-dbd350476ffa","SourceStoreId":"wt*******tm","SourceStoreUrl":"https://production-g9.mybigcommerce.com","DestinationStoreId":"xk******f","DestinationStoreUrl":"https://staging-j2.mybigcommerce.com","Status":"Success","Comment":"Success","CreatedDate":"2022-11-07T17:08:07.313","ModifiedDate":"2022-11-07T18:00:09.85","IsScheduledRequest":true,"ScheduleDateTime":"2022-11-07T18:00:00","EntityType":"Product"},{"MigrationId":"7aff2065-************3-463cb6c5406e","SourceStoreId":"wt*****m","SourceStoreUrl":"https://production-g9.mybigcommerce.com","DestinationStoreId":"xk*******f","DestinationStoreUrl":"https://staging-j2.mybigcommerce.com","Status":"Cancelled","Comment":"Request is cancelled","CreatedDate":"2022-11-07T17:02:25.817","ModifiedDate":"2022-11-07T17:17:30.967","IsScheduledRequest":true,"ScheduleDateTime":"2022-11-07T18:00:00","EntityType":"Content"},{"MigrationId":"8d0ed7e2-************c-7d8dc1541671","SourceStoreId":"wtg*****m","SourceStoreUrl":"https://production-g9.mybigcommerce.com","DestinationStoreId":"xk********lf","DestinationStoreUrl":"https://staging-j2.mybigcommerce.com","Status":"Cancelled","Comment":"Request is cancelled","CreatedDate":"2022-11-07T14:50:59.07","ModifiedDate":"2022-11-07T14:51:26.417","IsScheduledRequest":true,"ScheduleDateTime":"2022-11-07T15:00:00","EntityType":"Content"},{"MigrationId":"e68c5062-************-5fc6d173ca08","SourceStoreId":"wt********tm","SourceStoreUrl":"https://production-g9.mybigcommerce.com","DestinationStoreId":"w*******k","DestinationStoreUrl":"https://247-commerce-sandbox-store.mybigcommerce.com","Status":"Success","Comment":"Success","CreatedDate":"2022-11-07T14:37:31.043","ModifiedDate":"2022-11-07T15:00:06.137","IsScheduledRequest":true,"ScheduleDateTime":"2022-11-07T15:00:00","EntityType":"Product"}],"MetaData":{"PageNumber":2,"PageSize":10,"NumberOfRecords":145}}}}}},"deprecated":false}},"/BigcFunction/GetAnyScheduledMigrateDataRequests":{"get":{"tags":["Content Migration"],"summary":"Get Any Scheduled Migrate Data Requests","operationId":"GetAnyScheduledMigrateDataRequests","parameters":[{"name":"destinationStoreId","in":"query","description":"","required":true,"style":"form","explode":true,"schema":{"type":"string","example":"c34jj344u3"}},{"name":"scheduledDate","in":"query","description":"","required":true,"style":"form","explode":true,"schema":{"type":"string","example":"2020-10-04"}},{"name":"entityType","in":"query","description":"One of the entity types. E.g.: Content, Product, Promotion, Theme","required":true,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"entityIds","in":"query","description":"Required for all entity types other than entity type \"Content\"","required":true,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"migrationId","in":"query","description":"","style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"text/plain":{"schema":{"type":"object","example":[{"MigrationId":"f6315712-2b33-4601-ae76-dada79d87f43","SourceStoreId":"v6qsds491","SourceStoreUrl":"https://bigi233.247commerce.co.uk","SourceEntityId":null,"DestinationStoreId":"fgtbisrb9x","DestinationStoreUrl":"https://bigi23.247commerce.co.uk","MigrateEntities":["Brands","Categories"],"Status":"Scheduled","Comment":"Your requested migration is scheduled","CreatedDate":"2022-11-24T12:57:00.673","ModifiedDate":"2022-11-24T12:57:00.673","IsScheduledRequest":true,"ScheduleDateTime":"2022-12-01T00:00:00","Rdata":null},{"MigrationId":"e5334712-2b33-4601-ae76-dada79d87s32","SourceStoreId":"4fs442dh6hy","SourceStoreUrl":"https://bigi233.247commerce.co.uk","SourceEntityId":null,"DestinationStoreId":"fgtbisrb9x","DestinationStoreUrl":"https://bigi233.247commerce.co.uk","MigrateEntities":["Brands","Categories","Products"],"Status":"Scheduled","Comment":"Your requested migration is scheduled","CreatedDate":"2022-11-24T12:57:00.673","ModifiedDate":"2022-11-24T12:57:00.673","IsScheduledRequest":true,"ScheduleDateTime":"2022-12-01T00:00:00","Rdata":null}]},"example":[{"MigrationId":"f6315712-2b33-4601-ae76-dada79d87f43","SourceStoreId":"v6qsds491","SourceStoreUrl":"https://bigi233.247commerce.co.uk","SourceEntityId":null,"DestinationStoreId":"fgtbisrb9x","DestinationStoreUrl":"https://bigi23.247commerce.co.uk","MigrateEntities":["Brands","Categories"],"Status":"Scheduled","Comment":"Your requested migration is scheduled","CreatedDate":"2022-11-24T12:57:00.673","ModifiedDate":"2022-11-24T12:57:00.673","IsScheduledRequest":true,"ScheduleDateTime":"2022-12-01T00:00:00","Rdata":null},{"MigrationId":"e5334712-2b33-4601-ae76-dada79d87s32","SourceStoreId":"4fs442dh6hy","SourceStoreUrl":"https://bigi233.247commerce.co.uk","SourceEntityId":null,"DestinationStoreId":"fgtbisrb9x","DestinationStoreUrl":"https://bigi233.247commerce.co.uk","MigrateEntities":["Brands","Categories","Products"],"Status":"Scheduled","Comment":"Your requested migration is scheduled","CreatedDate":"2022-11-24T12:57:00.673","ModifiedDate":"2022-11-24T12:57:00.673","IsScheduledRequest":true,"ScheduleDateTime":"2022-12-01T00:00:00","Rdata":null}]}}}},"deprecated":false}},"/BigcTheme/MigrateTheme":{"post":{"tags":["Themes"],"summary":"Migrate Theme","operationId":"MigrateTheme","parameters":[],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BigcMigrateThemeRequest"},"example":{"MigrationId":"{{MigrationIdNew}}","BigcTheme":{"ThemeUuid":"string","ThemeName":"Test Name","ActivateInDestination":false,"ThemeVariationUuid":null,"ThemeVariationName":null,"DestinationChannelId":null},"SourceStoreCredentials":{"StoreId":"hd2j3gh4ye"},"DestinationStoreCredentials":{"StoreId":"fr4k54h1ye"},"IsScheduledRequest":true,"ScheduleDateTime":"2022-11-20 18:00"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"text/plain":{"schema":{"type":"object","example":{"Status":"Success","StatusComment":"Success"}},"example":{"Status":"Success","StatusComment":"Success"}}}}},"deprecated":false}},"/BigcTheme/GetMigrateThemeStatus":{"get":{"tags":["Themes"],"summary":"Get Migrate Theme Status","operationId":"GetMigrateThemeStatus","parameters":[{"name":"destinationStoreId","in":"query","description":"","required":true,"style":"form","explode":true,"schema":{"type":"string","example":"fr4k54h1ye"}},{"name":"migrationId","in":"query","description":"","required":true,"style":"form","explode":true,"schema":{"type":"string","example":"706DCEB7-273E-407F-A588-81598602E77E"}},{"name":"Content-Type","in":"header","description":"","required":true,"style":"simple","schema":{"enum":["application/json"],"type":"string","example":"application/json"}}],"responses":{"200":{"description":"","headers":{},"content":{"text/plain":{"schema":{"type":"object","example":{"MigrationId":"8cb************fa8","SourceStoreId":"v6*****91","DestinationStoreId":"6b******1w","SourceThemeUuid":"8c***********fa8","DestinationThemeUuid":"q321q1**********1we2","Status":"Success","Comment":"Success","ModifiedDate":"2022-07-11T12:06:20.84","IsScheduledRequest":true,"ScheduleDateTime":"2022-09-14T14:30:00"}},"example":{"MigrationId":"8cb************fa8","SourceStoreId":"v6*****91","DestinationStoreId":"6b******1w","SourceThemeUuid":"8c***********fa8","DestinationThemeUuid":"q321q1**********1we2","Status":"Success","Comment":"Success","ModifiedDate":"2022-07-11T12:06:20.84","IsScheduledRequest":true,"ScheduleDateTime":"2022-09-14T14:30:00"}}}}},"deprecated":false}},"/BigcTheme/CancelScheduledMigrateThemeRequest":{"post":{"tags":["Themes"],"summary":"Cancel Scheduled Migrate Theme Request","operationId":"CancelScheduledMigrateThemeRequest","parameters":[],"requestBody":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"DestinationStoreId":"nwdfjh4sjl1","MigrationId":"99BECC91-681A-475A-844A-914B6B593441"}},"example":{"DestinationStoreId":"nwdfjh4sjl1","MigrationId":"99BECC91-681A-475A-844A-914B6B593441"}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"text/plain":{"schema":{"type":"object","example":{"MigrationId":"8cb************fa8","SourceStoreId":"v6*****91","DestinationStoreId":"6b******1w","SourceThemeUuid":"8c***********fa8","DestinationThemeUuid":null,"Status":"Cancelled","Comment":"Request is cancelled","ModifiedDate":"2022-11-10T11:32:48.925017+00:00","IsScheduledRequest":true,"ScheduleDateTime":"2022-11-20T18:00:00"}},"example":{"MigrationId":"8cb************fa8","SourceStoreId":"v6*****91","DestinationStoreId":"6b******1w","SourceThemeUuid":"8c***********fa8","DestinationThemeUuid":null,"Status":"Cancelled","Comment":"Request is cancelled","ModifiedDate":"2022-11-10T11:32:48.925017+00:00","IsScheduledRequest":true,"ScheduleDateTime":"2022-11-20T18:00:00"}}}}},"deprecated":false}},"/BigcFunction/GetIfAnyInProgressContentMigration":{"get":{"tags":["Content Migration"],"summary":"Get If Any In Progress Content Migration","operationId":"GetIfAnyInProgressContentMigration","parameters":[{"name":"sourceStoreId","in":"query","description":"","required":true,"style":"form","explode":true,"schema":{"type":"string","example":"h******ye"}},{"name":"destinationStoreId","in":"query","description":"","required":true,"style":"form","explode":true,"schema":{"type":"string","example":"j******ke"}},{"name":"Content-Type","in":"header","description":"","required":true,"style":"simple","schema":{"enum":["application/json"],"type":"string","example":"application/json"}}],"responses":{"200":{"description":"","headers":{},"content":{"text/plain":{"schema":{"type":"object","example":{"AnyInProgressContentMigration":true,"Status":"InProgress","PercentCompleted":69,"Comment":"Publishing Active Theme","RequestJson":{"MigrationId":"8ed8****************b2f0c","RemoveExistingDataInDestination":false,"MigrateEntities":["ActiveTheme"],"AnonymiseCustomerData":false,"OrderStatuses":[],"Channels":[],"B2BData":[],"IsScheduledRequest":false,"ScheduleDateTime":null}}},"example":{"AnyInProgressContentMigration":true,"Status":"InProgress","PercentCompleted":69,"Comment":"Publishing Active Theme","RequestJson":{"MigrationId":"8ed8****************b2f0c","RemoveExistingDataInDestination":false,"MigrateEntities":["ActiveTheme"],"AnonymiseCustomerData":false,"OrderStatuses":[],"Channels":[],"B2BData":[],"IsScheduledRequest":false,"ScheduleDateTime":null}}}}}},"deprecated":false}}},"components":{"schemas":{"BackupRestore-SubscribeRequest":{"title":"BackupRestore-SubscribeRequest","required":["StoreId"],"type":"object","properties":{"StoreId":{"type":"string","example":"hd2j3gh4ye"}},"example":{"StoreId":"hd2j3gh4ye"}},"AuthenticateRequest":{"title":"AuthenticateRequest","required":["AccessKey","SecretKey","StoreId"],"type":"object","properties":{"AccessKey":{"type":"string"},"SecretKey":{"type":"string"},"StoreId":{"type":"string","description":"BigCommerce Storehash","example":"nw*****1"}},"example":{"AccessKey":"WN*************4X","SecretKey":"vS3y3***********************dtCeF"}},"MigrateStoreDataRequest":{"title":"MigrateStoreDataRequest","required":["MigrationId","RemoveExistingDataInDestination","MigrateEntities","AnonymiseCustomerData","OrderStatuses","Channels","B2BData","SourceStoreCredentials","DestinationStoreCredentials","IsScheduledRequest","ScheduleDateTime"],"type":"object","properties":{"MigrationId":{"type":"string"},"RemoveExistingDataInDestination":{"type":"boolean"},"MigrateEntities":{"type":"array","items":{"type":"string"},"description":""},"AnonymiseCustomerData":{"type":"boolean"},"OrderStatuses":{"type":"array","items":{"type":"string"},"description":""},"Channels":{"type":"array","items":{"type":"string"},"description":""},"B2BData":{"type":"array","items":{"type":"string"},"description":""},"SourceStoreCredentials":{"$ref":"#/components/schemas/SourceStoreCredentials"},"DestinationStoreCredentials":{"$ref":"#/components/schemas/DestinationStoreCredentials"},"IsScheduledRequest":{"type":"boolean","example":true},"ScheduleDateTime":{"type":"string","format":"date-time","nullable":true,"example":"null"}},"example":{"MigrationId":"40cb5644-8834-4961-84b3-aae1b40e0e9a","RemoveExistingDataInDestination":true,"MigrateEntities":["Brands","Categories","Products","Channels","Orders"],"AnonymiseCustomerData":false,"OrderStatuses":["Pending"],"Channels":["Live-1-StagingPro (bigcomeerce)","Store-2 (bigcommerce)"],"SourceStore":{"StoreId":"hd2j3gh4ye"},"DestinationStore":{"StoreId":"fr4k54h1ye"}}},"SourceStoreCredentials":{"title":"SourceStoreCredentials","required":["StoreId"],"type":"object","properties":{"StoreId":{"type":"string"}},"example":{"StoreId":"hd2j3gh4ye"}},"BackupRestore-UnsubscribeRequest":{"title":"BackupRestore-UnsubscribeRequest","required":["StoreId"],"type":"object","properties":{"StoreId":{"type":"string","example":"hd2j3gh4ye"}},"example":{"StoreId":"hd2j3gh4ye"}},"RestoreFullBackupRequest":{"title":"RestoreFullBackupRequest","required":["StoreId","AuditId","Entities","Channels"],"type":"object","properties":{"StoreId":{"type":"string"},"AuditId":{"type":"integer","format":"int32"},"Entities":{"type":"array","items":{"type":"string"},"description":""},"Channels":{"type":"array","items":{"type":"string"},"description":""}},"example":{"StoreId":"hd2j3gh4ye","AuditId":1,"Entities":["Products","Categories"]}},"DestinationStoreCredentials":{"title":"DestinationStoreCredentials","required":["StoreId"],"type":"object","properties":{"StoreId":{"type":"string"}},"example":{"StoreId":"fr4k54h1ye"}},"BigcProductUpdateRequest":{"title":"BigcProductUpdateRequest","required":["MigrationId","ProductId","Brand","Categories","IsDestinationProduction","SourceStoreCredentials","DestinationStoreCredentials","IsScheduledRequest","ScheduleDateTime"],"type":"object","properties":{"MigrationId":{"type":"string"},"ProductId":{"type":"integer","format":"int32"},"Brand":{"type":"boolean"},"Categories":{"type":"boolean"},"IsDestinationProduction":{"type":"boolean"},"SourceStoreCredentials":{"$ref":"#/components/schemas/SourceStoreCredentials"},"DestinationStoreCredentials":{"$ref":"#/components/schemas/DestinationStoreCredentials"},"IsScheduledRequest":{"type":"boolean","example":true},"ScheduleDateTime":{"type":"string","format":"date-time","nullable":true,"example":"2022-09-14T15:00:00+01:00"}},"example":{"MigrationId":"{{MigrationIdNew}}","ProductId":1389,"Brand":true,"Categories":true,"IsDestinationProduction":false,"SourceStore":{"StoreId":"hd2j3gh4ye"},"DestinationStore":{"StoreId":"fr4k54h1ye"}}},"RestoreEntityRequest":{"title":"RestoreEntityRequest","required":["StoreId","AuditId","EntityId","EntityTypeId","CompleteEntity","EntityData"],"type":"object","properties":{"StoreId":{"type":"string"},"AuditId":{"type":"integer","format":"int32"},"EntityId":{"type":"integer","format":"int32","example":1399},"EntityTypeId":{"type":"integer","format":"int32","example":2},"CompleteEntity":{"type":"boolean","example":true},"EntityData":{"type":"object"}},"example":{"StoreId":"hd2j3gh4ye","AuditId":24,"CompleteEntity":true,"EntityData":{"test":1}}},"BigcPromotionUpdateRequest":{"title":"BigcPromotionUpdateRequest","required":["MigrationId","PromotionId","IsDestinationProduction","SourceStoreCredentials","DestinationStoreCredentials","IsScheduledRequest","ScheduleDateTime"],"type":"object","properties":{"MigrationId":{"type":"string"},"PromotionId":{"type":"integer","format":"int32"},"IsDestinationProduction":{"type":"boolean"},"SourceStoreCredentials":{"$ref":"#/components/schemas/SourceStoreCredentials"},"DestinationStoreCredentials":{"$ref":"#/components/schemas/DestinationStoreCredentials"},"IsScheduledRequest":{"type":"boolean","example":true},"ScheduleDateTime":{"type":"string","format":"date-time","nullable":true,"example":"2022-09-14T15:00:00+01:00"}},"example":{"MigrationId":"d2a04c01-8c73-46b6-8c14-45b808b04a18","PromotionId":1,"IsDestinationProduction":false,"SourceStoreCredentials":{"StoreId":"v6qs4fr3491"},"DestinationStoreCredentials":{"StoreId":"z6f6ff34d1"},"IsScheduledRequest":false,"ScheduleDateTime":null}},"BigcMigrateThemeRequest":{"title":"BigcMigrateThemeRequest","required":["MigrationId","BigcTheme","SourceStoreCredentials","DestinationStoreCredentials","IsScheduledRequest","ScheduleDateTime"],"type":"object","properties":{"MigrationId":{"type":"string"},"BigcTheme":{"$ref":"#/components/schemas/BigcTheme"},"SourceStoreCredentials":{"$ref":"#/components/schemas/SourceStoreCredentials"},"DestinationStoreCredentials":{"$ref":"#/components/schemas/DestinationStoreCredentials"},"IsScheduledRequest":{"type":"boolean","example":true},"ScheduleDateTime":{"type":"string","format":"date-time","nullable":true,"example":"2022-09-14T15:00:00+01:00"}},"example":{"MigrationId":"{{MigrationIdNew}}","ProductId":1389,"Brand":true,"Categories":true,"IsDestinationProduction":false,"SourceStore":{"StoreId":"hd2j3gh4ye"},"DestinationStore":{"StoreId":"fr4k54h1ye"}}},"BigcTheme":{"title":"BigcTheme","required":["ThemeUuid","ThemeName","ActivateInDestination","ThemeVariationUuid","ThemeVariationName","DestinationChannelId"],"type":"object","properties":{"ThemeUuid":{"type":"string"},"ThemeName":{"type":"string"},"ActivateInDestination":{"type":"boolean"},"ThemeVariationUuid":{"type":"string","nullable":true},"ThemeVariationName":{"type":"string","nullable":true},"DestinationChannelId":{"type":"string","nullable":true}},"description":""}},"securitySchemes":{"httpBearer":{"type":"http","scheme":"bearer"}}},"security":[{"httpBearer":[]}],"tags":[{"name":"Misc","description":""}],"externalDocs":{"description":"StagingPro developer portal: tutorial, authentication and API console","url":"https://stagingpro.apimatic.dev/"}}