{"info":{"_postman_id":"ff9b5483-6175-4820-8b01-decb508889f7","name":"StagingPro API - Documentation","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"description":"","owner":"39229765","collectionId":"ff9b5483-6175-4820-8b01-decb508889f7","publishedId":"2sAY4rG5YR","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-10-24T09:24:17.000Z"},"item":[{"name":"Authenticate","item":[{"name":"Authenticate","id":"a8aedd11-2caf-4119-8663-c24354e0f379","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"*/*"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"AccessKey\": \"DG56HY**********E475RGH6HYR\",\r\n \"SecretKey\": \"Usdh358yfeh************3593uE\",\r\n \"StoreId\": \"ydizsnqpq3\"\r\n}"},"url":"https://api.stagingpro.com/v1/api/Login","description":"\n

This API endpoint is used to authenticate and login a user with the provided access and secret keys.

Request

Method: POST
\n
Endpoint: https://api.stagingpro.com/v1/api/Login
\n
Headers: No specific headers required
\n
{ \"AccessKey\": \"DG56HY*E475RGH6HYR\", \"SecretKey\": \"Usdh358yfeh***3593uE\", \"StoreId\": \"ydizsnqpq3\"}
\n

Response

Upon a successful login, the API returns the following response:

  {\n    \"Status\": \"\",\n    \"StatusComment\": \"\",\n    \"CustomerId\": 0,\n    \"UserToken\": \"\"\n  }\n\n

Status: The status of the login request.
\n
StatusComment: Additional comment or message related to the status.
\n
CustomerId: The unique identifier of the customer after successful login.
\n
UserToken: Token generated for the authenticated user.
\n

This API endpoint allows users to authenticate and obtain a user token for accessing the system.

Request Body

AccessKey (text, required): The access key for authentication.
\n
SecretKey (text, required): The secret key for authentication.
\n
StoreId (text, required): The ID of the store.
\n

Response Body

The response is in JSON format and includes the following fields:

Status (string): The status of the login request.
\n
StatusComment (string): Additional comments related to the status.
\n
CustomerId (integer): The ID of the customer.
\n
UserToken (string): The token for the authenticated user.
\n

JSON Schema

{\n  \"type\": \"object\",\n  \"properties\": {\n    \"Status\": { \"type\": \"string\" },\n    \"StatusComment\": { \"type\": \"string\" },\n    \"CustomerId\": { \"type\": \"integer\" },\n    \"UserToken\": { \"type\": \"string\" }\n  }\n}\n\n

Authenticate (POST):
This API authenticates the user by submitting an access key, secret key, and store ID. On success, it returns a token that is required for other authenticated requests.

\n","_postman_id":"d8b95106-cf8e-4fc8-ab84-215e49aa0cde","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}],"advancedConfig":[{"key":"scope","value":""}]},"isInherited":true,"source":{"_postman_id":"ff9b5483-6175-4820-8b01-decb508889f7","id":"ff9b5483-6175-4820-8b01-decb508889f7","name":"StagingPro API - Documentation","type":"collection"}}},{"name":"Bulk Content Migration","item":[{"name":"Get Store Data Summary","id":"cdccda0c-34b5-4b06-a321-72568e71babb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"url":"https://api.stagingpro.com/v1/api/BigcFunction/GetStoreDataSummary?storeId=hd2j3gh4ye","description":"

Get Store Data Summary

This endpoint retrieves a summary of various data related to the store identified by the provided storeId.

Request

Method: GET
\n
URL: https://api.stagingpro.com/v1/api/BigcFunction/GetStoreDataSummary
\n
Query Parameters:
\n
- storeId (string, required): The unique identifier of the store.
\n

Response

The response for this request is a JSON object with the following structure:

{\n  \"ContentData\": {\n    \"Pages\": 0,\n    \"Widgets\": 0,\n    \"StoreCoupons\": 0,\n    \"Banners\": 0,\n    \"AbandonedCartEmailTemplates\": 0,\n    \"EmailTemplates\": 0,\n    \"BlogPosts\": 0,\n    \"ActiveTheme\": 0\n  },\n  \"ProductData\": {\n    \"Brands\": 0,\n    \"Categories\": 0,\n    \"Products\": 0,\n    \"ProductReviews\": 0,\n    \"PriceLists\": 0,\n    \"PriceListAssignments\": 0,\n    \"PriceListRecords\": 0,\n    \"Promotions\": 0\n  },\n  \"CustomerData\": {\n    \"CustomerGroups\": 0,\n    \"Customers\": 0,\n    \"CustomerAttributes\": 0\n  },\n  \"OrderData\": {\n    \"OrdersByStatus\": [\n      {\n        \"Status\": \"\",\n        \"OrderCount\": 0\n      }\n    ],\n    \"Orders\": 0,\n    \"GlobalOrderSettings\": 0,\n    \"GiftCertificates\": 0\n  },\n  \"StoreSettings\": {\n    \"EmailStatuses\": 0,\n    \"SearchFiltersEnabled\": 0,\n    \"SearchContextualFilters\": 0,\n    \"StoreLocale\": 0,\n    \"StoreFrontRobots\": 0,\n    \"StoreFrontSearch\": 0,\n    \"StoreFrontSeo\": 0,\n    \"StoreFrontStatus\": 0,\n    \"WebAnalyticsProviders\": 0,\n    \"CatalogSettings\": 0,\n    \"InventoryNotifications\": 0,\n    \"StoreLogoSettings\": 0,\n    \"StoreProfile\": 0,\n    \"StorefrontCategorySettings\": 0,\n    \"StorefrontProductSettings\": 0,\n    \"StorefrontSecuritySettings\": 0,\n    \"ShippingZones\": 0,\n    \"ShippingMethods\": 0\n  },\n  \"MultiStoreData\": {\n    \"Channels\": [\"\"],\n    \"ChannelsOrderSettings\": 0,\n    \"ChannelsCustomerSettings\": 0\n  },\n  \"B2BData\": {\n    \"Companies\": 0,\n    \"Addresses\": 0,\n    \"Users\": 0,\n    \"Orders\": 0,\n    \"SuperAdmins\": 0,\n    \"Quotes\": 0,\n    \"ShoppingList\": 0,\n    \"Invoices\": 0\n  }\n}\n\n

The response provides detailed information about the content, products, customers, orders, store settings, multi-store data, and B2B data associated with the specified store.

GetMigrateStoreDataProgressStatus

This endpoint retrieves the progress status of a data migration process for a specific destination store.

Request

Method: GET
\n
URL: https://api.stagingpro.com/v1/api/BigcFunction/GetMigrateStoreDataProgressStatus
\n
Query Parameters:
\n
- destinationStoreId (string, required) - The ID of the destination store
  \n
- migrationId (string, required) - The ID of the migration
  \n
\n

Response

The response for this request follows the JSON schema below:

{\n  \"type\": \"object\",\n  \"properties\": {\n    \"MigrationId\": {\n      \"type\": \"string\"\n    },\n    \"SourceStoreId\": {\n      \"type\": \"string\"\n    },\n    \"DestinationStoreId\": {\n      \"type\": \"string\"\n    },\n    \"Status\": {\n      \"type\": \"string\"\n    },\n    \"PercentCompleted\": {\n      \"type\": \"integer\"\n    },\n    \"Comment\": {\n      \"type\": \"string\"\n    },\n    \"ModifiedDate\": {\n      \"type\": \"string\"\n    },\n    \"IsScheduledRequest\": {\n      \"type\": \"boolean\"\n    },\n    \"ScheduleDateTime\": {\n      \"type\": \"string\"\n    }\n  }\n}\n\n

Get Data Migration Entity Status

This endpoint retrieves the status of data entity migration for a specific destination store.

Request

Method: GET
\n
Endpoint: https://api.stagingpro.com/v1/api/BigcFunction/GetMigrateStoreDataEntitiesStatus
\n
Query Parameters:
\n
- destinationStoreId (string, required): The ID of the destination store for which the migration status is requested.
  \n
- migrationId (string, required): The ID of the migration process.
  \n
\n

Response

The response for this request is an array of objects with the following properties:

MigrationId (string): The ID of the migration.
\n
SourceStoreId (string): The ID of the source store.
\n
DestinationStoreId (string): The ID of the destination store.
\n
EntityName (string): The name of the data entity.
\n
SourceCount (integer): The count of entities in the source store.
\n
DestinationCount (integer): The count of entities in the destination store.
\n
Status (string): The status of the migration.
\n
ModifiedDate (string): The date of the last modification.
\n
Error (object): Details of any error encountered during migration, if applicable.
\n

Response Example

[\n  {\n    \"MigrationId\": \"\",\n    \"SourceStoreId\": \"\",\n    \"DestinationStoreId\": \"\",\n    \"EntityName\": \"\",\n    \"SourceCount\": 0,\n    \"DestinationCount\": 0,\n    \"Status\": \"\",\n    \"ModifiedDate\": \"\",\n    \"Error\": null\n  }\n]\n\n

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}],"advancedConfig":[{"key":"scope","value":""}]},"isInherited":true,"source":{"_postman_id":"ff9b5483-6175-4820-8b01-decb508889f7","id":"ff9b5483-6175-4820-8b01-decb508889f7","name":"StagingPro API - Documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","api","BigcFunction","GetMigrateStoreDataEntitiesStatus"],"host":["api","stagingpro","com"],"query":[{"key":"destinationStoreId","value":"fr4k54h1ye"},{"key":"migrationId","value":"7F3BF7A6-EA6F-4D84-8054-7F9F4150E17D"}],"variable":[]}},"response":[{"id":"943261cb-cd59-4afa-96f5-8170fa48a2e3","name":"Response_200","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"url":{"raw":"https://api.stagingpro.com/v1/api/BigcFunction/GetMigrateStoreDataEntitiesStatus?destinationStoreId=fr4k54h1ye&migrationId=7F3BF7A6-EA6F-4D84-8054-7F9F4150E17D","protocol":"https","host":["api","stagingpro","com"],"path":["v1","api","BigcFunction","GetMigrateStoreDataEntitiesStatus"],"query":[{"key":"destinationStoreId","value":"fr4k54h1ye"},{"key":"migrationId","value":"7F3BF7A6-EA6F-4D84-8054-7F9F4150E17D"}]}},"code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"MigrationId\": \"7f3bf7a6-ea6f-4d84-8054-7f9f4150e18e\",\r\n \"SourceStoreId\": \"hd2j3gh4ye\",\r\n \"DestinationStoreId\": \"fr4k54h1ye\",\r\n \"EntityName\": \"Brands\",\r\n \"SourceCount\": 55,\r\n \"DestinationCount\": 55,\r\n \"Status\": \"Completed\",\r\n \"ModifiedDate\": \"2022-04-17T15:11:53.237\",\r\n \"Error\": null\r\n },\r\n {\r\n \"MigrationId\": \"7f3bf7a6-ea6f-4d84-8054-7f9f4150e18e\",\r\n \"SourceStoreId\": \"hd2j3gh4ye\",\r\n \"DestinationStoreId\": \"fr4k54h1ye\",\r\n \"EntityName\": \"Categories\",\r\n \"SourceCount\": 122,\r\n \"DestinationCount\": 122,\r\n \"Status\": \"Completed\",\r\n \"ModifiedDate\": \"2022-04-17T15:12:30.207\",\r\n \"Error\": null\r\n },\r\n {\r\n \"MigrationId\": \"7f3bf7a6-ea6f-4d84-8054-7f9f4150e18e\",\r\n \"SourceStoreId\": \"hd2j3gh4ye\",\r\n \"DestinationStoreId\": \"fr4k54h1ye\",\r\n \"EntityName\": \"Products\",\r\n \"SourceCount\": 537,\r\n \"DestinationCount\": 537,\r\n \"Status\": \"Completed\",\r\n \"ModifiedDate\": \"2022-04-17T15:19:36.643\",\r\n \"Error\": null\r\n },\r\n {\r\n \"MigrationId\": \"7f3bf7a6-ea6f-4d84-8054-7f9f4150e18e\",\r\n \"SourceStoreId\": \"hd2j3gh4ye\",\r\n \"DestinationStoreId\": \"fr4k54h1ye\",\r\n \"EntityName\": \"CustomerGroups\",\r\n \"SourceCount\": 6,\r\n \"DestinationCount\": 6,\r\n \"Status\": \"Completed\",\r\n \"ModifiedDate\": \"2022-04-17T15:19:38.083\",\r\n \"Error\": null\r\n },\r\n {\r\n \"MigrationId\": \"7f3bf7a6-ea6f-4d84-8054-7f9f4150e18e\",\r\n \"SourceStoreId\": \"hd2j3gh4ye\",\r\n \"DestinationStoreId\": \"fr4k54h1ye\",\r\n \"EntityName\": \"Customers\",\r\n \"SourceCount\": 112,\r\n \"DestinationCount\": 100,\r\n \"Status\": \"Completed\",\r\n \"ModifiedDate\": \"2022-04-17T15:20:04.023\",\r\n \"Error\": \"https://api.stagingpro.com/v1/api/BigcFunction/GetEntityErrors?MigrationId=7f3bf7a6-ea6f-4d84-8054-7f9f4150e18e&EntityName=Customers\"\r\n },\r\n {\r\n \"MigrationId\": \"7f3bf7a6-ea6f-4d84-8054-7f9f4150e18e\",\r\n \"SourceStoreId\": \"hd2j3gh4ye\",\r\n \"DestinationStoreId\": \"fr4k54h1ye\",\r\n \"EntityName\": \"PriceLists\",\r\n \"SourceCount\": 2,\r\n \"DestinationCount\": 1,\r\n \"Status\": \"Completed\",\r\n \"ModifiedDate\": \"2022-04-17T15:20:04.35\",\r\n \"Error\": \"https://api.stagingpro.com/v1/api/BigcFunction/GetEntityErrors?MigrationId=7f3bf7a6-ea6f-4d84-8054-7f9f4150e18e&EntityName=PriceLists\"\r\n },\r\n {\r\n \"MigrationId\": \"7f3bf7a6-ea6f-4d84-8054-7f9f4150e18e\",\r\n \"SourceStoreId\": \"hd2j3gh4ye\",\r\n \"DestinationStoreId\": \"fr4k54h1ye\",\r\n \"EntityName\": \"PriceListAssignments\",\r\n \"SourceCount\": 2,\r\n \"DestinationCount\": 1,\r\n \"Status\": \"Completed\",\r\n \"ModifiedDate\": \"2022-04-17T15:20:04.693\",\r\n \"Error\": \"https://api.stagingpro.com/v1/api/BigcFunction/GetEntityErrors?MigrationId=7f3bf7a6-ea6f-4d84-8054-7f9f4150e18e&EntityName=PriceListAssignments\"\r\n },\r\n {\r\n \"MigrationId\": \"7f3bf7a6-ea6f-4d84-8054-7f9f4150e18e\",\r\n \"SourceStoreId\": \"hd2j3gh4ye\",\r\n \"DestinationStoreId\": \"fr4k54h1ye\",\r\n \"EntityName\": \"EmailStatuses\",\r\n \"SourceCount\": 12,\r\n \"DestinationCount\": 12,\r\n \"Status\": \"Completed\",\r\n \"ModifiedDate\": \"2022-04-17T15:20:18.847\",\r\n \"Error\": null\r\n },\r\n {\r\n \"MigrationId\": \"7f3bf7a6-ea6f-4d84-8054-7f9f4150e18e\",\r\n \"SourceStoreId\": \"hd2j3gh4ye\",\r\n \"DestinationStoreId\": \"fr4k54h1ye\",\r\n \"EntityName\": \"SearchContextualFilters\",\r\n \"SourceCount\": 3,\r\n \"DestinationCount\": 3,\r\n \"Status\": \"Completed\",\r\n \"ModifiedDate\": \"2022-04-17T15:20:18.85\",\r\n \"Error\": null\r\n },\r\n {\r\n \"MigrationId\": \"7f3bf7a6-ea6f-4d84-8054-7f9f4150e18e\",\r\n \"SourceStoreId\": \"hd2j3gh4ye\",\r\n \"DestinationStoreId\": \"fr4k54h1ye\",\r\n \"EntityName\": \"SearchFiltersEnabled\",\r\n \"SourceCount\": 31,\r\n \"DestinationCount\": 31,\r\n \"Status\": \"Completed\",\r\n \"ModifiedDate\": \"2022-04-17T15:20:18.85\",\r\n \"Error\": null\r\n },\r\n {\r\n \"MigrationId\": \"7f3bf7a6-ea6f-4d84-8054-7f9f4150e18e\",\r\n \"SourceStoreId\": \"hd2j3gh4ye\",\r\n \"DestinationStoreId\": \"fr4k54h1ye\",\r\n \"EntityName\": \"StoreLocale\",\r\n \"SourceCount\": 3,\r\n \"DestinationCount\": 3,\r\n \"Status\": \"Completed\",\r\n \"ModifiedDate\": \"2022-04-17T15:20:18.85\",\r\n \"Error\": null\r\n },\r\n {\r\n \"MigrationId\": \"7f3bf7a6-ea6f-4d84-8054-7f9f4150e18e\",\r\n \"SourceStoreId\": \"hd2j3gh4ye\",\r\n \"DestinationStoreId\": \"fr4k54h1ye\",\r\n \"EntityName\": \"StoreFrontRobots\",\r\n \"SourceCount\": 1,\r\n \"DestinationCount\": 1,\r\n \"Status\": \"Completed\",\r\n \"ModifiedDate\": \"2022-04-17T15:20:18.853\",\r\n \"Error\": null\r\n },\r\n {\r\n \"MigrationId\": \"7f3bf7a6-ea6f-4d84-8054-7f9f4150e18e\",\r\n \"SourceStoreId\": \"hd2j3gh4ye\",\r\n \"DestinationStoreId\": \"fr4k54h1ye\",\r\n \"EntityName\": \"StoreFrontSearch\",\r\n \"SourceCount\": 4,\r\n \"DestinationCount\": 4,\r\n \"Status\": \"Completed\",\r\n \"ModifiedDate\": \"2022-04-17T15:20:18.853\",\r\n \"Error\": null\r\n },\r\n {\r\n \"MigrationId\": \"7f3bf7a6-ea6f-4d84-8054-7f9f4150e18e\",\r\n \"SourceStoreId\": \"hd2j3gh4ye\",\r\n \"DestinationStoreId\": \"fr4k54h1ye\",\r\n \"EntityName\": \"StoreFrontSeo\",\r\n \"SourceCount\": 4,\r\n \"DestinationCount\": 4,\r\n \"Status\": \"Completed\",\r\n \"ModifiedDate\": \"2022-04-17T15:20:18.853\",\r\n \"Error\": null\r\n },\r\n {\r\n \"MigrationId\": \"7f3bf7a6-ea6f-4d84-8054-7f9f4150e18e\",\r\n \"SourceStoreId\": \"hd2j3gh4ye\",\r\n \"DestinationStoreId\": \"fr4k54h1ye\",\r\n \"EntityName\": \"StoreFrontStatus\",\r\n \"SourceCount\": 3,\r\n \"DestinationCount\": 3,\r\n \"Status\": \"Completed\",\r\n \"ModifiedDate\": \"2022-04-17T15:20:18.857\",\r\n \"Error\": null\r\n },\r\n {\r\n \"MigrationId\": \"7f3bf7a6-ea6f-4d84-8054-7f9f4150e18e\",\r\n \"SourceStoreId\": \"hd2j3gh4ye\",\r\n \"DestinationStoreId\": \"fr4k54h1ye\",\r\n \"EntityName\": \"CatalogSettings\",\r\n \"SourceCount\": 2,\r\n \"DestinationCount\": 2,\r\n \"Status\": \"Completed\",\r\n \"ModifiedDate\": \"2022-04-17T15:20:18.86\",\r\n \"Error\": null\r\n },\r\n {\r\n \"MigrationId\": \"7f3bf7a6-ea6f-4d84-8054-7f9f4150e18e\",\r\n \"SourceStoreId\": \"hd2j3gh4ye\",\r\n \"DestinationStoreId\": \"fr4k54h1ye\",\r\n \"EntityName\": \"InventoryNotifications\",\r\n \"SourceCount\": 2,\r\n \"DestinationCount\": 2,\r\n \"Status\": \"Completed\",\r\n \"ModifiedDate\": \"2022-04-17T15:20:18.86\",\r\n \"Error\": null\r\n },\r\n {\r\n \"MigrationId\": \"7f3bf7a6-ea6f-4d84-8054-7f9f4150e18e\",\r\n \"SourceStoreId\": \"hd2j3gh4ye\",\r\n \"DestinationStoreId\": \"fr4k54h1ye\",\r\n \"EntityName\": \"WebAnalyticsProviders\",\r\n \"SourceCount\": 6,\r\n \"DestinationCount\": 6,\r\n \"Status\": \"Completed\",\r\n \"ModifiedDate\": \"2022-04-17T15:20:18.86\",\r\n \"Error\": null\r\n },\r\n {\r\n \"MigrationId\": \"7f3bf7a6-ea6f-4d84-8054-7f9f4150e18e\",\r\n \"SourceStoreId\": \"hd2j3gh4ye\",\r\n \"DestinationStoreId\": \"fr4k54h1ye\",\r\n \"EntityName\": \"StoreLogoSettings\",\r\n \"SourceCount\": 4,\r\n \"DestinationCount\": 4,\r\n \"Status\": \"Completed\",\r\n \"ModifiedDate\": \"2022-04-17T15:20:18.863\",\r\n \"Error\": null\r\n },\r\n {\r\n \"MigrationId\": \"7f3bf7a6-ea6f-4d84-8054-7f9f4150e18e\",\r\n \"SourceStoreId\": \"hd2j3gh4ye\",\r\n \"DestinationStoreId\": \"fr4k54h1ye\",\r\n \"EntityName\": \"StoreProfile\",\r\n \"SourceCount\": 1,\r\n \"DestinationCount\": 1,\r\n \"Status\": \"Completed\",\r\n \"ModifiedDate\": \"2022-04-17T15:20:18.863\",\r\n \"Error\": null\r\n }\r\n]"}],"_postman_id":"46ddade5-1909-4ed8-8daa-f1c573a9ffee"},{"name":"Migrate Store Data","id":"ff579f34-2a0a-4bb9-ac89-00fe521c2b4f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"body":{"mode":"raw","raw":"{\r\n \"MigrationId\": \"04c27dbd-8574-4832-b8b8-9b1c133e94d6\",\r\n \"RemoveExistingDataInDestination\": true,\r\n \"MigrateEntities\": [\r\n \"Pages\",\r\n \"WidgetTemplates\",\r\n \"Widgets\",\r\n \"CouponCodes\"\r\n ],\r\n \"AnonymiseCustomerData\": false,\r\n \"OrderStatuses\": [],\r\n \"Channels\": [\r\n \"Facebook (facebook)\"\r\n ],\r\n \"B2BData\": [],\r\n \"SourceStoreCredentials\": {\r\n \"StoreId\": \"z6a******tx29\",\r\n \"StoreUrl\": \"\",\r\n \"StoreAccessToken\": \"48haup32*******uerw5frvg2snplr\",\r\n \"Subscription\": false,\r\n \"ChannelID\": 1\r\n },\r\n \"DestinationStoreCredentials\": {\r\n \"StoreId\": \"xol****l5\",\r\n \"StoreUrl\": \"\",\r\n \"StoreAccessToken\": \"8zgpq48c********p43vigje7ykeqp\",\r\n \"Subscription\": false,\r\n \"ChannelID\": 1\r\n },\r\n \"IsScheduledRequest\": false,\r\n \"ScheduleDateTime\": null,\r\n \"Migrate_inventory_level\": true,\r\n \"Migrate_price\": true\r\n}"},"url":"https://api.stagingpro.com/v1/api/BigcFunction/MigrateStoreData","description":"

Migrate Store Data

This endpoint allows you to migrate store data using the specified parameters. The request should be sent as an HTTP POST to the given URL with the required payload in the raw request body.

Request Body

MigrationId (string): The unique identifier for the migration process.
\n
RemoveExistingDataInDestination (boolean): A flag indicating whether to remove existing data in the destination store.
\n
MigrateEntities (array of strings): The entities to be migrated.
\n
AnonymiseCustomerData (boolean): A flag indicating whether to anonymize customer data during migration.
\n
OrderStatuses (array): The statuses of orders to be migrated.
\n
Channels (array of strings): The channels from which data is to be migrated.
\n
B2BData (array): Additional B2B data to be migrated.
\n
SourceStoreCredentials (object): The credentials for the source store, including StoreId, StoreUrl, StoreAccessToken, and Subscription status.
\n
DestinationStoreCredentials (object): The credentials for the destination store, including StoreId, StoreUrl, StoreAccessToken, and Subscription status.
\n
IsScheduledRequest (boolean): A flag indicating whether the request is scheduled for a future date.
\n
ScheduleDateTime (datetime): The date and time for the scheduled request.
\n
Migrate_inventory_level (boolean): A flag indicating whether to migrate inventory levels.
\n
Migrate_price (boolean): A flag indicating whether to migrate prices.
\n

Response

The response for this request is in JSON format with the following structure:

Status (string): The status of the migration process.
\n
StatusComment (string): Additional comments or details about the migration status.
\n

{\n    \"Status\": \"\",\n    \"StatusComment\": \"\"\n}\n\n

Get Entity Errors

This endpoint makes an HTTP GET request to retrieve entity errors for a specific destination store and migration ID. The request URL is https://api.stagingpro.com/v1/api/BigcFunction/GetEntityErrors, and it includes query parameters for destinationStoreId, migrationId, and entityName.

Response

The response for this request is a JSON array containing objects with the following properties:

MigrateStoreDataErrorId (number): The ID of the migration store data error.
\n
MigrationId (string): The ID of the migration.
\n
SourceStoreId (string): The ID of the source store.
\n
DestinationStoreId (string): The ID of the destination store.
\n
EntityName (string): The name of the entity.
\n
Error (string): Description of the error.
\n
ModifiedDate (string): The date of modification.
\n

Here is an example response:

[{\"MigrateStoreDataErrorId\":0,\"MigrationId\":\"\",\"SourceStoreId\":\"\",\"DestinationStoreId\":\"\",\"EntityName\":\"\",\"Error\":\"\",\"ModifiedDate\":\"\"}]\n\n

Cancel Data Migration Request

This endpoint allows you to cancel the migration of store data.

Request Body

MigrationId (string): The ID of the migration to be cancelled.
\n
DestinationStoreId (string): The ID of the destination store.
\n

Response

The response will be a JSON object with the following properties:

MigrationId (string): The ID of the migration.
\n
SourceStoreId (string): The ID of the source store.
\n
DestinationStoreId (string): The ID of the destination store.
\n
Status (string): The status of the migration.
\n
PercentCompleted (number): The percentage of completion of the migration.
\n
Comment (string): Any additional comment related to the migration.
\n

JSON Schema

{\n  \"type\": \"object\",\n  \"properties\": {\n    \"MigrationId\": {\"type\": \"string\"},\n    \"SourceStoreId\": {\"type\": \"string\"},\n    \"DestinationStoreId\": {\"type\": \"string\"},\n    \"Status\": {\"type\": \"string\"},\n    \"PercentCompleted\": {\"type\": \"number\"},\n    \"Comment\": {\"type\": \"string\"}\n  }\n}\n\n

Get Migration History Report

The GetMigrationHistoryReport endpoint retrieves the migration history report based on the provided parameters. The response is a JSON object with two main properties: MigrateHistoryReport and MetaData.

The MigrateHistoryReport property contains an array of objects, where each object represents a migration history record. The objects have the following properties:

MigrationId (string): The ID of the migration.
\n
SourceStoreId (string): The ID of the source store.
\n
SourceStoreUrl (string): The URL of the source store.
\n
DestinationStoreId (string): The ID of the destination store.
\n
DestinationStoreUrl (string): The URL of the destination store.
\n
Status (string): The status of the migration.
\n
Comment (string): Any additional comments related to the migration.
\n
CreatedDate (string): The date of creation of the migration record.
\n
ModifiedDate (string): The date of modification of the migration record.
\n
IsScheduledRequest (boolean): Indicates if the migration is a scheduled request.
\n
ScheduleDateTime (string): The date and time of the scheduled migration.
\n
EntityType (string): The type of entity being migrated.
\n

The MetaData property contains information about the pagination and number of records. It has the following properties:

PageNumber (number): The current page number.
\n
PageSize (number): The number of records per page.
\n
NumberOfRecords (number): The total number of records.
\n

{\n  \"MigrateHistoryReport\": [\n    {\n      \"MigrationId\": \"\",\n      \"SourceStoreId\": \"\",\n      \"SourceStoreUrl\": \"\",\n      \"DestinationStoreId\": \"\",\n      \"DestinationStoreUrl\": \"\",\n      \"Status\": \"\",\n      \"Comment\": \"\",\n      \"CreatedDate\": \"\",\n      \"ModifiedDate\": \"\",\n      \"IsScheduledRequest\": true,\n      \"ScheduleDateTime\": \"\",\n      \"EntityType\": \"\"\n    }\n  ],\n  \"MetaData\": {\n    \"PageNumber\": 0,\n    \"PageSize\": 0,\n    \"NumberOfRecords\": 0\n  }\n}\n\n

One of the entity types. E.g.: Content, Product, Promotion, Theme

\n","type":"text/plain"},"key":"entityType","value":"entityType2"},{"key":"pageNumber","value":"1"},{"key":"pageSize","value":"10"}],"variable":[]}},"response":[{"id":"b2196346-adac-4a21-a3c4-a9b3ad98a676","name":"Response_200","originalRequest":{"method":"GET","header":[{"key":"fromDate","value":"application/json"},{"key":"Accept","value":"*/*"}],"url":{"raw":"https://api.stagingpro.com/v1/api/BigcFunction/GetMigrationHistoryReport?storeId=fr4k54h1ye&sourceStoreId=fr4k54h1ye&destinationStoreId=fr4k54h1ye&isScheduled=B1A4F5FB-9D24-4051-973A-D08927E346D1&toDate=2022-09-20&migrationId=34e2c1d0-6165-4868-8f0e-1261081171cd&entityType=entityType2&pageNumber=1&pageSize=10","protocol":"https","host":["api","stagingpro","com"],"path":["v1","api","BigcFunction","GetMigrationHistoryReport"],"query":[{"key":"storeId","value":"fr4k54h1ye"},{"key":"sourceStoreId","value":"fr4k54h1ye"},{"key":"destinationStoreId","value":"fr4k54h1ye"},{"key":"isScheduled","value":"B1A4F5FB-9D24-4051-973A-D08927E346D1"},{"key":"toDate","value":"2022-09-20"},{"key":"migrationId","value":"34e2c1d0-6165-4868-8f0e-1261081171cd"},{"key":"entityType","value":"entityType2","description":"One of the entity types. E.g.: Content, Product, Promotion, Theme"},{"key":"pageNumber","value":"1"},{"key":"pageSize","value":"10"}]}},"code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"MigrateHistoryReport\": [\r\n {\r\n \"MigrationId\": \"dd37eb5f-a************81-9ba1bb77d0a2\",\r\n \"SourceStoreId\": \"v6*****n91\",\r\n \"SourceStoreUrl\": \"https://bigi.247commerce.co.uk\",\r\n \"DestinationStoreId\": \"6b****1w\",\r\n \"DestinationStoreUrl\": \"https://bigidev-p9.mybigcommerce.com\",\r\n \"Status\": \"Cancelled\",\r\n \"Comment\": \"Request is cancelled\",\r\n \"CreatedDate\": \"2022-11-09T15:43:28.053\",\r\n \"ModifiedDate\": \"2022-11-09T15:43:50.45\",\r\n \"IsScheduledRequest\": true,\r\n \"ScheduleDateTime\": \"2022-11-20T18:00:00\",\r\n \"EntityType\": \"Theme\"\r\n },\r\n {\r\n \"MigrationId\": \"699cc6b4-5************e-df24dae4a21d\",\r\n \"SourceStoreId\": \"v6q9*****1\",\r\n \"SourceStoreUrl\": \"https://bigi.247commerce.co.uk\",\r\n \"DestinationStoreId\": \"6b****1w\",\r\n \"DestinationStoreUrl\": \"https://bigidev-p9.mybigcommerce.com\",\r\n \"Status\": \"Scheduled\",\r\n \"Comment\": \"Request scheduled successfully\",\r\n \"CreatedDate\": \"2022-11-09T15:43:14.917\",\r\n \"ModifiedDate\": \"2022-11-09T15:43:14.917\",\r\n \"IsScheduledRequest\": true,\r\n \"ScheduleDateTime\": \"2022-11-20T18:00:00\",\r\n \"EntityType\": \"Theme\"\r\n },\r\n {\r\n \"MigrationId\": \"8cbbaa8e-************-27f70eb31fa8\",\r\n \"SourceStoreId\": \"v6*****91\",\r\n \"SourceStoreUrl\": \"https://bigi.247commerce.co.uk\",\r\n \"DestinationStoreId\": \"6b*****1w\",\r\n \"DestinationStoreUrl\": \"https://bigidev-p9.mybigcommerce.com\",\r\n \"Status\": \"Cancelled\",\r\n \"Comment\": \"Request is cancelled\",\r\n \"CreatedDate\": \"2022-11-09T15:41:32.8\",\r\n \"ModifiedDate\": \"2022-11-10T11:32:48.927\",\r\n \"IsScheduledRequest\": true,\r\n \"ScheduleDateTime\": \"2022-11-20T18:00:00\",\r\n \"EntityType\": \"Theme\"\r\n },\r\n {\r\n \"MigrationId\": \"8db5f230-************1b93e669d88f\",\r\n \"SourceStoreId\": \"wt****tm\",\r\n \"SourceStoreUrl\": \"https://production-g9.mybigcommerce.com\",\r\n \"DestinationStoreId\": \"xk******lf\",\r\n \"DestinationStoreUrl\": \"https://staging-j2.mybigcommerce.com\",\r\n \"Status\": \"Completed\",\r\n \"Comment\": \"Publish Completed\",\r\n \"CreatedDate\": \"2022-11-08T10:11:34.907\",\r\n \"ModifiedDate\": \"2022-11-08T11:00:50.39\",\r\n \"IsScheduledRequest\": true,\r\n \"ScheduleDateTime\": \"2022-11-08T11:00:00\",\r\n \"EntityType\": \"Content\"\r\n },\r\n {\r\n \"MigrationId\": \"87dd7da9-************-6108d6d01cb0\",\r\n \"SourceStoreId\": \"w******tm\",\r\n \"SourceStoreUrl\": \"https://production-g9.mybigcommerce.com\",\r\n \"DestinationStoreId\": \"xk*******lf\",\r\n \"DestinationStoreUrl\": \"https://staging-j2.mybigcommerce.com\",\r\n \"Status\": \"Cancelled\",\r\n \"Comment\": \"Request is cancelled\",\r\n \"CreatedDate\": \"2022-11-08T07:18:56.44\",\r\n \"ModifiedDate\": \"2022-11-08T07:36:07.41\",\r\n \"IsScheduledRequest\": true,\r\n \"ScheduleDateTime\": \"2022-11-08T08:00:00\",\r\n \"EntityType\": \"Product\"\r\n },\r\n {\r\n \"MigrationId\": \"f782a71c-************-e6c1eba973f3\",\r\n \"SourceStoreId\": \"wt********tm\",\r\n \"SourceStoreUrl\": \"https://production-g9.mybigcommerce.com\",\r\n \"DestinationStoreId\": \"xk******lf\",\r\n \"DestinationStoreUrl\": \"https://staging-j2.mybigcommerce.com\",\r\n \"Status\": \"Success\",\r\n \"Comment\": \"Success\",\r\n \"CreatedDate\": \"2022-11-07T17:15:10.13\",\r\n \"ModifiedDate\": \"2022-11-07T18:00:08.44\",\r\n \"IsScheduledRequest\": true,\r\n \"ScheduleDateTime\": \"2022-11-07T18:00:00\",\r\n \"EntityType\": \"Product\"\r\n },\r\n {\r\n \"MigrationId\": \"a24ef7c8-************-dbd350476ffa\",\r\n \"SourceStoreId\": \"wt*******tm\",\r\n \"SourceStoreUrl\": \"https://production-g9.mybigcommerce.com\",\r\n \"DestinationStoreId\": \"xk******f\",\r\n \"DestinationStoreUrl\": \"https://staging-j2.mybigcommerce.com\",\r\n \"Status\": \"Success\",\r\n \"Comment\": \"Success\",\r\n \"CreatedDate\": \"2022-11-07T17:08:07.313\",\r\n \"ModifiedDate\": \"2022-11-07T18:00:09.85\",\r\n \"IsScheduledRequest\": true,\r\n \"ScheduleDateTime\": \"2022-11-07T18:00:00\",\r\n \"EntityType\": \"Product\"\r\n },\r\n {\r\n \"MigrationId\": \"7aff2065-************3-463cb6c5406e\",\r\n \"SourceStoreId\": \"wt*****m\",\r\n \"SourceStoreUrl\": \"https://production-g9.mybigcommerce.com\",\r\n \"DestinationStoreId\": \"xk*******f\",\r\n \"DestinationStoreUrl\": \"https://staging-j2.mybigcommerce.com\",\r\n \"Status\": \"Cancelled\",\r\n \"Comment\": \"Request is cancelled\",\r\n \"CreatedDate\": \"2022-11-07T17:02:25.817\",\r\n \"ModifiedDate\": \"2022-11-07T17:17:30.967\",\r\n \"IsScheduledRequest\": true,\r\n \"ScheduleDateTime\": \"2022-11-07T18:00:00\",\r\n \"EntityType\": \"Content\"\r\n },\r\n {\r\n \"MigrationId\": \"8d0ed7e2-************c-7d8dc1541671\",\r\n \"SourceStoreId\": \"wtg*****m\",\r\n \"SourceStoreUrl\": \"https://production-g9.mybigcommerce.com\",\r\n \"DestinationStoreId\": \"xk********lf\",\r\n \"DestinationStoreUrl\": \"https://staging-j2.mybigcommerce.com\",\r\n \"Status\": \"Cancelled\",\r\n \"Comment\": \"Request is cancelled\",\r\n \"CreatedDate\": \"2022-11-07T14:50:59.07\",\r\n \"ModifiedDate\": \"2022-11-07T14:51:26.417\",\r\n \"IsScheduledRequest\": true,\r\n \"ScheduleDateTime\": \"2022-11-07T15:00:00\",\r\n \"EntityType\": \"Content\"\r\n },\r\n {\r\n \"MigrationId\": \"e68c5062-************-5fc6d173ca08\",\r\n \"SourceStoreId\": \"wt********tm\",\r\n \"SourceStoreUrl\": \"https://production-g9.mybigcommerce.com\",\r\n \"DestinationStoreId\": \"w*******k\",\r\n \"DestinationStoreUrl\": \"https://247-commerce-sandbox-store.mybigcommerce.com\",\r\n \"Status\": \"Success\",\r\n \"Comment\": \"Success\",\r\n \"CreatedDate\": \"2022-11-07T14:37:31.043\",\r\n \"ModifiedDate\": \"2022-11-07T15:00:06.137\",\r\n \"IsScheduledRequest\": true,\r\n \"ScheduleDateTime\": \"2022-11-07T15:00:00\",\r\n \"EntityType\": \"Product\"\r\n }\r\n ],\r\n \"MetaData\": {\r\n \"PageNumber\": 2,\r\n \"PageSize\": 10,\r\n \"NumberOfRecords\": 145\r\n }\r\n}"}],"_postman_id":"373717dc-5f43-4822-a408-0bc9cbd8ece8"},{"name":"Get Scheduled Migration Data Requests","id":"652bf331-e293-4be6-a8bc-62654e943145","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"*/*"}],"url":"https://api.stagingpro.com/v1/api/BigcFunction/GetAnyScheduledMigrateDataRequests?destinationStoreId=c34jj344u3&scheduledDate=B1A4F5FB-9D24-4051-973A-D08927E346D1&entityType=entityType71&entityIds=%5B%22entityIds71%22%5D&migrationId=migrationId71","description":"

Get Scheduled Migration Data Requests

This endpoint retrieves any scheduled migrate data requests based on the provided parameters.

Request

Query Parameters

destinationStoreId (string, required): The ID of the destination store.
\n
scheduledDate (string, required): The scheduled date for the migration request.
\n
entityType (string, required): The type of entity for the migration request.
\n
entityIds (array of strings, required): The IDs of the entities to be migrated.
\n
migrationId (string, required): The ID of the migration.
\n

Example

https://api.stagingpro.com/v1/api/BigcFunction/GetAnyScheduledMigrateDataRequests?destinationStoreId=c34jj344u3&scheduledDate=B1A4F5FB-9D24-4051-973A-D08927E346D1&entityType=entityType71&entityIds=[\"entityIds71\"]&migrationId=migrationId71\n\n

Response

The response will be an array of objects with the following properties:

MigrationId (string): The ID of the migration.
\n
SourceStoreId (string): The ID of the source store.
\n
SourceStoreUrl (string): The URL of the source store.
\n
SourceEntityId (string): The ID of the source entity.
\n
DestinationStoreId (string): The ID of the destination store.
\n
DestinationStoreUrl (string): The URL of the destination store.
\n
MigrateEntities (array of strings): The entities to be migrated.
\n
Status (string): The status of the migration request.
\n
Comment (string): Any additional comments for the request.
\n
CreatedDate (string): The date of creation of the request.
\n
ModifiedDate (string): The date of modification of the request.
\n
IsScheduledRequest (boolean): Indicates if the request is scheduled.
\n
ScheduleDateTime (string): The scheduled date and time for the request.
\n
Rdata (string): Additional data related to the request.
\n

Example Response

[{\"MigrationId\":\"\",\"SourceStoreId\":\"\",\"SourceStoreUrl\":\"\",\"SourceEntityId\":null,\"DestinationStoreId\":\"\",\"DestinationStoreUrl\":\"\",\"MigrateEntities\":[\"\"],\"Status\":\"\",\"Comment\":\"\",\"CreatedDate\":\"\",\"ModifiedDate\":\"\",\"IsScheduledRequest\":true,\"ScheduleDateTime\":\"\",\"Rdata\":null}]\n\n

One of the entity types. E.g.: Content, Product, Promotion, Theme

\n","type":"text/plain"},"key":"entityType","value":"entityType71"},{"description":{"content":"

Required for all entity types other than entity type \"Content\"

\n","type":"text/plain"},"key":"entityIds","value":"%5B%22entityIds71%22%5D"},{"key":"migrationId","value":"migrationId71"}],"variable":[]}},"response":[{"id":"196ebadf-8104-4c15-a389-81aaedccd6ba","name":"Response_200","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"*/*"}],"url":{"raw":"https://api.stagingpro.com/v1/api/BigcFunction/GetAnyScheduledMigrateDataRequests?destinationStoreId=c34jj344u3&scheduledDate=B1A4F5FB-9D24-4051-973A-D08927E346D1&entityType=entityType71&entityIds=%5B%22entityIds71%22%5D&migrationId=migrationId71","protocol":"https","host":["api","stagingpro","com"],"path":["v1","api","BigcFunction","GetAnyScheduledMigrateDataRequests"],"query":[{"key":"destinationStoreId","value":"c34jj344u3"},{"key":"scheduledDate","value":"B1A4F5FB-9D24-4051-973A-D08927E346D1"},{"key":"entityType","value":"entityType71","description":"One of the entity types. E.g.: Content, Product, Promotion, Theme"},{"key":"entityIds","value":"%5B%22entityIds71%22%5D","description":"Required for all entity types other than entity type \"Content\""},{"key":"migrationId","value":"migrationId71"}]}},"code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"MigrationId\": \"f6315712-2b33-4601-ae76-dada79d87f43\",\r\n \"SourceStoreId\": \"v6qsds491\",\r\n \"SourceStoreUrl\": \"https://bigi233.247commerce.co.uk\",\r\n \"SourceEntityId\": null,\r\n \"DestinationStoreId\": \"fgtbisrb9x\",\r\n \"DestinationStoreUrl\": \"https://bigi23.247commerce.co.uk\",\r\n \"MigrateEntities\": [\r\n \"Brands\",\r\n \"Categories\"\r\n ],\r\n \"Status\": \"Scheduled\",\r\n \"Comment\": \"Your requested migration is scheduled\",\r\n \"CreatedDate\": \"2022-11-24T12:57:00.673\",\r\n \"ModifiedDate\": \"2022-11-24T12:57:00.673\",\r\n \"IsScheduledRequest\": true,\r\n \"ScheduleDateTime\": \"2022-12-01T00:00:00\",\r\n \"Rdata\": null\r\n },\r\n {\r\n \"MigrationId\": \"e5334712-2b33-4601-ae76-dada79d87s32\",\r\n \"SourceStoreId\": \"4fs442dh6hy\",\r\n \"SourceStoreUrl\": \"https://bigi233.247commerce.co.uk\",\r\n \"SourceEntityId\": null,\r\n \"DestinationStoreId\": \"fgtbisrb9x\",\r\n \"DestinationStoreUrl\": \"https://bigi233.247commerce.co.uk\",\r\n \"MigrateEntities\": [\r\n \"Brands\",\r\n \"Categories\",\r\n \"Products\"\r\n ],\r\n \"Status\": \"Scheduled\",\r\n \"Comment\": \"Your requested migration is scheduled\",\r\n \"CreatedDate\": \"2022-11-24T12:57:00.673\",\r\n \"ModifiedDate\": \"2022-11-24T12:57:00.673\",\r\n \"IsScheduledRequest\": true,\r\n \"ScheduleDateTime\": \"2022-12-01T00:00:00\",\r\n \"Rdata\": null\r\n }\r\n]"}],"_postman_id":"652bf331-e293-4be6-a8bc-62654e943145"},{"name":"Get In Progress Content Migration","id":"2cd3dfbc-33ae-419d-90cb-bd4d4fc48a24","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"url":"https://api.stagingpro.com/v1/api/BigcFunction/GetIfAnyInProgressContentMigration?sourceStoreId=hd2j3gh4ye&destinationStoreId=j%2A%2A%2A%2A%2A%2Ake","description":"

Get In-Progress Content Migration Request

The GetIfAnyInProgressContentMigration endpoint returns a JSON response with the following schema:

{\n  \"AnyInProgressContentMigration\": \"boolean\",\n  \"Status\": \"string\",\n  \"PercentCompleted\": \"number\",\n  \"Comment\": \"string\",\n  \"RequestJson\": {\n    \"MigrationId\": \"string\",\n    \"RemoveExistingDataInDestination\": \"boolean\",\n    \"MigrateEntities\": [\"string\"],\n    \"AnonymiseCustomerData\": \"boolean\",\n    \"OrderStatuses\": [\"string\"],\n    \"Channels\": [\"string\"],\n    \"B2BData\": [\"string\"],\n    \"IsScheduledRequest\": \"boolean\",\n    \"ScheduleDateTime\": \"string\"\n  }\n}\n\n

Get Store Data Summary (GET):
Retrieves a summary of store data, including counts of pages, widgets, banners, abandoned cart email templates, products, and other store-related entities.

Get Data Migration Status (GET):
Checks the status of the migration process for a store's data. It returns progress details, such as the percentage completed and current status of the migration.

Get Data Migration Entity Status (GET):
Fetches the migration status of individual entities (e.g., brands, categories, products) during a store migration process. It includes source and destination counts for each entity.

Migrate Store Data (POST):
Initiates the migration of store data from one store to another. The request specifies the entities to be migrated, whether to remove existing data in the destination, and migration credentials for both source and destination stores.

Get Entity Errors (GET):
Retrieves any errors encountered during the migration of specific entities (e.g., CustomerGroups) between stores. This includes details about conflicts or other migration issues.

Cancel Data Migration Request (POST):
Cancels a scheduled migration request. The request needs the migration ID and destination store ID, and on success, it confirms that the migration request has been canceled.

Get Data Migration History Report (GET):
Generates a report of past migration history for a store, including details of each migration, such as status, comments, scheduled time, and entity types involved.

Get Scheduled Migration Data Requests (GET):
Returns any scheduled migration requests for the specified destination store, including migration details such as the entities involved and the scheduled date.

Get In Progress Content Migration (GET):
Retrieves the current status of content migration, indicating if any migration tasks are in progress.

\n","_postman_id":"026b39e6-34dd-462d-93a6-ebf77bba0753","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}],"advancedConfig":[{"key":"scope","value":""}]},"isInherited":true,"source":{"_postman_id":"ff9b5483-6175-4820-8b01-decb508889f7","id":"ff9b5483-6175-4820-8b01-decb508889f7","name":"StagingPro API - Documentation","type":"collection"}}},{"name":"Product Migration","item":[{"name":"Product Migration","id":"f96acc95-caaf-4aeb-9877-915de8abd744","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"body":{"mode":"raw","raw":"{\r\n \"MigrationId\": \"ff6**bba-0a3f-4f8e-9e20-585****cb679\",\r\n \"ProductId\": 3652,\r\n \"Brand\": true,\r\n \"Categories\": true,\r\n \"IsDestinationProduction\": true,\r\n \"SourceStoreCredentials\": {\r\n \"StoreId\": \"rkz****vtj\",\r\n \"StoreUrl\": \"https:**********mmerce.com\",\r\n \"StoreAccessToken\": \"6ft8os**********qylmyrg832j1m36uk\",\r\n \"Subscription\": false,\r\n \"ChannelID\": 1\r\n },\r\n \"DestinationStoreCredentials\": {\r\n \"StoreId\": \"g5****857h\",\r\n \"StoreUrl\": \"https://pharmacy2**********1.mybigcommerce.com\",\r\n \"StoreAccessToken\": \"jazabe**********8dz6batinj0s8dt\",\r\n \"Subscription\": false,\r\n \"ChannelID\": 1\r\n },\r\n \"IsScheduledRequest\": false,\r\n \"ScheduleDateTime\": null,\r\n \"Migrate_inventory_level\": false,\r\n \"Migrate_price\": false\r\n}"},"url":"https://api.stagingpro.com/v1/api/BigcFunction/BigcProductUpdate","description":"

Product Migration

This HTTP POST request is used to update a big product in the staging environment. The request payload includes a unique MigrationId, ProductId, Brand, Categories, SourceStoreCredentials, DestinationStoreCredentials, IsScheduledRequest, ScheduleDateTime, Migrate_inventory_level, and Migrate_price. The SourceStoreCredentials and DestinationStoreCredentials contain StoreId, StoreUrl, StoreAccessToken, Subscription, and ChannelID. The request body is in raw format.

Request Body

MigrationId (string): Unique migration ID
\n
ProductId (integer): ID of the product
\n
Brand (boolean): Indicates if brand information is included
\n
Categories (boolean): Indicates if category information is included
\n
IsDestinationProduction (boolean): Indicates if the destination is a production environment
\n
SourceStoreCredentials (object): Credentials for the source store
\n
- StoreId (string): ID of the source store
  \n
- StoreUrl (string): URL of the source store
  \n
- StoreAccessToken (string): Access token for the source store
  \n
- Subscription (boolean): Indicates if there is a subscription
  \n
- ChannelID (integer): ID of the channel
  \n
\n
DestinationStoreCredentials (object): Credentials for the destination store
\n
- StoreId (string): ID of the destination store
  \n
- StoreUrl (string): URL of the destination store
  \n
- StoreAccessToken (string): Access token for the destination store
  \n
- Subscription (boolean): Indicates if there is a subscription
  \n
- ChannelID (integer): ID of the channel
  \n
\n
IsScheduledRequest (boolean): Indicates if the request is scheduled
\n
ScheduleDateTime (string): Date and time of scheduled request
\n
Migrate_inventory_level (boolean): Indicates if inventory level migration is required
\n
Migrate_price (boolean): Indicates if price migration is required
\n

Response

The response includes Status and StatusComment, but the values are not provided in the examples.

Get Product Migration Status

This endpoint retrieves the update status of a product migration.

Request

Method: GET
\n
Endpoint: https://api.stagingpro.com/v1/api/BigcFunction/GetBigcProductUpdateStatus
\n
Query Parameters:
\n
- destinationStoreId (string, required): The ID of the destination store.
  \n
- migrationId (string, required): The ID of the migration.
  \n
\n

Response

The response for this request follows the JSON schema below:

{\n  \"type\": \"object\",\n  \"properties\": {\n    \"MigrationId\": { \"type\": \"string\" },\n    \"SourceStoreId\": { \"type\": \"string\" },\n    \"DestinationStoreId\": { \"type\": \"string\" },\n    \"SourceProductId\": { \"type\": \"integer\" },\n    \"DestinationProductId\": { \"type\": \"integer\" },\n    \"Status\": { \"type\": \"string\" },\n    \"Comment\": { \"type\": [\"string\", \"null\"] },\n    \"ModifiedDate\": { \"type\": \"string\" },\n    \"IsScheduledRequest\": { \"type\": \"boolean\" },\n    \"ScheduleDateTime\": { \"type\": \"string\" }\n  }\n}\n\n

Cancel Scheduled Product Migration Request

This API endpoint is used to cancel a scheduled product update request.

Request Body

MigrationId (string, required): The ID of the migration.
\n
DestinationStoreId (string, required): The ID of the destination store.
\n

Response
The response for this request follows the JSON schema below:

{\n  \"type\": \"object\",\n  \"properties\": {\n    \"MigrationId\": {\"type\": \"string\"},\n    \"SourceStoreId\": {\"type\": \"string\"},\n    \"DestinationStoreId\": {\"type\": \"string\"},\n    \"SourceProductId\": {\"type\": \"integer\"},\n    \"DestinationProductId\": {\"type\": [\"integer\", \"null\"]},\n    \"Status\": {\"type\": \"string\"},\n    \"Comment\": {\"type\": \"string\"},\n    \"ModifiedDate\": {\"type\": \"string\"},\n    \"IsScheduledRequest\": {\"type\": \"boolean\"},\n    \"ScheduleDateTime\": {\"type\": \"string\"}\n  }\n}\n\n

Product Migration (POST):
This API updates product details from a source BigCommerce store to a destination store. The request includes information like product ID, categories, and brand, along with credentials for both stores. This is used for migrating product-related data.

Get Product Migration Status (GET):
Retrieves the status of an ongoing or completed product update. It returns information about the source and destination product IDs, as well as the migration status (e.g., completed, in progress, or failed).

Cancel Scheduled Product Migration Request (POST):
Cancels a scheduled product update request in BigCommerce. This API requires the migration ID and destination store ID to cancel the scheduled migration of product data between stores.EndFragment

\n","_postman_id":"a10b7e00-8e31-4619-a49e-2d7ea39db606","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}],"advancedConfig":[{"key":"scope","value":""}]},"isInherited":true,"source":{"_postman_id":"ff9b5483-6175-4820-8b01-decb508889f7","id":"ff9b5483-6175-4820-8b01-decb508889f7","name":"StagingPro API - Documentation","type":"collection"}}},{"name":"Promotion Migration","item":[{"name":"Promotion Migration","id":"ed286718-fc48-4883-8d89-a2863372655b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"body":{"mode":"raw","raw":"{\r\n \"MigrationId\": \"3edefdd6-1229-4239-b20f-f06cc2150741\",\r\n \"PromotionId\": 148,\r\n \"IsDestinationProduction\": true,\r\n \"SourceStoreCredentials\": {\r\n \"StoreId\": \"18ym****tr\",\r\n \"StoreUrl\": \"https://staging.thew****er.co.uk\",\r\n \"StoreAccessToken\": \"53fds**************svjkkswb5op\",\r\n \"Subscription\": false,\r\n \"ChannelID\": 1\r\n },\r\n \"DestinationStoreCredentials\": {\r\n \"StoreId\": \"eb****dvaq\",\r\n \"StoreUrl\": \"https://the****lyer.co.uk\",\r\n \"StoreAccessToken\": \"ihi2d32****4fsntly7g83mgsk6d6\",\r\n \"Subscription\": false,\r\n \"ChannelID\": 1\r\n },\r\n \"IsScheduledRequest\": false,\r\n \"ScheduleDateTime\": null\r\n}"},"url":"https://api.stagingpro.com/v1/api/BigcFunction/BigcPromotionUpdate","description":"

Promotion Migration

This endpoint allows you to update a BigCommerce promotion by making an HTTP POST request to the specified URL.

Request Body

MigrationId (string) - The migration ID for the promotion update.
\n
PromotionId (integer) - The ID of the promotion to be updated.
\n
IsDestinationProduction (boolean) - Indicates whether the destination store is in production.
\n
SourceStoreCredentials (object) - The credentials for the source store, including StoreId, StoreUrl, StoreAccessToken, Subscription, and ChannelID.
\n
DestinationStoreCredentials (object) - The credentials for the destination store, including StoreId, StoreUrl, StoreAccessToken, Subscription, and ChannelID.
\n
IsScheduledRequest (boolean) - Indicates whether the request is scheduled.
\n
ScheduleDateTime (null) - The scheduled date and time for the request.
\n

Response

Status (string) - The status of the promotion update request.
\n
StatusComment (string) - Additional comments or details related to the status.
\n

Get Promotion Migration Status

This endpoint retrieves the status of a promotion update based on the provided destination store ID and migration ID.

Request

Method: GET
\n
URL: https://api.stagingpro.com/v1/api/BigcFunction/GetBigcPromotionUpdateStatus
\n
Query Parameters:
\n
- destinationStoreId (string, required): The ID of the destination store
  \n
- migrationId (string, required): The ID of the migration
  \n
\n

Response

The response for this request follows the JSON schema below:

{\n  \"type\": \"object\",\n  \"properties\": {\n    \"MigrationId\": {\"type\": \"string\"},\n    \"SourceStoreId\": {\"type\": \"string\"},\n    \"DestinationStoreId\": {\"type\": \"string\"},\n    \"SourcePromotionId\": {\"type\": \"integer\"},\n    \"DestinationPromotionId\": {\"type\": \"integer\"},\n    \"Status\": {\"type\": \"string\"},\n    \"Comment\": {\"type\": \"string\"},\n    \"ModifiedDate\": {\"type\": \"string\"},\n    \"IsScheduledRequest\": {\"type\": \"boolean\"},\n    \"ScheduleDateTime\": {\"type\": [\"string\", \"null\"]}\n  }\n}\n\n

Cancel Scheduled Promotion Migration Request

This endpoint allows you to cancel a scheduled promotion update request.

Request Body

Raw JSON
\n
- MigrationId (string): The ID of the migration
  \n
- DestinationStoreId (string): The ID of the destination store
  \n
\n

Response

The response is a JSON object with the following properties:

MigrationId (string): The ID of the migration
\n
SourceStoreId (string): The ID of the source store
\n
DestinationStoreId (string): The ID of the destination store
\n
SourcePromotionId (number): The ID of the source promotion
\n
DestinationPromotionId (number): The ID of the destination promotion
\n
Status (string): The status of the request
\n
Comment (string): Additional comments
\n
ModifiedDate (string): The date of modification
\n
IsScheduledRequest (boolean): Indicates if the request is scheduled
\n
ScheduleDateTime (string): The scheduled date and time
\n

{\n  \"MigrationId\": \"\",\n  \"SourceStoreId\": \"\",\n  \"DestinationStoreId\": \"\",\n  \"SourcePromotionId\": 0,\n  \"DestinationPromotionId\": null,\n  \"Status\": \"\",\n  \"Comment\": \"\",\n  \"ModifiedDate\": \"\",\n  \"IsScheduledRequest\": true,\n  \"ScheduleDateTime\": \"\"\n}\n\n

Promotion Migration (POST):
This API updates promotion details from a source BigCommerce store to a destination store. It involves migrating promotion settings and configurations. The request includes details such as the source and destination promotion IDs, and it can also handle scheduling for the migration.

Get Promotion Migration Status (GET):
Retrieves the current status of a promotion update request in BigCommerce. It returns details such as the source and destination promotion IDs and the status of the migration (e.g., completed, in progress, or failed).EndFragment

Cancel Scheduled Promotion Migration Request (POST):
Cancels a scheduled promotion update request for BigCommerce. The request requires the migration ID and destination store ID to successfully cancel the migration of promotions.

\n","_postman_id":"f9228aa2-cb35-4be9-884c-e8879a425697","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}],"advancedConfig":[{"key":"scope","value":""}]},"isInherited":true,"source":{"_postman_id":"ff9b5483-6175-4820-8b01-decb508889f7","id":"ff9b5483-6175-4820-8b01-decb508889f7","name":"StagingPro API - Documentation","type":"collection"}}},{"name":"Category Migration","item":[{"name":"Get Category Migration Status","id":"3f9e77ed-8023-4a07-af05-3f66bf168870","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"url":"https://api.stagingpro.com/v1/api/BigcFunction/GetBigcCategoryUpdateStatus?destinationStoreId=fr4k54h1ye&migrationId=706DCEB7-273E-407F-A588-81598602E77E","description":"

Get Category Migration Status

This endpoint retrieves the status of a Bigc category update based on the provided destination store ID and migration ID.

Request

Method: GET
\n
Endpoint: https://api.stagingpro.com/v1/api/BigcFunction/GetBigcCategoryUpdateStatus
\n
Query Parameters:
\n
- destinationStoreId (string, required): The ID of the destination store.
  \n
- migrationId (string, required): The ID of the migration.
  \n
\n

Response

The response for this request follows the JSON schema below:

{\n  \"type\": \"object\",\n  \"properties\": {\n    \"MigrationId\": { \"type\": \"string\" },\n    \"SourceStoreId\": { \"type\": \"string\" },\n    \"DestinationStoreId\": { \"type\": \"string\" },\n    \"SourceProductId\": { \"type\": \"integer\" },\n    \"DestinationProductId\": { \"type\": \"integer\" },\n    \"Status\": { \"type\": \"string\" },\n    \"Comment\": { \"type\": [\"null\", \"string\"] },\n    \"ModifiedDate\": { \"type\": \"string\" },\n    \"IsScheduledRequest\": { \"type\": \"boolean\" },\n    \"ScheduleDateTime\": { \"type\": \"string\" }\n  }\n}\n\n

Category Migration

The POST request to /v1/api/BigcFunction/BigcCategoryUpdate endpoint is used to update a bigcommerce category. The request body should contain the MigrationId, CategoryId, DestinationChannelId, IsDestinationProduction, SourceStoreCredentials, DestinationStoreCredentials, IsScheduledRequest, ScheduleDateTime, and SourceChannelId.

Request Body

MigrationId (string): The unique identifier for the migration.
\n
CategoryId (integer): The ID of the category to be updated.
\n
DestinationChannelId (integer): The ID of the destination channel.
\n
IsDestinationProduction (boolean): Indicates whether the destination is a production environment.
\n
SourceStoreCredentials (object): The credentials for the source store including StoreId, StoreUrl, StoreAccessToken, Subscription, and ChannelID.
\n
DestinationStoreCredentials (object): The credentials for the destination store including StoreId, StoreUrl, StoreAccessToken, Subscription, and ChannelID.
\n
IsScheduledRequest (boolean): Indicates if the request is scheduled.
\n
ScheduleDateTime (string): The date and time for the scheduled request.
\n
SourceChannelId (integer): The ID of the source channel.
\n

Response

The response of this request will be a JSON object conforming to a specific schema. The schema should be documented to describe the structure and data types of the response fields.

Category Migration (POST):
This API updates category details from a source BigCommerce store to a destination store. It involves migrating category data, such as category IDs, names, and associated details. The request can also handle scheduling for the category update.

Get Category Migration Status (GET):
Retrieves the status of a category update request in BigCommerce. It returns information about the source and destination category IDs and the current status of the migration, such as whether it is completed or still in progress.

\n","_postman_id":"1af2e903-50d2-4a61-9e17-215b3e4cce13","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}],"advancedConfig":[{"key":"scope","value":""}]},"isInherited":true,"source":{"_postman_id":"ff9b5483-6175-4820-8b01-decb508889f7","id":"ff9b5483-6175-4820-8b01-decb508889f7","name":"StagingPro API - Documentation","type":"collection"}}},{"name":"Theme Migration","item":[{"name":"Theme Migration","id":"07103860-f34b-421a-93cb-6b63918dd836","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"body":{"mode":"raw","raw":"{\r\n \"MigrationId\": \"b384edae-4be5-4343-91c6-2b9ff9cf7704\",\r\n \"BigcTheme\": {\r\n \"ThemeUuid\": \"86910fb0-54a0-013c-5db5-2ec360b8bf3e\",\r\n \"ThemeName\": \"Current - 102124\",\r\n \"ActivateInDestination\": false,\r\n \"ThemeVariationUuid\": \"8719e440-54a0-013c-5db5-2ec360b8bf3e\",\r\n \"ThemeVariationName\": \"Fashion\",\r\n \"DestinationChannelId\": 1\r\n },\r\n \"SourceStoreCredentials\": {\r\n \"StoreId\": \"s******z\",\r\n \"StoreUrl\": \"\",\r\n \"StoreAccessToken\": \"1ekqe******vwl3votahsg\",\r\n \"Subscription\": false,\r\n \"ChannelID\": 1\r\n },\r\n \"DestinationStoreCredentials\": {\r\n \"StoreId\": \"xz******xm\",\r\n \"StoreUrl\": \"\",\r\n \"StoreAccessToken\": \"gzgbm7nu******6u4m9k53kqoy8p4rn\",\r\n \"Subscription\": false,\r\n \"ChannelID\": 1\r\n },\r\n \"IsScheduledRequest\": false,\r\n \"ScheduleDateTime\": null\r\n}"},"url":"https://api.stagingpro.com/v1/api/BigcTheme/MigrateTheme","description":"

Theme Migration

This API endpoint allows you to migrate a theme from a source store to a destination store. The HTTP POST request should be made to https://api.stagingpro.com/v1/api/BigcTheme/MigrateTheme.

Request Body

The request body should be in JSON format and include the following parameters:

MigrationId: A unique identifier for the migration process.
\n
BigcTheme: An object containing details of the theme to be migrated, including ThemeUuid, ThemeName, ActivateInDestination, ThemeVariationUuid, ThemeVariationName, and DestinationChannelId.
\n
SourceStoreCredentials: An object containing the credentials of the source store, including StoreId, StoreUrl, StoreAccessToken, Subscription, and ChannelID.
\n
DestinationStoreCredentials: An object containing the credentials of the destination store, including StoreId, StoreUrl, StoreAccessToken, Subscription, and ChannelID.
\n
IsScheduledRequest: A boolean value indicating whether the request is scheduled.
\n
ScheduleDateTime: The date and time for a scheduled request, if applicable.
\n

Response

The response for this request is in JSON format and includes the following parameters:

Status: Indicates the status of the migration process.
\n
StatusComment: Provides additional comments or details about the status.
\n

JSON Schema

{\n  \"type\": \"object\",\n  \"properties\": {\n    \"Status\": {\"type\": \"string\"},\n    \"StatusComment\": {\"type\": \"string\"}\n  }\n}\n\n

Get Theme Migration Status

This endpoint retrieves the status of a theme migration process.

Request

Method: GET
\n
URL: https://api.stagingpro.com/v1/api/BigcTheme/GetMigrateThemeStatus
\n
Query Parameters:
\n
- destinationStoreId (string, required): The ID of the destination store.
  \n
- migrationId (string, required): The ID of the migration.
  \n
\n

Response

MigrationId (string): The ID of the migration.
\n
SourceStoreId (string): The ID of the source store.
\n
DestinationStoreId (string): The ID of the destination store.
\n
SourceThemeUuid (string): The UUID of the source theme.
\n
DestinationThemeUuid (string): The UUID of the destination theme.
\n
Status (string): The status of the migration process.
\n
Comment (string): Any additional comments related to the migration status.
\n
ModifiedDate (string): The date of the last modification.
\n
IsScheduledRequest (boolean): Indicates if the request is scheduled.
\n
ScheduleDateTime (string): The date and time of the scheduled request.
\n

Cancel Scheduled Migration Theme Request

This API endpoint is used to cancel a scheduled migration theme request. The request should be sent as an HTTP POST to the specified URL.

Request Body

MigrationId (string) - The ID of the migration to be canceled.
\n
DestinationStoreId (string) - The ID of the destination store.
\n

Example Request Body:

{\n    \"MigrationId\": \"40cb5644-8834-4961-84b3-aae1b4 ...\",\n    \"DestinationStoreId\": \"sfh*******S\"\n}\n\n

Response

The response will include the following fields:

MigrationId (string) - The ID of the migration.
\n
SourceStoreId (string) - The ID of the source store.
\n
DestinationStoreId (string) - The ID of the destination store.
\n
SourceThemeUuid (string) - The UUID of the source theme.
\n
DestinationThemeUuid (string, null) - The UUID of the destination theme, if available.
\n
Status (string) - The status of the migration request.
\n
Comment (string) - Any additional comments related to the migration.
\n
ModifiedDate (string) - The date of modification.
\n
IsScheduledRequest (boolean) - Indicates if the request is scheduled.
\n
ScheduleDateTime (string) - The date and time of the scheduled request.
\n

Example Response:

{\n    \"MigrationId\": \"\",\n    \"SourceStoreId\": \"\",\n    \"DestinationStoreId\": \"\",\n    \"SourceThemeUuid\": \"\",\n    \"DestinationThemeUuid\": null,\n    \"Status\": \"\",\n    \"Comment\": \"\",\n    \"ModifiedDate\": \"\",\n    \"IsScheduledRequest\": true,\n    \"ScheduleDateTime\": \"\"\n}\n\n

Theme Migration (POST):
This API migrates a theme from a source BigCommerce store to a destination store. It transfers theme details such as the theme UUID, name, and other associated settings. You can also specify whether the migrated theme should be activated on the destination store.

Get Theme Migration Status (GET):
Retrieves the status of a theme migration in BigCommerce. It provides details about the theme's migration progress, source and destination theme IDs, and the current status, such as whether the migration is completed or still in progress.

Cancel Scheduled Theme Migration Request (POST):
Cancels a scheduled theme migration request. This requires the migration ID and destination store ID to cancel the process of migrating a theme between stores.

\n","_postman_id":"7439c52f-f195-4a6d-b4ad-8069ddfd9665","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}],"advancedConfig":[{"key":"scope","value":""}]},"isInherited":true,"source":{"_postman_id":"ff9b5483-6175-4820-8b01-decb508889f7","id":"ff9b5483-6175-4820-8b01-decb508889f7","name":"StagingPro API - Documentation","type":"collection"}}},{"name":"Page / Template Migration","item":[{"name":"Page / Template Migration","id":"9f44b29c-218f-4987-8477-c891e81fb167","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"body":{"mode":"raw","raw":"{\r\n \"SourceChannelId\": 1,\r\n \"MigrationId\": \"db748634-e7b9-4b19-bb8b-72d19862faca\",\r\n \"PageId\": 7,\r\n \"DestinationChannelId\": 1,\r\n \"IsDestinationProduction\": true,\r\n \"SourceStoreCredentials\": {\r\n \"StoreId\": \"yh8*****5qrv\",\r\n \"StoreUrl\": \"https://l*****************ting-sandbox.mybigcommerce.com\",\r\n \"StoreAccessToken\": \"3zh4f6eu*****w2nbtfv22si4i\",\r\n \"Subscription\": false,\r\n \"ChannelID\": 1\r\n },\r\n \"DestinationStoreCredentials\": {\r\n \"StoreId\": \"syn*****asxz\",\r\n \"StoreUrl\": \"https://light*****magined.com\",\r\n \"StoreAccessToken\": \"1ekqexd*****kdvwl3votahsg\",\r\n \"Subscription\": false,\r\n \"ChannelID\": 1\r\n },\r\n \"IsScheduledRequest\": false,\r\n \"ScheduleDateTime\": null,\r\n \"template_file\": null,\r\n \"IsGlobal\": true\r\n}"},"url":"https://api.stagingpro.com/v1/api/BigcFunction/BigcPageUpdate","description":"

Pages / Template Migration (POST)

This API endpoint is used to migrate pages from a source BigCommerce store to a destination store. It transfers page content, templates, and associated settings to the destination store, ensuring the same structure and design are maintained.

Request Body

SourceChannelId (Number): The ID of the source channel.
\n
MigrationId (String): The unique identifier for the migration.
\n
PageId (Number): The ID of the page to be migrated.
\n
DestinationChannelId (Number): The ID of the destination channel.
\n
IsDestinationProduction (Boolean): Indicates if the destination is a production environment.
\n
SourceStoreCredentials (Object):
\n
- StoreId (String): The ID of the source store.
  \n
- StoreUrl (String): The URL of the source store.
  \n
- StoreAccessToken (String): The access token for the source store.
  \n
- Subscription (Boolean): Indicates if the source store has a subscription.
  \n
- ChannelID (Number): The ID of the channel for the source store.
  \n
\n
DestinationStoreCredentials (Object):
\n
- StoreId (String): The ID of the destination store.
  \n
- StoreUrl (String): The URL of the destination store.
  \n
- StoreAccessToken (String): The access token for the destination store.
  \n
- Subscription (Boolean): Indicates if the destination store has a subscription.
  \n
- ChannelID (Number): The ID of the channel for the destination store.
  \n
\n
IsScheduledRequest (Boolean): Indicates if the request is scheduled.
\n
ScheduleDateTime (String): The date and time of the scheduled request.
\n
template_file (null): The template file for the migration.
\n
IsGlobal (Boolean): Indicates if the migration is global.
\n

Response

{\n  \"Status\": \"\",\n  \"StatusComment\": \"\"\n}\n\n

Get Page / Template Migration Status (GET)

Retrieves the current status of a pages update migration in BigCommerce. It returns details about the source and destination page IDs and the progress of the migration (e.g., completed, in progress, or failed).

Request

URL: https://api.stagingpro.com/v1/api/BigcFunction/GetBigcPageUpdateStatus
\n
Method: GET
\n
Query Parameters:
\n
- destinationStoreId (string)
  \n
- migrationId (string)
  \n
\n

Response

The response for this request is a JSON object with the following schema:

{\n  \"MigrationId\": \"string\",\n  \"SourceStoreId\": \"string\",\n  \"DestinationStoreId\": \"string\",\n  \"SourceProductId\": 0,\n  \"DestinationProductId\": 0,\n  \"Status\": \"string\",\n  \"Comment\": \"string or null\",\n  \"ModifiedDate\": \"string\",\n  \"IsScheduledRequest\": true,\n  \"ScheduleDateTime\": \"string\"\n}\n\n

Cancel Scheduled Pages / Template Request (POST)

Cancels a scheduled pages update request for BigCommerce. The request requires the migration ID and destination store ID to cancel the scheduled migration of page data.

Request Body

Raw (application/json)
\n
- MigrationId (string): The ID of the migration.
  \n
- DestinationStoreId (string): The ID of the destination store.
  \n
\n

Response

The response for this request can be documented as a JSON schema:

{\n  \"type\": \"object\",\n  \"properties\": {\n    \"MigrationId\": {\"type\": \"string\"},\n    \"SourceStoreId\": {\"type\": \"string\"},\n    \"DestinationStoreId\": {\"type\": \"string\"},\n    \"SourceProductId\": {\"type\": \"integer\"},\n    \"DestinationProductId\": {\"type\": [\"integer\", \"null\"]},\n    \"Status\": {\"type\": \"string\"},\n    \"Comment\": {\"type\": \"string\"},\n    \"ModifiedDate\": {\"type\": \"string\"},\n    \"IsScheduledRequest\": {\"type\": \"boolean\"},\n    \"ScheduleDateTime\": {\"type\": \"string\"}\n  }\n}\n\n

Pages / Template Migration (POST):
This API migrates pages from a source BigCommerce store to a destination store. It transfers page content, templates, and associated settings to the destination store, ensuring the same structure and design are maintained.

Get Pages / Template Status (GET):
Retrieves the current status of a pages update migration in BigCommerce. It returns details about the source and destination page IDs and the progress of the migration (e.g., completed, in progress, or failed).

Cancel Scheduled Pages / Template Request (POST):
Cancels a scheduled pages update request for BigCommerce. The request requires the migration ID and destination store ID to cancel the scheduled migration of page data.

\n","_postman_id":"40b68a67-7792-4f11-a347-4ac90159c214","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}],"advancedConfig":[{"key":"scope","value":""}]},"isInherited":true,"source":{"_postman_id":"ff9b5483-6175-4820-8b01-decb508889f7","id":"ff9b5483-6175-4820-8b01-decb508889f7","name":"StagingPro API - Documentation","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}],"advancedConfig":[{"key":"scope","value":""}]}}}

Login API

Request

Response

Request Body

Response Body

JSON Schema

Get Store Data Summary

Request

Response

GetMigrateStoreDataProgressStatus

Request

Response

Get Data Migration Entity Status

Request

Response

Response Example

Migrate Store Data

Request Body

Response

Get Entity Errors

Response

Cancel Data Migration Request

Request Body

Response

JSON Schema

Get Migration History Report

Get Scheduled Migration Data Requests

Request

Query Parameters

Example

Response

Example Response

Get In-Progress Content Migration Request

Product Migration

Request Body

Response

Get Product Migration Status

Request

Response

Cancel Scheduled Product Migration Request

Promotion Migration

Request Body

Response

Get Promotion Migration Status

Request

Response

Cancel Scheduled Promotion Migration Request

Request Body

Response

Get Category Migration Status

Request

Response

Category Migration

Request Body

Response

Theme Migration

Request Body

Response

JSON Schema

Get Theme Migration Status

Request

Response

Cancel Scheduled Migration Theme Request

Request Body

Response

Pages / Template Migration (POST)

Request Body

Response

Get Page / Template Migration Status (GET)

Request

Response

Cancel Scheduled Pages / Template Request (POST)

Request Body

Response