Cdn API - CPG Source

IapPlanUpsertRequest

Cdn.Api

The following routes are available for this service:
POST	/IapPlanUpsertRequest

**IapPlanUpsertRequest** Parameters:
Name	Parameter	Data Type	Required
PlanId	body	string	No
Name	body	string	No
Tagline	body	string	No
Level	body	int	No
Badge	body	string	No
Benefits	body	List<string>	No
EntitlementLookupKey	body	string	No
ProductCategoryId	body	long	No
ParentProductCategoryId	body	long	No
MonthlySku	body	string	No
AnnualSku	body	string	No
MonthlyLocalProductId	body	long	No
AnnualLocalProductId	body	long	No
IncludesPrint	body	bool	No
RequiresShippingAddress	body	bool	No
VisibleInApp	body	bool	No
SortOrder	body	int	No
WholesaleCatalogs	body	string	No
Reason	body	string	No

**IapPlanCatalogResponse** Parameters:
Name	Parameter	Data Type	Required
Plans	form	List<IapPlanDefinition>	No
Source	form	string	No
OfferingId	form	string	No
Status	form	string	No
Steps	form	List<IapPlanStepResult>	No

**BaseResponse** Parameters:
Name	Parameter	Data Type	Required
Total	form	int	No
OpCode	form	int	No
ErrorText	form	string	No
RequestTime	form	string	No
ResponseTime	form	string	No
TotalExecutionTime	form	string	No
CachedResponse	form	bool	No

**IapPlanDefinition** Parameters:
Name	Parameter	Data Type	Required
PlanId	form	string	No
Name	form	string	No
Tagline	form	string	No
Level	form	int	No
Badge	form	string	No
Benefits	form	List<string>	No
EntitlementLookupKey	form	string	No
ProductCategoryId	form	long	No
ParentProductCategoryId	form	long	No
MonthlySku	form	string	No
AnnualSku	form	string	No
MonthlyLocalProductId	form	long	No
AnnualLocalProductId	form	long	No
IncludesPrint	form	bool	No
RequiresShippingAddress	form	bool	No
VisibleInApp	form	bool	No
SortOrder	form	int	No
WholesaleCatalogs	form	string	No

**IapPlanStepResult** Parameters:
Name	Parameter	Data Type	Required
Step	form	string	No
Target	form	string	No
Outcome	form	string	No
Detail	form	string	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /IapPlanUpsertRequest HTTP/1.1 
Host: cdnapidev.greysheet.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<IapPlanUpsertRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cdn.Api.RequestObjects">
  <AnnualLocalProductId>0</AnnualLocalProductId>
  <AnnualSku>String</AnnualSku>
  <Badge>String</Badge>
  <Benefits xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Benefits>
  <EntitlementLookupKey>String</EntitlementLookupKey>
  <IncludesPrint>false</IncludesPrint>
  <Level>0</Level>
  <MonthlyLocalProductId>0</MonthlyLocalProductId>
  <MonthlySku>String</MonthlySku>
  <Name>String</Name>
  <ParentProductCategoryId>0</ParentProductCategoryId>
  <PlanId>String</PlanId>
  <ProductCategoryId>0</ProductCategoryId>
  <Reason>String</Reason>
  <RequiresShippingAddress>false</RequiresShippingAddress>
  <SortOrder>0</SortOrder>
  <Tagline>String</Tagline>
  <VisibleInApp>false</VisibleInApp>
  <WholesaleCatalogs>String</WholesaleCatalogs>
</IapPlanUpsertRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<IapPlanCatalogResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cdn.Api.ResponseObjects">
  <CachedResponse>false</CachedResponse>
  <ErrorText>String</ErrorText>
  <OpCode>0</OpCode>
  <RequestTime>String</RequestTime>
  <ResponseTime>String</ResponseTime>
  <Total>0</Total>
  <TotalExecutionTime>String</TotalExecutionTime>
  <OfferingId>String</OfferingId>
  <Plans xmlns:d2p1="http://schemas.datacontract.org/2004/07/Cdn.Api.Iap">
    <d2p1:IapPlanDefinition>
      <d2p1:AnnualLocalProductId>0</d2p1:AnnualLocalProductId>
      <d2p1:AnnualSku>String</d2p1:AnnualSku>
      <d2p1:Badge>String</d2p1:Badge>
      <d2p1:Benefits xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:Benefits>
      <d2p1:EntitlementLookupKey>String</d2p1:EntitlementLookupKey>
      <d2p1:IncludesPrint>false</d2p1:IncludesPrint>
      <d2p1:Level>0</d2p1:Level>
      <d2p1:MonthlyLocalProductId>0</d2p1:MonthlyLocalProductId>
      <d2p1:MonthlySku>String</d2p1:MonthlySku>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:ParentProductCategoryId>0</d2p1:ParentProductCategoryId>
      <d2p1:PlanId>String</d2p1:PlanId>
      <d2p1:ProductCategoryId>0</d2p1:ProductCategoryId>
      <d2p1:RequiresShippingAddress>false</d2p1:RequiresShippingAddress>
      <d2p1:SortOrder>0</d2p1:SortOrder>
      <d2p1:Tagline>String</d2p1:Tagline>
      <d2p1:VisibleInApp>false</d2p1:VisibleInApp>
      <d2p1:WholesaleCatalogs>String</d2p1:WholesaleCatalogs>
    </d2p1:IapPlanDefinition>
  </Plans>
  <Source>String</Source>
  <Status>String</Status>
  <Steps>
    <IapPlanStepResult>
      <Detail>String</Detail>
      <Outcome>String</Outcome>
      <Step>String</Step>
      <Target>String</Target>
    </IapPlanStepResult>
  </Steps>
</IapPlanCatalogResponse>