Request data format | application/json |
---|---|
Request related java object | com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderItemResource com.intershop.sellside.rest.common.capi.resourceobject.recurringorder.UpdateRecurringOrderRO |
Request data example | Activate a recurring order: { "active": true } Deactivate a recurring order: { "active": false } |
Response data format | application/json |
Response related java object | com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderItemResource com.intershop.sellside.rest.common.capi.resourceobject.recurringorder.RecurringOrderRO |
Response data example | { "type": "RecurringOrder", "id": "5WIKDgA.cJkAAAFXygAkSPu1", "number": "0000006", "active": true, "expired": false, "multipleShipmentsSupported": false, "interval": "P1D", "creationDate": 1477396810000, "startDate": 1477404600000, "endDate": 1496314800000, "buyer": { "type": "RecurringOrderBuyer", "title": "", "firstName": "Patricia", "lastName": "Miller", "businessPartnerNo": "Patricia", "department": "", "login": "patricia@test.intershop.de" }, "modifiedDate": 1477396810000, "itemCount": 1, "orderCount": 0, "invoiceToAddress": { "type": "Address", "urn": "urn:address:customer:OOAKDgA..9cAAAFX8x09bPr8:cDQKDgA.9WIAAAFXoCM9bPr8", "id": "cDQKDgA.9WIAAAFXoCM9bPr8", "addressName": "customeraddr-ABCDEFGPRMuMCscyXgSRVU", "title": "Ms.", "firstName": "Patricia", "lastName": "Miller", "addressLine1": "Potsdamer Str. 20", "postalCode": "14483", "phoneHome": "049364112677", "country": "Germany", "countryCode": "DE", "city": "Berlin", "usage": [ true, true ], "street": "Potsdamer Str. 20", "shipToAddress": true, "invoiceToAddress": true, "shipFromAddress": false, "serviceToAddress": false, "installToAddress": false }, "commonShipToAddress": { "type": "Address", "urn": "urn:address:customer:OOAKDgA..9cAAAFX8x09bPr8:gpoKDgA.t7oAAAFXnyM9bPr8", "id": "gpoKDgA.t7oAAAFXnyM9bPr8", "addressName": "customeraddr-YXEwLKSprCWPRMuMCscyXgSRVU", "title": "Ms.", "firstName": "Patricia", "lastName": "Miller", "addressLine1": "Berliner Str. 20", "postalCode": "14482", "phoneHome": "049364112677", "country": "Germany", "countryCode": "DE", "city": "Potsdam", "usage": [ true, true ], "street": "Berliner Str. 20", "shipToAddress": true, "invoiceToAddress": true, "shipFromAddress": false, "serviceToAddress": false, "installToAddress": false }, "commonShippingMethod": { "name": "Standard Ground", "type": "ShippingMethod", "id": "STD_GROUND", "shippingTimeMin": 3, "shippingTimeMax": 7 }, "payments": [ { "name": "ISH_INVOICE", "type": "Payment", "id": "ISH_INVOICE", "parameters": [] } ], "shippingBuckets": [ { "type": "RecurringOrderShippingBucket", "shippingMethod": { "name": "Standard Ground", "type": "ShippingMethod", "id": "STD_GROUND", "shippingTimeMin": 3, "shippingTimeMax": 7 }, "lineItems": [ { "name": "A-DATA 16GB C008", "type": "RecurringOrderLineItem", "sku": "6946439", "quantity": { "type": "Quantity", "value": 1, "unit": "" }, "totals": { "type": "RecurringOrderLineItemTotals", "totalNet": { "type": "Money", "value": 21.95, "currencyMnemonic": "USD" }, "shippingTotalNet": { "type": "Money", "value": 3.02, "currencyMnemonic": "USD" }, "totalGross": { "type": "Money", "value": 26.12, "currencyMnemonic": "USD" }, "shippingTotalGross": { "type": "Money", "value": 3.59, "currencyMnemonic": "USD" }, "priceType": "gross", "salesTaxTotal": { "type": "Money", "value": 4.17, "currencyMnemonic": "USD" }, "shippingTaxTotal": { "type": "Money", "value": 0.57, "currencyMnemonic": "USD" } }, "salesTaxes": [ { "name": "name", "type": "AppliedTax", "rate": 0.19, "amount": { "type": "Money", "value": 4.17, "currencyMnemonic": "USD" } } ], "shippingTaxes": [ { "name": "name", "type": "AppliedTax", "rate": 0.19, "amount": { "type": "Money", "value": 0.57, "currencyMnemonic": "USD" } } ], "product": { "type": "Link", "uri": "inSPIRED-inTRONICS-Site/-/products/6946439", "title": "6946439", "description": "A-DATA 16GB C008" }, "priceNet": { "type": "Money", "value": 21.95, "currencyMnemonic": "USD" }, "singleBasePriceNet": { "type": "Money", "value": 21.95, "currencyMnemonic": "USD" }, "priceGross": { "type": "Money", "value": 26.12, "currencyMnemonic": "USD" }, "singleBasePriceGross": { "type": "Money", "value": 26.12, "currencyMnemonic": "USD" }, "priceType": "gross", "id": "YeQKDgA.OLwAAAFXxuQkSPu1", "position": 1, "isHiddenGift": false, "isFreeGift": false, "inStock": true, "availability": true, "bundleProduct": false, "variationProduct": false } ] } ], "totals": { "type": "RecurringOrderTotals", "itemTotalNet": { "type": "Money", "value": 21.95, "currencyMnemonic": "USD" }, "shippingTotalNet": { "type": "Money", "value": 3.02, "currencyMnemonic": "USD" }, "itemShippingRebatesTotalNet": { "type": "Money", "value": 0, "currencyMnemonic": "USD" }, "bucketShippingRebatesTotalNet": { "type": "Money", "value": 0, "currencyMnemonic": "USD" }, "rebatesTotalNet": { "type": "Money", "value": 0, "currencyMnemonic": "USD" }, "shippingRebatesTotalNet": { "type": "Money", "value": 0, "currencyMnemonic": "USD" }, "paymentCostsTotalNet": { "type": "Money", "value": 0, "currencyMnemonic": "USD" }, "totalNet": { "type": "Money", "value": 24.97, "currencyMnemonic": "USD" }, "itemTotalGross": { "type": "Money", "value": 26.12, "currencyMnemonic": "USD" }, "shippingTotalGross": { "type": "Money", "value": 3.59, "currencyMnemonic": "USD" }, "itemShippingRebatesTotalGross": { "type": "Money", "value": 0, "currencyMnemonic": "USD" }, "bucketShippingRebatesTotalGross": { "type": "Money", "value": 0, "currencyMnemonic": "USD" }, "rebatesTotalGross": { "type": "Money", "value": 0, "currencyMnemonic": "USD" }, "shippingRebatesTotalGross": { "type": "Money", "value": 0, "currencyMnemonic": "USD" }, "paymentCostsTotalGross": { "type": "Money", "value": 0, "currencyMnemonic": "USD" }, "totalGross": { "type": "Money", "value": 29.71, "currencyMnemonic": "USD" }, "taxTotal": { "type": "Money", "value": 4.74, "currencyMnemonic": "USD" }, "dutiesAndSurchargesTotal": { "type": "Money", "value": 0, "currencyMnemonic": "USD" }, "priceType": "gross" } } |
Request data format | text/xml |
---|---|
Request related java object | com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderItemResource com.intershop.sellside.rest.common.capi.resourceobject.recurringorder.UpdateRecurringOrderRO |
Request data example | Activate a recurring order: <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <RecurringOrder> <active>true</active> </RecurringOrder> Deactivate a recurring order: <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <RecurringOrder> <active>false</active> </RecurringOrder> |
Response data format | text/xml |
Response related java object | com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderItemResource com.intershop.sellside.rest.common.capi.resourceobject.recurringorder.RecurringOrderRO |
Response data example | <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <RecurringOrder type="RecurringOrder"> <interval>P1D</interval> <payments> <Payment name="ISH_INVOICE" type="Payment"> <id>ISH_INVOICE</id> <parameters/> </Payment> </payments> <shippingBuckets> <RecurringOrderShippingBucket type="RecurringOrderShippingBucket"> <lineItems> <RecurringOrderLineItem name="A-DATA 16GB C008" type="RecurringOrderLineItem"> <availability>true</availability> <bundleProduct>false</bundleProduct> <id>YeQKDgA.OLwAAAFXxuQkSPu1</id> <inStock>true</inStock> <isFreeGift>false</isFreeGift> <isHiddenGift>false</isHiddenGift> <position>1</position> <priceGross type="Money"> <currencyMnemonic>USD</currencyMnemonic> <value>26.12</value> </priceGross> <priceNet type="Money"> <currencyMnemonic>USD</currencyMnemonic> <value>21.95</value> </priceNet> <priceType>gross</priceType> <product type="Link"> <description>A-DATA 16GB C008</description> <title>6946439</title> <uri>inSPIRED-inTRONICS-Site/-/products/6946439</uri> </product> <quantity type="Quantity"> <unit></unit> <value>1</value> </quantity> <salesTaxes> <AppliedTax name="name" type="AppliedTax"> <amount type="Money"> <currencyMnemonic>USD</currencyMnemonic> <value>4.17</value> </amount> <rate>0.19</rate> </AppliedTax> </salesTaxes> <shippingTaxes> <AppliedTax name="name" type="AppliedTax"> <amount type="Money"> <currencyMnemonic>USD</currencyMnemonic> <value>0.57</value> </amount> <rate>0.19</rate> </AppliedTax> </shippingTaxes> <singleBasePriceGross type="Money"> <currencyMnemonic>USD</currencyMnemonic> <value>26.12</value> </singleBasePriceGross> <singleBasePriceNet type="Money"> <currencyMnemonic>USD</currencyMnemonic> <value>21.95</value> </singleBasePriceNet> <sku>6946439</sku> <totals type="RecurringOrderLineItemTotals"> <priceType>gross</priceType> <salesTaxTotal type="Money"> <currencyMnemonic>USD</currencyMnemonic> <value>4.17</value> </salesTaxTotal> <shippingTaxTotal type="Money"> <currencyMnemonic>USD</currencyMnemonic> <value>0.57</value> </shippingTaxTotal> <shippingTotalGross type="Money"> <currencyMnemonic>USD</currencyMnemonic> <value>3.59</value> </shippingTotalGross> <shippingTotalNet type="Money"> <currencyMnemonic>USD</currencyMnemonic> <value>3.02</value> </shippingTotalNet> <totalGross type="Money"> <currencyMnemonic>USD</currencyMnemonic> <value>26.12</value> </totalGross> <totalNet type="Money"> <currencyMnemonic>USD</currencyMnemonic> <value>21.95</value> </totalNet> </totals> <variationProduct>false</variationProduct> </RecurringOrderLineItem> </lineItems> <shippingMethod name="Standard Ground" type="ShippingMethod"> <id>STD_GROUND</id> <shippingTimeMax>7</shippingTimeMax> <shippingTimeMin>3</shippingTimeMin> </shippingMethod> </RecurringOrderShippingBucket> </shippingBuckets> <active>true</active> <buyer type="RecurringOrderBuyer"> <businessPartnerNo>Patricia</businessPartnerNo> <department></department> <firstName>Patricia</firstName> <lastName>Miller</lastName> <login>patricia@test.intershop.de</login> <title></title> </buyer> <commonShipToAddress type="Address"> <addressLine1>Berliner Str. 20</addressLine1> <addressName>customeraddr-YXEwLKSprCWPRMuMCscyXgSRVU</addressName> <city>Potsdam</city> <country>Germany</country> <countryCode>DE</countryCode> <firstName>Patricia</firstName> <id>gpoKDgA.t7oAAAFXnyM9bPr8</id> <installToAddress>false</installToAddress> <invoiceToAddress>true</invoiceToAddress> <lastName>Miller</lastName> <phoneHome>049364112677</phoneHome> <postalCode>14482</postalCode> <serviceToAddress>false</serviceToAddress> <shipFromAddress>false</shipFromAddress> <shipToAddress>true</shipToAddress> <street>Berliner Str. 20</street> <title>Ms.</title> <urn>urn:address:customer:OOAKDgA..9cAAAFX8x09bPr8:gpoKDgA.t7oAAAFXnyM9bPr8</urn> <usage/> </commonShipToAddress> <commonShippingMethod name="Standard Ground" type="ShippingMethod"> <id>STD_GROUND</id> <shippingTimeMax>7</shippingTimeMax> <shippingTimeMin>3</shippingTimeMin> </commonShippingMethod> <creationDate>2016-10-25T14:00:10+02:00</creationDate> <endDate>2017-06-01T13:00:00+02:00</endDate> <expired>false</expired> <id>5WIKDgA.cJkAAAFXygAkSPu1</id> <invoiceToAddress type="Address"> <addressLine1>Potsdamer Str. 20</addressLine1> <addressName>customeraddr-ABCDEFGPRMuMCscyXgSRVU</addressName> <city>Berlin</city> <country>Germany</country> <countryCode>DE</countryCode> <firstName>Patricia</firstName> <id>cDQKDgA.9WIAAAFXoCM9bPr8</id> <installToAddress>false</installToAddress> <invoiceToAddress>true</invoiceToAddress> <lastName>Miller</lastName> <phoneHome>049364112677</phoneHome> <postalCode>14483</postalCode> <serviceToAddress>false</serviceToAddress> <shipFromAddress>false</shipFromAddress> <shipToAddress>true</shipToAddress> <street>Potsdamer Str. 20</street> <title>Ms.</title> <urn>urn:address:customer:OOAKDgA..9cAAAFX8x09bPr8:cDQKDgA.9WIAAAFXoCM9bPr8</urn> <usage/> </invoiceToAddress> <itemCount>1</itemCount> <modifiedDate>2016-10-25T14:00:10+02:00</modifiedDate> <multipleShipmentsSupported>false</multipleShipmentsSupported> <number>0000006</number> <orderCount>0</orderCount> <startDate>2016-10-25T16:10:00+02:00</startDate> <totals type="RecurringOrderTotals"> <bucketShippingRebatesTotalGross type="Money"> <currencyMnemonic>USD</currencyMnemonic> <value>0.0</value> </bucketShippingRebatesTotalGross> <bucketShippingRebatesTotalNet type="Money"> <currencyMnemonic>USD</currencyMnemonic> <value>0.0</value> </bucketShippingRebatesTotalNet> <dutiesAndSurchargesTotal type="Money"> <currencyMnemonic>USD</currencyMnemonic> <value>0.0</value> </dutiesAndSurchargesTotal> <itemShippingRebatesTotalGross type="Money"> <currencyMnemonic>USD</currencyMnemonic> <value>0.0</value> </itemShippingRebatesTotalGross> <itemShippingRebatesTotalNet type="Money"> <currencyMnemonic>USD</currencyMnemonic> <value>0.0</value> </itemShippingRebatesTotalNet> <itemTotalGross type="Money"> <currencyMnemonic>USD</currencyMnemonic> <value>26.12</value> </itemTotalGross> <itemTotalNet type="Money"> <currencyMnemonic>USD</currencyMnemonic> <value>21.95</value> </itemTotalNet> <paymentCostsTotalGross type="Money"> <currencyMnemonic>USD</currencyMnemonic> <value>0.00</value> </paymentCostsTotalGross> <paymentCostsTotalNet type="Money"> <currencyMnemonic>USD</currencyMnemonic> <value>0.0</value> </paymentCostsTotalNet> <priceType>gross</priceType> <rebatesTotalGross type="Money"> <currencyMnemonic>USD</currencyMnemonic> <value>0.00</value> </rebatesTotalGross> <rebatesTotalNet type="Money"> <currencyMnemonic>USD</currencyMnemonic> <value>0.0</value> </rebatesTotalNet> <shippingRebatesTotalGross type="Money"> <currencyMnemonic>USD</currencyMnemonic> <value>0.0</value> </shippingRebatesTotalGross> <shippingRebatesTotalNet type="Money"> <currencyMnemonic>USD</currencyMnemonic> <value>0.0</value> </shippingRebatesTotalNet> <shippingTotalGross type="Money"> <currencyMnemonic>USD</currencyMnemonic> <value>3.59</value> </shippingTotalGross> <shippingTotalNet type="Money"> <currencyMnemonic>USD</currencyMnemonic> <value>3.02</value> </shippingTotalNet> <taxTotal type="Money"> <currencyMnemonic>USD</currencyMnemonic> <value>4.74</value> </taxTotal> <totalGross type="Money"> <currencyMnemonic>USD</currencyMnemonic> <value>29.71</value> </totalGross> <totalNet type="Money"> <currencyMnemonic>USD</currencyMnemonic> <value>24.97</value> </totalNet> </totals> </RecurringOrder> |
The information provided in the Knowledge Base may not be applicable to all systems and situations. Intershop Communications will not be liable to any party for any direct or indirect damages resulting from the use of the Customer Support section of the Intershop Corporate Web site, including, without limitation, any lost profits, business interruption, loss of programs or other data on your information handling system.