Provisioning Items

Special Notes:

Int VendorAccountID: (mandatory) vendor account ID.
Int ProvisioningItemsCounter: a number of provisioning items in order. One order item is created for each service plan or additional resource ordered.
Str ProvisioningItem – provisioning item is submitted as a string of one of the following formats:
- Service:
  Format: <PlanID>=<PlanPeriodID>=<ProvisioningItemID>=<ParentItemID>
  Example: 20=36=0=-1
  Where:
  - Int <PlanID> (mandatory) is an ID of a service plan. The "Available for Sale" option is also checked together with this parameter.
  - Int <PlanPeriodID> (mandatory) is an ID of a subscription period of the plan. The "Active" option and ID of the service plan are also checked together with this parameter.
  - Int <ProvisioningItemID> (mandatory) is an arbitrary positive unique ID of the provisioning item inside the order;
  - Int <ParentItemID> is an ID of a parent provisioning item in the current order. Must be "-1" for a service.
- Domain Registration:
  Format: <PlanID>=<PlanPeriodID>=<ProvisioningItemID>=<ParentItemID>
  Example: 3=5=0=-1
  Where:
  - Int <PlanID> (mandatory) is an ID of a service plan. The "Available for Sale" option is also checked together with this parameter.
  - Int <PlanPeriodID> (mandatory) is an ID of a subscription period of the plan. The "Active" option and ID of the service plan are also checked together with this parameter.
  - Int<ProvisioningItemID> (mandatory) is an arbitrary positive unique ID of the provisioning item inside the order;
  - Int <ParentItemID> is an ID of a parent provisioning item in the current order. Must be "-1" if a domain is purchased only.
- Service + Domain Registration:
  Format:
  <PlanID>=<PlanPeriodID>=<ProvisioningItemID>=<ParentItemID>: ordering a service; the first provisioning item.
  <PlanID>=<PlanPeriodID>=<ProvisioningItemID>=<ParentItemID>: ordering a domain; the second provisioning item.
  Example:
  20=36=0=-1: ProvisioningItemID=0 (a service and parent subscription for a domain);
  6=4=1=0: ProvisioningItemID=1 (a domain to another service).
  Where:
  - Int <PlanID> (mandatory) is an ID of a service plan. The "Available for Sale" option is also checked together with this parameter.
  - Int <PlanPeriodID> (mandatory) is an ID of a subscription period of the plan. The "Active" option and ID of the service plan are also checked together with this parameter.
  - Int<ProvisioningItemID> (mandatory) is an arbitrary positive unique ID of the provisioning item inside the order;
  - Int <ParentItemID> is an ID of a parent provisioning item in the current order. Must be "-1" for a service. As a domain is purchased to the previously ordered service, the parameter value must be a number of the service provisioning item.
- Domain to existing subscription:
  Format: <PlanID>=<PlanPeriodID>=<ProvisioningItemID>=s<SubscriptionID>
  Example: 20=36=0=s102356
  Where:
  - Int<PlanID> (mandatory) is an ID of a service plan. The "Available for Sale" option is also checked together with this parameter.
  - Int<PlanPeriodID> (mandatory) is an ID of a subscription period of the plan. The "Active" option and ID of the service plan are also checked together with this parameter.
  - Int<ProvisioningItemID> (mandatory) is an arbitrary positive unique ID of the provisioning item inside the order;
  - Ints<SubscriptionID> is an ID of an existing service subscription a domain is purchased to. The ID of a parent subscription must begin from the "s" symbol; the parent subscription ID and its owner are validated if the ID is specified.
- Additional Resource:
  Format:
  <PlanID>=<PlanPeriodID>=<ProvisioningItemID>=<ParentItemID>: ordering a service; the first provisioning item.
  <ResourceRateID>=<PlanPeriodID>=<ProvisioningItemID>=<ParentItemID>=<Amount>=RESOURCE: ordering an additional amount of a resource; the parent item is mandatory.
  Where:
  - Int<ResourceRateID> (mandatory) is an ID of a resource rate for the ordered resource.
  - Int<PlanPeriodID> (mandatory) is an ID of a subscription period of the plan.
  - Int<ProvisioningItemID> (mandatory) is an arbitrary positive unique ID of the provisioning item inside the order;
  - Int <ParentItemID> (mandatory) is an ID of a parent provisioning item in the current order.
  - Double<Amount> (mandatory) is an amount of an ordered resource.
  - RESOURCE: (mandatory) the word must be written in upper case.

Note: The Str ProvisioningItem parameter must be repeated in case of specifying multiple provisioning items in one API call. Refer to the signature of the PlaceOrderAndAuthorize_API method for details.

Service Example:

Copy

<!-- VendorAccountID -->
<value>
    <i4>1</i4>
</value>
<!-- ProvisioningItemsCounter -->
<value>
    <i4>1</i4>
</value>
<!-- ProvisioningItem #0. PlanID=20, PlanPeriodID=36,
   ProvisioningItemID=0, ParentItemID is not defined -->
<value>20=36=0=-1</value>

Domain Registration Example:

Copy

<!-- VendorAccountID -->
<value>
    <i4>1</i4>
</value>
<!-- ProvisioningItemsCounter -->
<value>
    <i4>1</i4>
</value>
<!-- ProvisioningItem #0. PlanID=5, PlanPeriodID=5,
   ProvisioningItemID=0, ParentItemID= not required -->
<value>5=5=0=1</value>

Service + Domain Registration Example:

Copy

<!-- VendorAccountID -->
<value>
    <i4>1</i4>
</value>
<!-- ProvisioningItemsCounter -->
<value>
    <i4>2</i4>
</value>
<!-- ProvisioningItem #0. PlanID=20, PlanPeriodID=36,
   ProvisioningItemID=0, ParentItemID is not defined -->
<value>20=36=0=-1</value>
<!-- ProvisioningItem #1. PlanID=5, PlanPeriodID=5,
   ProvisioningItemID=1, ParentItemID=0 -->
<value>5=5=1=0</value>

Service + Resource Example:

Copy

<!-- VendorAccountID -->
<value>
    <i4>1</i4>
</value>
<!-- ProvisioningItemsCounter -->
<value>
    <i4>2</i4>
</value>
<!-- ProvisioningItem #0. PlanID=20, PlanPeriodID=36,
   ProvisioningItemID=0, ParentItemID is not defined -->
<value>20=36=0=-1</value>
<!-- ProvisioningItem #1. ResourceRateID=169, PlanPeriodID=36,
   ProvisioningItemID=1, ParentItemID=0, Amount=5 -->
<value>169=36=1=0=5=RESOURCE</value>

Domain Registration to Existing Service Subscription Example:

Copy

<!-- VendorAccountID -->
<value>
    <i4>1</i4>
</value>
<!-- ProvisioningItemsCounter -->
<value>
    <i4>1</i4>
</value>
<!-- ProvisioningItem #0. PlanID=5, PlanPeriodID=5,
   ProvisioningItemID=0, ParentItemID=s102356 -->
<value>5=5=0=s102356</value>