Skip to content

Commit cfeb964

Browse files
committed
Updated API from documentation release
1 parent 51103d1 commit cfeb964

44 files changed

Lines changed: 976 additions & 8 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

api-specs/history/api.raml

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -225,10 +225,12 @@ resourceTypes:
225225
'view_product_selections:{projectKey}',
226226
'view_quotes:{projectKey}',
227227
'view_quote_requests:{projectKey}',
228+
'view_shipping_methods:{projectKey}',
228229
'view_shopping_lists:{projectKey}',
229230
'view_shopping_lists:{projectKey}:{storeKey}',
230-
'view_states:{projectKey}',
231231
'view_staged_quotes:{projectKey}',
232+
'view_standalone_prices:{projectKey}',
233+
'view_states:{projectKey}',
232234
'view_stores:{projectKey}',
233235
'view_tax_categories:{projectKey}',
234236
'view_types:{projectKey}',
@@ -359,9 +361,11 @@ resourceTypes:
359361
- quote-requests
360362
- quotes
361363
- reviews
364+
- shipping-methods
362365
- shopping-lists
363-
- states
364366
- staged-quotes
367+
- standalone-prices
368+
- states
365369
- stores
366370
- tax-categories
367371
- types
@@ -392,9 +396,11 @@ resourceTypes:
392396
'view_product_selections:{projectKey}',
393397
'view_quotes:{projectKey}',
394398
'view_quote_requests:{projectKey}',
399+
'view_shipping_methods:{projectKey}',
395400
'view_shopping_lists:{projectKey}',
396-
'view_states:{projectKey}',
397401
'view_staged_quotes:{projectKey}',
402+
'view_standalone_prices:{projectKey}',
403+
'view_states:{projectKey}',
398404
'view_stores:{projectKey}',
399405
'view_tax_categories:{projectKey}',
400406
'view_types:{projectKey}',
@@ -515,9 +521,11 @@ resourceTypes:
515521
'view_product_selections:{projectKey}',
516522
'view_quotes:{projectKey}',
517523
'view_quote_requests:{projectKey}',
524+
'view_shipping_methods:{projectKey}',
518525
'view_shopping_lists:{projectKey}',
519-
'view_states:{projectKey}',
520526
'view_staged_quotes:{projectKey}',
527+
'view_standalone_prices:{projectKey}',
528+
'view_states:{projectKey}',
521529
'view_stores:{projectKey}',
522530
'view_tax_categories:{projectKey}',
523531
'view_types:{projectKey}',

api-specs/history/oauth2.raml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,8 @@ settings:
9292
- 'manage_quotes:{projectKey}'
9393
- 'view_quotes:{projectKey}:{storeKey}'
9494
- 'manage_quotes:{projectKey}:{storeKey}'
95+
- 'view_shipping_methods:{projectKey}'
96+
- 'manage_shipping_methods:{projectKey}'
9597
- 'view_shopping_lists:{projectKey}'
9698
- 'manage_shopping_lists:{projectKey}'
9799
- 'view_shopping_lists:{projectKey}:{storeKey}'
@@ -100,6 +102,8 @@ settings:
100102
- 'manage_staged_quotes:{projectKey}'
101103
- 'view_staged_quotes:{projectKey}:{storeKey}'
102104
- 'manage_staged_quotes:{projectKey}:{storeKey}'
105+
- 'view_standalone_prices:{projectKey}'
106+
- 'manage_standalone_prices:{projectKey}'
103107
- 'view_states:{projectKey}'
104108
- 'manage_states:{projectKey}'
105109
- 'view_stores:{projectKey}'

