Compare and deploy the product catalog of a tenant to a target tenant

Compare and deploy the product catalog of a tenant to a target tenant.

Request
header Parameters
Zuora-Entity-Ids
string

An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.

Request Body schema: multipart/form-data
required
name
required
string

Deployment's name.

description
required
string

Deployment's description.

sendEmail
required
boolean

Specifies if an email should be sent.

emails
string

If sendEmail parameter is set to true, comma separated values of emails can be specified. Example email1@test.com,email2@test.com.

comments
string

Content of the email to be sent.

inActiveProducts
required
boolean

Specifies if inactive products needs to be migrated.

activeProducts
required
boolean

Specifies if active products needs to be migrated.

activeRatePlans
required
boolean

Specifies if active rate plans needs to be migrated.

inActiveRatePlans
required
boolean

Specifies if inactive active rate plans needs to be migrated.

compareField
required
string

Specifies the compare field to be using during migration.

Enum: "name" "sku"
sourceTenantId
required
string

Specifies the source tenant id.

Responses
200
400

Validation of dependent module error

post/deployment-manager/deployments/tenant/product_catalog
Request samples
Response samples
application/json
{
  • "id": "8039d54b-da6f-4d80-88d5-06220c42861f",
  • "status": "DEPLOYING"
}