PATCH v1/admin/company/{id}/ShoppingCarts/Items/{cartSequenceId}/SubscriptionGeneralProduct

Updates the properties of a single subscription general product item in the cart. If the item specified is not a subscription general product this call will throw an error.

Request Information

URI Parameters

Name	Description	Type	Additional information
id		integer	Required
cartSequenceId		integer	Required

Body Parameters

adminUpdateSingleSubscriptionGeneralProductItemInput

Name	Description	Type	Additional information
autoRenew		boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "autoRenew": true
}

text/html

Sample:

{"autoRenew":true}

application/xml, text/xml

Sample:

<v1_Admin_adminCarts_adminShoppingCartEndpointController.adminUpdateSingleSubscriptionGeneralProductItemInput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aptify.Services.Generated.v1_Admin_adminCarts_adminShoppingCartEndpoint">
  <autoRenew>true</autoRenew>
</v1_Admin_adminCarts_adminShoppingCartEndpointController.adminUpdateSingleSubscriptionGeneralProductItemInput>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'adminUpdateSingleSubscriptionGeneralProductItemInput'.

Response Information

Resource Description

Collection of adminUpdateSingleSubscriptionGeneralProductItemOutput

Name	Description	Type	Additional information
id	The ID for this item in the cart.	integer	None.
parentproductId	The ParentID of the product for this item in the cart.	integer	None.
parentId	If this item is part of a kit or a group, this is the parent item it belongs to.	integer	None.
productId	The ID of the product for this item in the cart.	integer	None.
isSubscription	Indicates if the product is a subscription product.	boolean	None.
quantity	Quantity will be only have a non-zero fractional part for subscription items. This depends on how the subscription product is processed. In most circumstances the fractional part will be zero.	decimal number	None.
price	The unit price for this line item in the cart.	decimal number	None.
discount	The percentage discount that should be taken off the order line price for each item.	decimal number	None.
productName	The name of the product.	string	None.
webName	The web name of the product.	string	None.
description	The product description.	string	None.
productType	The type of product this is.	string	None.
additionalDetails	The URL to retrieve or update additional details about this product in the cart.	URI	None.
totalDiscount	The total discount applied for this product in the cart.	decimal number	None.
totalFinalPrice	The final price user pays for this product in the cart.	decimal number	None.
autoRenew		boolean	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "id": 1,
    "parentproductId": 2,
    "parentId": 3,
    "productId": 4,
    "isSubscription": true,
    "quantity": 6.0,
    "price": 7.0,
    "discount": 8.0,
    "productName": "sample string 9",
    "webName": "sample string 10",
    "description": "sample string 11",
    "productType": "sample string 12",
    "additionalDetails": "http://webapihelppage13.com",
    "totalDiscount": 14.0,
    "totalFinalPrice": 15.0,
    "autoRenew": true
  },
  {
    "id": 1,
    "parentproductId": 2,
    "parentId": 3,
    "productId": 4,
    "isSubscription": true,
    "quantity": 6.0,
    "price": 7.0,
    "discount": 8.0,
    "productName": "sample string 9",
    "webName": "sample string 10",
    "description": "sample string 11",
    "productType": "sample string 12",
    "additionalDetails": "http://webapihelppage13.com",
    "totalDiscount": 14.0,
    "totalFinalPrice": 15.0,
    "autoRenew": true
  }
]

text/html

Sample:

[{"id":1,"parentproductId":2,"parentId":3,"productId":4,"isSubscription":true,"quantity":6.0,"price":7.0,"discount":8.0,"productName":"sample string 9","webName":"sample string 10","description":"sample string 11","productType":"sample string 12","additionalDetails":"http://webapihelppage13.com","totalDiscount":14.0,"totalFinalPrice":15.0,"autoRenew":true},{"id":1,"parentproductId":2,"parentId":3,"productId":4,"isSubscription":true,"quantity":6.0,"price":7.0,"discount":8.0,"productName":"sample string 9","webName":"sample string 10","description":"sample string 11","productType":"sample string 12","additionalDetails":"http://webapihelppage13.com","totalDiscount":14.0,"totalFinalPrice":15.0,"autoRenew":true}]

application/xml, text/xml

Sample:

<ArrayOfv1_Admin_adminCarts_adminShoppingCartEndpointController.adminUpdateSingleSubscriptionGeneralProductItemOutput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aptify.Services.Generated.v1_Admin_adminCarts_adminShoppingCartEndpoint">
  <v1_Admin_adminCarts_adminShoppingCartEndpointController.adminUpdateSingleSubscriptionGeneralProductItemOutput>
    <additionalDetails>http://webapihelppage13.com/</additionalDetails>
    <autoRenew>true</autoRenew>
    <description>sample string 11</description>
    <discount>8</discount>
    <id>1</id>
    <isSubscription>true</isSubscription>
    <parentId>3</parentId>
    <parentproductId>2</parentproductId>
    <price>7</price>
    <productId>4</productId>
    <productName>sample string 9</productName>
    <productType>sample string 12</productType>
    <quantity>6</quantity>
    <totalDiscount>14</totalDiscount>
    <totalFinalPrice>15</totalFinalPrice>
    <webName>sample string 10</webName>
  </v1_Admin_adminCarts_adminShoppingCartEndpointController.adminUpdateSingleSubscriptionGeneralProductItemOutput>
  <v1_Admin_adminCarts_adminShoppingCartEndpointController.adminUpdateSingleSubscriptionGeneralProductItemOutput>
    <additionalDetails>http://webapihelppage13.com/</additionalDetails>
    <autoRenew>true</autoRenew>
    <description>sample string 11</description>
    <discount>8</discount>
    <id>1</id>
    <isSubscription>true</isSubscription>
    <parentId>3</parentId>
    <parentproductId>2</parentproductId>
    <price>7</price>
    <productId>4</productId>
    <productName>sample string 9</productName>
    <productType>sample string 12</productType>
    <quantity>6</quantity>
    <totalDiscount>14</totalDiscount>
    <totalFinalPrice>15</totalFinalPrice>
    <webName>sample string 10</webName>
  </v1_Admin_adminCarts_adminShoppingCartEndpointController.adminUpdateSingleSubscriptionGeneralProductItemOutput>
</ArrayOfv1_Admin_adminCarts_adminShoppingCartEndpointController.adminUpdateSingleSubscriptionGeneralProductItemOutput>