You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: lib/commercetools-api/docs/RequestBuilder.md
+17-17Lines changed: 17 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2397,7 +2397,7 @@ The following applies to the new Cart:
2397
2397
- Line items and Custom Line Items are reset to their initial [state](/projects/carts#itemstate).
2398
2398
- It contains no payments or delivery information.
2399
2399
- It contains up-to-date Tax Rates, Prices, and Line Item product data.
2400
-
- The [CartState](/projects/carts#cartstate) is `Active`.
2400
+
- The [CartState](ctp:api:type:CartState) is `Active`.
2401
2401
- If using the `customerGroup` field (for a single Customer Group) and the referenced Customer switched to another Customer Group, the new Cart is automatically updated to reflect the new group and corresponding prices.
2402
2402
- If using the `customerGroupAssignments` field (for multiple Customer Groups), the Cart no longer keeps a direct reference to a Customer Group. If a Customer’s group assignments change, the Cart and its Line Item prices are not updated automatically. Prices are only updated when the Cart is changed via a [direct update action](/projects/carts#update-actions).
2403
2403
@@ -3889,7 +3889,7 @@ $request = $builder
3889
3889
3890
3890
The My Business Unit endpoint does not support assigning existing Customers to a Business Unit.
3891
3891
Associates with the `UpdateAssociates`[Permission](ctp:api:type:Permission) can use this endpoint to create a new Customer and associate it with the Business Unit.
3892
-
If the required [Permission](/projects/associate-roles#permission) is missing, an [AssociateMissingPermission](/errors#associatemissingpermission) error is returned.
3892
+
If the required [Permission](ctp:api:type:Permission) is missing, an [AssociateMissingPermission](ctp:api:type:AssociateMissingPermissionError) error is returned.
3893
3893
3894
3894
3895
3895
### Example
@@ -4571,7 +4571,7 @@ The following applies to the new Cart:
4571
4571
- Line items and Custom Line Items are reset to their initial [state](/projects/carts#itemstate).
4572
4572
- It contains no payments or delivery information.
4573
4573
- It contains up-to-date Tax Rates, Prices, and Line Item product data.
4574
-
- The [CartState](/projects/carts#cartstate) is `Active`.
4574
+
- The [CartState](ctp:api:type:CartState) is `Active`.
4575
4575
- If using the `customerGroup` field (for a single Customer Group) and the referenced Customer switched to another Customer Group, the new Cart is automatically updated to reflect the new group and corresponding prices.
4576
4576
- If using the `customerGroupAssignments` field (for multiple Customer Groups), the Cart no longer keeps a direct reference to a Customer Group. If a Customer’s group assignments change, the Cart and its Line Item prices are not updated automatically. Prices are only updated when the Cart is changed via a [direct update action](/projects/carts#update-actions).
4577
4577
@@ -6716,7 +6716,7 @@ $request = $builder
6716
6716
6717
6717
Retrieves a ShoppingList with the provided `id` in a [Store](ctp:api:type:Store).
6718
6718
If a ShoppingList exists in a Project but does _not_ have the `store` field, or the `store` field references a different Store,
6719
-
the [ResourceNotFound](/errors#404-not-found-1) error is returned.
6719
+
the [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error is returned.
6720
6720
6721
6721
6722
6722
### Example
@@ -6751,7 +6751,7 @@ $request = $builder
6751
6751
6752
6752
Updates a ShoppingList in a [Store](ctp:api:type:Store) using one or more [update actions](/api/projects/shoppingLists#update-actions).
6753
6753
If a ShoppingList exists in a Project but does _not_ have the `store` field, or the `store` field references a different Store,
6754
-
the [ResourceNotFound](/errors#404-not-found-1) error is returned.
6754
+
the [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error is returned.
6755
6755
6756
6756
6757
6757
### Example
@@ -6770,7 +6770,7 @@ $request = $builder
6770
6770
6771
6771
Deletes a ShoppingList in a [Store](ctp:api:type:Store).
6772
6772
If a ShoppingList exists in a Project but does _not_ have the `store` field, or the `store` field references a different Store,
6773
-
the [ResourceNotFound](/errors#404-not-found-1) error is returned.
6773
+
the [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error is returned.
6774
6774
6775
6775
6776
6776
### Example
@@ -6789,7 +6789,7 @@ $request = $builder
6789
6789
6790
6790
Retrieves a ShoppingList with the provided `key` in a [Store](ctp:api:type:Store).
6791
6791
If a ShoppingList exists in a Project but does _not_ have the `store` field, or the `store` field references a different Store,
6792
-
the [ResourceNotFound](/errors#404-not-found-1) error is returned.
6792
+
the [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error is returned.
6793
6793
6794
6794
6795
6795
### Example
@@ -6824,7 +6824,7 @@ $request = $builder
6824
6824
6825
6825
Updates a ShoppingList in a [Store](ctp:api:type:Store) using one or more [update actions](/api/projects/shoppingLists#update-actions).
6826
6826
If a ShoppingList exists in a Project but does _not_ have the `store` field, or the `store` field references a different Store,
6827
-
the [ResourceNotFound](/errors#404-not-found-1) error is returned.
6827
+
the [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error is returned.
6828
6828
6829
6829
6830
6830
### Example
@@ -6843,7 +6843,7 @@ $request = $builder
6843
6843
6844
6844
Deletes a ShoppingList in a [Store](ctp:api:type:Store).
6845
6845
If a ShoppingList exists in a Project but does _not_ have the `store` field, or the `store` field references a different Store,
6846
-
the [ResourceNotFound](/errors#404-not-found-1) error is returned.
6846
+
the [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error is returned.
Automatically assigns the Associate to the Business Unit in the default [Associate Role](ctp:api:type:AssociateRole) defined in [BusinessUnitConfiguration](ctp:api:type:BusinessUnitConfiguration). If there is no default Associate Role configured, this request fails with an [InvalidOperation](ctp:api:type:InvalidOperationError) error. When creating a Division, the Associate must have the `AddChildUnits`[Permission](ctp:api:type:Permission) in the parent unit. If the required [Permission](/projects/associate-roles#permission) is missing, an [AssociateMissingPermission](/errors#associatemissingpermission) error is returned.
7349
+
Automatically assigns the Associate to the Business Unit in the default [Associate Role](ctp:api:type:AssociateRole) defined in [BusinessUnitConfiguration](ctp:api:type:BusinessUnitConfiguration). If there is no default Associate Role configured, this request fails with an [InvalidOperation](ctp:api:type:InvalidOperationError) error. When creating a Division, the Associate must have the `AddChildUnits`[Permission](ctp:api:type:Permission) in the parent unit. If the required [Permission](ctp:api:type:Permission) is missing, an [AssociateMissingPermission](ctp:api:type:AssociateMissingPermissionError) error is returned.
Checks if a [Payment](/projects/me-payments#mypayment) exists with the provided `id` for the authenticated Customer or anonymous user. Returns a `200` status if the Payment exists, or a `404` status otherwise.
7936
+
Checks if a Payment exists with the provided `id` for the authenticated Customer or anonymous user. Returns a `200` status if the Payment exists, or a `404` status otherwise.
Updates a [Payment](/projects/me-payments#mypayment) for the authenticated Customer or anonymous user using one or more [update actions](/api/projects/me-payments#update-actions).
7952
+
Updates a Payment for the authenticated Customer or anonymous user using one or more [update actions](/api/projects/me-payments#update-actions).
7953
7953
You can only update a Payment if it has no [Transactions](ctp:api:type:Transaction).
Deletes a [Payment](/projects/me-payments#mypayment) with the provided `id` for the authenticated Customer or anonymous user.
7970
+
Deletes a Payment with the provided `id` for the authenticated Customer or anonymous user.
7971
7971
You can only delete a Payment if it has no [Transactions](ctp:api:type:Transaction).
7972
7972
7973
7973
@@ -8744,7 +8744,7 @@ $request = $builder
8744
8744
Creates an OrderEdit in the Project.
8745
8745
You can either create multiple Order Edits for an Order and apply them sequentially to an Order, or create multiple Order Edits parallelly (as alternatives to each other) and apply one of them to the Order.
8746
8746
8747
-
You can only create an Order Edit if the [InventoryMode](/projects/carts#inventorymode) of the Order and its [LineItems](/projects/carts#lineitem) is `None`.
8747
+
You can only create an Order Edit if the [InventoryMode](ctp:api:type:InventoryMode) of the Order and its [LineItems](/projects/carts#lineitem) is `None`.
Copy file name to clipboardExpand all lines: lib/commercetools-api/src/Models/Common/CentPrecisionMoneyBuilder.php
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -44,7 +44,7 @@ final class CentPrecisionMoneyBuilder implements Builder
44
44
* <li>Cents for EUR and USD, pence for GBP, or centime for CHF (5 CHF is specified as <code>500</code>).</li>
45
45
* <li>The value in the major unit for currencies without minor units, like JPY (5 JPY is specified as <code>5</code>).</li>
46
46
* </ul>
47
-
* <p><code>centAmount</code> is represented as 64-bit integers. If this limit is exceeded, a <a href="/errors#moneyoverflow">MoneyOverflow</a> error will be returned.</p>
47
+
* <p><code>centAmount</code> is represented as 64-bit integers. If this limit is exceeded, a <a href="ctp:api:type:MoneyOverflowError">MoneyOverflow</a> error will be returned.</p>
Copy file name to clipboardExpand all lines: lib/commercetools-api/src/Models/Common/CentPrecisionMoneyModel.php
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -66,7 +66,7 @@ public function __construct(
66
66
* <li>Cents for EUR and USD, pence for GBP, or centime for CHF (5 CHF is specified as <code>500</code>).</li>
67
67
* <li>The value in the major unit for currencies without minor units, like JPY (5 JPY is specified as <code>5</code>).</li>
68
68
* </ul>
69
-
* <p><code>centAmount</code> is represented as 64-bit integers. If this limit is exceeded, a <a href="/errors#moneyoverflow">MoneyOverflow</a> error will be returned.</p>
69
+
* <p><code>centAmount</code> is represented as 64-bit integers. If this limit is exceeded, a <a href="ctp:api:type:MoneyOverflowError">MoneyOverflow</a> error will be returned.</p>
Copy file name to clipboardExpand all lines: lib/commercetools-api/src/Models/Common/HighPrecisionMoneyBuilder.php
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -50,7 +50,7 @@ final class HighPrecisionMoneyBuilder implements Builder
50
50
* <li>Cents for EUR and USD, pence for GBP, or centime for CHF (5 CHF is specified as <code>500</code>).</li>
51
51
* <li>The value in the major unit for currencies without minor units, like JPY (5 JPY is specified as <code>5</code>).</li>
52
52
* </ul>
53
-
* <p><code>centAmount</code> is represented as 64-bit integers. If this limit is exceeded, a <a href="/errors#moneyoverflow">MoneyOverflow</a> error will be returned.</p>
53
+
* <p><code>centAmount</code> is represented as 64-bit integers. If this limit is exceeded, a <a href="ctp:api:type:MoneyOverflowError">MoneyOverflow</a> error will be returned.</p>
Copy file name to clipboardExpand all lines: lib/commercetools-api/src/Models/Common/HighPrecisionMoneyDraft.php
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -25,7 +25,7 @@ public function getFractionDigits();
25
25
26
26
/**
27
27
* <p>Amount in 1 / (10 ^ <code>fractionDigits</code>) of a currency.</p>
28
-
* <p><code>preciseAmount</code> is represented as 64-bit integers. If this limit is exceeded, a <a href="/errors#moneyoverflow">MoneyOverflow</a> error will be returned.</p>
28
+
* <p><code>preciseAmount</code> is represented as 64-bit integers. If this limit is exceeded, a <a href="ctp:api:type:MoneyOverflowError">MoneyOverflow</a> error will be returned.</p>
29
29
*
30
30
31
31
* @return null|int
@@ -35,7 +35,7 @@ public function getPreciseAmount();
35
35
/**
36
36
* <p>Amount in the smallest indivisible unit of a currency. This field is optional for high precision. If provided, it is checked for validity. Example:</p>
37
37
* <p>A Price of 1.015 USD can be rounded either to 1.01 USD or 1.02 USD. If it lies outside of this range, an error message stating that centAmount must be rounded correctly will be returned.</p>
38
-
* <p><code>centAmount</code> is represented as 64-bit integers. If this limit is exceeded, a <a href="/errors#moneyoverflow">MoneyOverflow</a> error will be returned.</p>
38
+
* <p><code>centAmount</code> is represented as 64-bit integers. If this limit is exceeded, a <a href="ctp:api:type:MoneyOverflowError">MoneyOverflow</a> error will be returned.</p>
39
39
* <p>If <code>centAmount</code> is not provided, the API calculates the value automatically using the default rounding mode half even.</p>
Copy file name to clipboardExpand all lines: lib/commercetools-api/src/Models/Common/HighPrecisionMoneyDraftBuilder.php
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -47,7 +47,7 @@ final class HighPrecisionMoneyDraftBuilder implements Builder
47
47
/**
48
48
* <p>Amount in the smallest indivisible unit of a currency. This field is optional for high precision. If provided, it is checked for validity. Example:</p>
49
49
* <p>A Price of 1.015 USD can be rounded either to 1.01 USD or 1.02 USD. If it lies outside of this range, an error message stating that centAmount must be rounded correctly will be returned.</p>
50
-
* <p><code>centAmount</code> is represented as 64-bit integers. If this limit is exceeded, a <a href="/errors#moneyoverflow">MoneyOverflow</a> error will be returned.</p>
50
+
* <p><code>centAmount</code> is represented as 64-bit integers. If this limit is exceeded, a <a href="ctp:api:type:MoneyOverflowError">MoneyOverflow</a> error will be returned.</p>
51
51
* <p>If <code>centAmount</code> is not provided, the API calculates the value automatically using the default rounding mode half even.</p>
52
52
*
53
53
@@ -82,7 +82,7 @@ public function getFractionDigits()
82
82
83
83
/**
84
84
* <p>Amount in 1 / (10 ^ <code>fractionDigits</code>) of a currency.</p>
85
-
* <p><code>preciseAmount</code> is represented as 64-bit integers. If this limit is exceeded, a <a href="/errors#moneyoverflow">MoneyOverflow</a> error will be returned.</p>
85
+
* <p><code>preciseAmount</code> is represented as 64-bit integers. If this limit is exceeded, a <a href="ctp:api:type:MoneyOverflowError">MoneyOverflow</a> error will be returned.</p>
Copy file name to clipboardExpand all lines: lib/commercetools-api/src/Models/Common/HighPrecisionMoneyDraftModel.php
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -71,7 +71,7 @@ public function __construct(
71
71
/**
72
72
* <p>Amount in the smallest indivisible unit of a currency. This field is optional for high precision. If provided, it is checked for validity. Example:</p>
73
73
* <p>A Price of 1.015 USD can be rounded either to 1.01 USD or 1.02 USD. If it lies outside of this range, an error message stating that centAmount must be rounded correctly will be returned.</p>
74
-
* <p><code>centAmount</code> is represented as 64-bit integers. If this limit is exceeded, a <a href="/errors#moneyoverflow">MoneyOverflow</a> error will be returned.</p>
74
+
* <p><code>centAmount</code> is represented as 64-bit integers. If this limit is exceeded, a <a href="ctp:api:type:MoneyOverflowError">MoneyOverflow</a> error will be returned.</p>
75
75
* <p>If <code>centAmount</code> is not provided, the API calculates the value automatically using the default rounding mode half even.</p>
76
76
*
77
77
*
@@ -153,7 +153,7 @@ public function getFractionDigits()
153
153
154
154
/**
155
155
* <p>Amount in 1 / (10 ^ <code>fractionDigits</code>) of a currency.</p>
156
-
* <p><code>preciseAmount</code> is represented as 64-bit integers. If this limit is exceeded, a <a href="/errors#moneyoverflow">MoneyOverflow</a> error will be returned.</p>
156
+
* <p><code>preciseAmount</code> is represented as 64-bit integers. If this limit is exceeded, a <a href="ctp:api:type:MoneyOverflowError">MoneyOverflow</a> error will be returned.</p>
Copy file name to clipboardExpand all lines: lib/commercetools-api/src/Models/Common/HighPrecisionMoneyModel.php
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -74,7 +74,7 @@ public function __construct(
74
74
* <li>Cents for EUR and USD, pence for GBP, or centime for CHF (5 CHF is specified as <code>500</code>).</li>
75
75
* <li>The value in the major unit for currencies without minor units, like JPY (5 JPY is specified as <code>5</code>).</li>
76
76
* </ul>
77
-
* <p><code>centAmount</code> is represented as 64-bit integers. If this limit is exceeded, a <a href="/errors#moneyoverflow">MoneyOverflow</a> error will be returned.</p>
77
+
* <p><code>centAmount</code> is represented as 64-bit integers. If this limit is exceeded, a <a href="ctp:api:type:MoneyOverflowError">MoneyOverflow</a> error will be returned.</p>
* <li>Cents for EUR and USD, pence for GBP, or centime for CHF (5 CHF is specified as <code>500</code>).</li>
23
23
* <li>The value in the major unit for currencies without minor units, like JPY (5 JPY is specified as <code>5</code>).</li>
24
24
* </ul>
25
-
* <p><code>centAmount</code> is represented as 64-bit integers. If this limit is exceeded, a <a href="/errors#moneyoverflow">MoneyOverflow</a> error will be returned.</p>
25
+
* <p><code>centAmount</code> is represented as 64-bit integers. If this limit is exceeded, a <a href="ctp:api:type:MoneyOverflowError">MoneyOverflow</a> error will be returned.</p>
Copy file name to clipboardExpand all lines: lib/commercetools-api/src/Models/Common/MoneyBuilder.php
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -38,7 +38,7 @@ final class MoneyBuilder implements Builder
38
38
* <li>Cents for EUR and USD, pence for GBP, or centime for CHF (5 CHF is specified as <code>500</code>).</li>
39
39
* <li>The value in the major unit for currencies without minor units, like JPY (5 JPY is specified as <code>5</code>).</li>
40
40
* </ul>
41
-
* <p><code>centAmount</code> is represented as 64-bit integers. If this limit is exceeded, a <a href="/errors#moneyoverflow">MoneyOverflow</a> error will be returned.</p>
41
+
* <p><code>centAmount</code> is represented as 64-bit integers. If this limit is exceeded, a <a href="ctp:api:type:MoneyOverflowError">MoneyOverflow</a> error will be returned.</p>
0 commit comments