Compare and deploy a template for product catalog to a tenant

Compare and deploy a template for product catalog to a 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.

comments
string

Content of the email to be sent.

template
required
string <binary>

Template file.

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 rate plans needs to be migrated.

compareField
required
string

Specifies the compare field to be using during migration.

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