Run a store clone batch

Creates one store for each row with status VALID. Rows with errors, ALREADY_EXISTS or REPEATED are left out. Every row goes through the same flow as a single store clone (signUp, contract, groupMembership, loginLink, configuration, managerAccess), with sourceRetailerId of the batch as the source and the session of the caller.

copyItems and mode follow the single store clone (StoreCloneRequest), but count for the whole batch: every row copies the same items from the source of the batch. Both are optional here: without them the run copies the copyItems saved by the upload (none for a batch uploaded before it existed). When sent, they replace the choice of the upload. When only mode is sent, WITH_CONFIGURATION means every item and SHELL_ONLY means none; when both are sent they must agree, otherwise 400.

The creation runs in the background: the answer comes right away with the batch in EXECUTING and progress at zero. Read GET /retailers/clones/batches/{batchId} until status is COMPLETED. progress.created and progress.failed grow as the rows finish, and created + failed reaches total when the batch completes. A row counts as failed only when no store exists for it. When the store was created and a later step fails for good, or still fails after the retries (for example the copy of a configuration), the row counts as created and also in progress.withIssues. The same goes for a store whose configuration step was refused for some keys: it completes, and the row comes with code CONFIGURATION_ITEMS_NOT_ALLOWED and the refused keys in message. Every row that ended with a problem is listed in runIssues with its line, outcome, retailerId (when the store exists), step, code and message. The other rows go on.

createManagerUsers decides what happens to a managerEmail with no user (rowSummaries[].managerUserExists: false): true creates the user and sends the invite, false leaves the store without a manager. An email that already has a user is linked either way.

A batch of another group answers 404. A batch that is not VALID (already EXECUTING or COMPLETED, or INVALID), a batch without any valid row, and a batch edited while the run started answer 409.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params
boolean
required
copyItems
array of strings, unique

Items every store of the batch copies from the source. Missing (with no mode) keeps the choice of the upload; an empty list creates the stores from scratch.

string
enum

Kept for parity with the single clone; prefer copyItems.

Allowed:
Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json