api-specs/history/types/ChangeHistoryResourceType.raml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,10 @@ enum:
2222
- 'quote-request'
2323
- 'quote'
2424
- 'review'
25+
- 'shipping-method'
2526
- 'shopping-list'
2627
- 'staged-quote'
28+
- 'standalone-price'
2729
- 'state'
2830
- 'store'
2931
- 'tax-category'
@@ -49,9 +51,11 @@ enum:
4951
quote-request: for [QuoteRequest](/projects/quote-requests#quoterequest)
5052
quote: for [Quote](/projects/quotes#quote)
5153
review: for [Review](/projects/reviews#review)
54+
shipping-method: for [ShippingMethod](/projects/shippingMethods#shippingmethod)
5255
shopping-list: for [ShoppingList](/projects/shoppingLists#shoppinglist)
53-
state: for [State](/projects/states#state)
5456
staged-quote: for [StagedQuote](/projects/staged-quotes#stagedquote)
57+
standalone-price: for [StandalonePrice](/projects/standalone-prices#standaloneprice)
58+
state: for [State](/projects/states#state)
5559
store: for [Store](/projects/stores#store)
5660
tax-category: for [TaxCategory](/projects/taxCategories#taxcategory)
5761
type: for [Type](/projects/types#type)

api-specs/history/types/UpdateType.raml

Lines changed: 68 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,14 +29,19 @@ enum:
2929
- 'addProperty'
3030
- 'addReturnInfo'
3131
- 'addRoles'
32+
- 'addShipping'
3233
- 'addShippingAddressId'
34+
- 'addShippingRate'
3335
- 'addTaxRate'
3436
- 'addTextLineItem'
3537
- 'addToCategory'
3638
- 'addTransaction'
3739
- 'addVariant'
40+
- 'addZone'
41+
- 'changeActive'
3842
- 'changeAddress'
3943
- 'changeAmountPlanned'
44+
- 'changeApprovalRuleMode'
4045
- 'changeAssetName'
4146
- 'changeAssetOrder'
4247
- 'changeAssociate'
@@ -46,21 +51,29 @@ enum:
4651
- 'changeAttributeOrderByName'
4752
- 'changeCartDiscounts'
4853
- 'changeCartPredicate'
54+
- 'changeCustomLineItemPriceRoundingMode'
4955
- 'changeCustomLineItemQuantity'
56+
- 'changeCustomer'
5057
- 'changeDescription'
58+
- 'changeDiscountTypeCombination'
5159
- 'changeEmail'
5260
- 'changeEnumKey'
5361
- 'changeEnumValueLabel'
5462
- 'changeEnumValueOrder'
5563
- 'changeFieldDefinitionOrder'
5664
- 'changeGroups'
65+
- 'changeIncludedInStatistics'
5766
- 'changeInitial'
5867
- 'changeInputHint'
5968
- 'changeIsActive'
69+
- 'changeIsDefault'
6070
- 'changeIsSearchable'
6171
- 'changeKey'
6272
- 'changeLabel'
73+
- 'changeLastVariantId'
6374
- 'changeLineItemName'
75+
- 'changeLineItemPriceRoundingMode'
76+
- 'changeLineItemPublished'
6477
- 'changeLineItemQuantity'
6578
- 'changeLineItemsOrder'
6679
- 'changeLocalizedEnumValueLabel'
@@ -75,6 +88,7 @@ enum:
7588
- 'changePlainEnumValueLabel'
7689
- 'changePredicate'
7790
- 'changePrice'
91+
- 'changePriceRoundingMode'
7892
- 'changeProductSelectionActive'
7993
- 'changeQuantity'
8094
- 'changeQuoteRequestState'
@@ -89,16 +103,19 @@ enum:
89103
- 'changeStatus'
90104
- 'changeTarget'
91105
- 'changeTaxCalculationMode'
106+
- 'changeTaxCategory'
92107
- 'changeTaxMode'
93108
- 'changeTaxRoundingMode'
94109
- 'changeTextLineItemName'
95110
- 'changeTextLineItemQuantity'
96111
- 'changeTextLineItemsOrder'
112+
- 'changeTopLevelUnit'
97113
- 'changeTransactionInteractionId'
98114
- 'changeTransactionState'
99115
- 'changeTransactionTimestamp'
100116
- 'changeType'
101117
- 'changeValue'
118+
- 'excludeProduct'
102119
- 'moveImageToPosition'
103120
- 'publish'
104121
- 'removeAddress'
@@ -123,26 +140,37 @@ enum:
123140
- 'removeProductSelection'
124141
- 'removeProperty'
125142
- 'removeRoles'
143+
- 'removeShipping'
126144
- 'removeShippingAddressId'
145+
- 'removeShippingRate'
127146
- 'removeTaxRate'
128147
- 'removeTextLineItem'
129148
- 'removeVariant'
149+
- 'removeZone'
150+
- 'replaceTaxRate'
130151
- 'requestQuoteRenegotiation'
152+
- 'revertStagedChanges'
153+
- 'revertStagedVariantChanges'
131154
- 'setAddress'
132155
- 'setAddressCustomField'
133156
- 'setAddressCustomType'
157+
- 'setAncestors'
134158
- 'setAnonymousId'
135159
- 'setApplicationVersion'
136160
- 'setAssetCustomField'
137161
- 'setAssetCustomType'
138162
- 'setAssetDescription'
163+
- 'setAssetKey'
139164
- 'setAssetSources'
140165
- 'setAssetTags'
141-
- 'setAssetKey'
166+
- 'setAssociates'
142167
- 'setAttribute'
143168
- 'setAuthenticationMode'
144169
- 'setAuthorName'
145170
- 'setBillingAddress'
171+
- 'setBillingAddressCustomField'
172+
- 'setBillingAddressCustomType'
173+
- 'setBusinessUnit'
146174
- 'setCartPredicate'
147175
- 'setCategoryOrderHint'
148176
- 'setCompanyName'
@@ -152,6 +180,8 @@ enum:
152180
- 'setCustomField'
153181
- 'setCustomLineItemCustomField'
154182
- 'setCustomLineItemCustomType'
183+
- 'setCustomLineItemDiscountedPrice'
184+
- 'setCustomLineItemDiscountedPricePerQuantity'
155185
- 'setCustomLineItemMoney'
156186
- 'setCustomLineItemShippingDetails'
157187
- 'setCustomLineItemTaxAmount'
@@ -164,25 +194,36 @@ enum:
164194
- 'setCustomer'
165195
- 'setCustomerEmail'
166196
- 'setCustomerGroup'
197+
- 'setCustomerGroupAssignments'
167198
- 'setCustomerId'
168199
- 'setCustomerNumber'
169200
- 'setDateOfBirth'
170201
- 'setDefaultBillingAddress'
171202
- 'setDefaultShippingAddress'
172203
- 'setDeleteDaysAfterLastModification'
173204
- 'setDeliveryAddress'
205+
- 'setDeliveryAddressCustomField'
206+
- 'setDeliveryAddressCustomType'
207+
- 'setDeliveryCustomField'
208+
- 'setDeliveryCustomType'
174209
- 'setDeliveryItems'
175210
- 'setDescription'
211+
- 'setDirectDiscounts'
212+
- 'setDiscountOnTotalPrice'
176213
- 'setDiscountedPrice'
177214
- 'setDistributionChannels'
178215
- 'setExpectedDelivery'
179216
- 'setExternalId'
180217
- 'setFirstName'
181218
- 'setGeoLocation'
182219
- 'setImageLabel'
220+
- 'setInheritedAssociates'
221+
- 'setInheritedStores'
183222
- 'setInputTip'
184223
- 'setInterfaceId'
185224
- 'setIsValid'
225+
- 'setItemShippingAddressCustomField'
226+
- 'setItemShippingAddressCustomType'
186227
- 'setKey'
187228
- 'setLanguages'
188229
- 'setLastName'
@@ -201,25 +242,36 @@ enum:
201242
- 'setLineItemTaxedPrice'
202243
- 'setLineItemTotalPrice'
203244
- 'setLocale'
245+
- 'setLocalizedDescription'
246+
- 'setLocalizedName'
204247
- 'setMaxApplications'
205248
- 'setMaxApplicationsPerCustomer'
249+
- 'setMaxCartQuantity'
206250
- 'setMetaDescription'
207251
- 'setMetaKeywords'
208252
- 'setMetaTitle'
209253
- 'setMethodInfoInterface'
210254
- 'setMethodInfoMethod'
211255
- 'setMethodInfoName'
212256
- 'setMiddleName'
257+
- 'setMinCartQuantity'
213258
- 'setName'
214259
- 'setOrderNumber'
215260
- 'setOrderTaxedPrice'
216261
- 'setOrderTotalPrice'
217262
- 'setOrderTotalTax'
263+
- 'setParcelCustomField'
264+
- 'setParcelCustomType'
218265
- 'setParcelItems'
219266
- 'setParcelMeasurements'
220267
- 'setParcelTrackingData'
221268
- 'setPassword'
269+
- 'setPredicate'
270+
- 'setPriceKey'
271+
- 'setPriceMode'
272+
- 'setPriceTiers'
222273
- 'setPrices'
274+
- 'setProductAttribute'
223275
- 'setProductCount'
224276
- 'setProductPriceCustomField'
225277
- 'setProductPriceCustomType'
@@ -228,19 +280,29 @@ enum:
228280
- 'setProperty'
229281
- 'setPurchaseOrderNumber'
230282
- 'setRating'
283+
- 'setReferences'
231284
- 'setReservations'
232285
- 'setRestockableInDays'
286+
- 'setReturnInfo'
287+
- 'setReturnItemCustomField'
288+
- 'setReturnItemCustomType'
233289
- 'setReturnPaymentState'
234290
- 'setReturnShipmentState'
235291
- 'setRoles'
236292
- 'setSalutation'
237293
- 'setSearchKeywords'
238294
- 'setSellerComment'
239295
- 'setShippingAddress'
296+
- 'setShippingAddressCustomField'
297+
- 'setShippingAddressCustomType'
298+
- 'setShippingCustomField'
299+
- 'setShippingCustomType'
300+
- 'setShippingInfoDiscountedPrice'
240301
- 'setShippingInfoPrice'
241302
- 'setShippingInfoTaxedPrice'
242303
- 'setShippingMethod'
243304
- 'setShippingMethodTaxAmount'
305+
- 'setShippingMethodTaxCategory'
244306
- 'setShippingMethodTaxRate'
245307
- 'setShippingRate'
246308
- 'setShippingRateInput'
@@ -255,18 +317,23 @@ enum:
255317
- 'setSupplyChannels'
256318
- 'setTarget'
257319
- 'setTaxCategory'
320+
- 'setTaxedShippingPrice'
258321
- 'setText'
259322
- 'setTextLineItemCustomField'
260323
- 'setTextLineItemCustomType'
261324
- 'setTextLineItemDescription'
262325
- 'setTitle'
326+
- 'setTransactionCustomField'
327+
- 'setTransactionCustomType'
263328
- 'setTransitions'
329+
- 'setUnitType'
264330
- 'setValidFrom'
265331
- 'setValidFromAndUntil'
266332
- 'setValidTo'
267333
- 'setValidUntil'
268334
- 'setValue'
269335
- 'setVariantAvailability'
336+
- 'setVariantExclusion'
270337
- 'setVariantSelection'
271338
- 'setVatId'
272339
- 'transitionCustomLineItemState'
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
#%RAML 1.0 DataType
2+
(package): Change
3+
type: Change
4+
displayName: ChangeCustomLineItemPriceRoundingModeChange
5+
discriminatorValue: ChangeCustomLineItemPriceRoundingModeChange
6+
description: Change triggered by the [Change Price Rounding Mode](ctp:api:type:StagedOrderChangePriceRoundingModeAction) update action.
7+
properties:
8+
change:
9+
type: string
10+
enum:
11+
- changeCustomLineItemPriceRoundingMode
12+
type:
13+
type: string
14+
enum:
15+
- ChangeCustomLineItemPriceRoundingModeChange
16+
customLineItem:
17+
type: LocalizedString
18+
description: Name of the updated [CustomLineItem](ctp:api:type:CustomLineItem).
19+
customLineItemId:
20+
type: string
21+
description: |
22+
`id` of the updated [CustomLineItem](ctp:api:type:CustomLineItem).
23+
previousValue:
24+
type: RoundingMode
25+
description: Value before the change.
26+
nextValue:
27+
type: RoundingMode
28+
description: Value after the change.
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
#%RAML 1.0 DataType
2+
(package): Change
3+
type: Change
4+
displayName: ChangeDiscountTypeCombinationChange
5+
discriminatorValue: ChangeDiscountTypeCombinationChange
6+
description: Change triggered by the [Set Discounts Configuration](ctp:api:type:ProjectSetDiscountsConfigurationAction) update action.
7+
properties:
8+
change:
9+
type: string
10+
enum:
11+
- changeDiscountTypeCombination
12+
type:
13+
type: string
14+
enum:
15+
- ChangeDiscountTypeCombinationChange
16+
previousValue:
17+
type: DiscountTypeCombination
18+
description: Value before the change.
19+
nextValue:
20+
type: DiscountTypeCombination
21+
description: Value after the change.

0 commit comments

Comments
 (0)