Skip to content

Commit e68ca35

Browse files
committed
Updated API from documentation release
1 parent 8f053b3 commit e68ca35

File tree

3 files changed

+4
-3
lines changed

3 files changed

+4
-3
lines changed

api-specs/api/types/cart/CustomLineItem.raml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ properties:
5353
state:
5454
type: ItemState[]
5555
description: |
56-
State of the Custom Line Item in the [Cart](ctp:api:type:Cart) or [Order](ctp:api:type:Order).
56+
Tracks specific quantities of the Custom Line Item within a given State. When a Custom Line Item is added to a Cart, its full quantity is set to the built-in "Initial" state. State transitions for Custom Line Items are managed on the [Order](ctp:api:type:Order).
5757
taxCategory?:
5858
type: TaxCategoryReference
5959
description: |

api-specs/api/types/cart/LineItem.raml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ properties:
8282
state:
8383
type: ItemState[]
8484
description: |
85-
State of the Line Item in the [Cart](ctp:api:type:Cart) or the [Order](ctp:api:type:Order).
85+
Tracks specific quantities of the Line Item within a given State. When a Line Item is added to a Cart, its full quantity is set to the built-in "Initial" state. State transitions for Line Items are managed on the [Order](ctp:api:type:Order).
8686
taxRate?:
8787
type: TaxRate
8888
description: |

api-specs/api/types/state/StateTypeEnum.raml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@ description: |
55
Resource or object type the State can be assigned to.
66
(enumDescriptions):
77
OrderState: Used by [Orders](ctp:api:type:Order).
8-
LineItemState: Used by [LineItems](ctp:api:type:LineItem) and [CustomLineItems](ctp:api:type:CustomLineItem) in [Carts](ctp:api:type:Cart) and [Orders](ctp:api:type:Order).
8+
LineItemState: Used by [LineItems](ctp:api:type:LineItem) and [CustomLineItems](ctp:api:type:CustomLineItem) in [Carts](ctp:api:type:Cart) and [Orders](ctp:api:type:Order), with the `builtin` field always set to `true` by default. In addition, the `initial` field is set to `true` upon creation.
9+
910
ProductState: Used by [Products](ctp:api:type:Product).
1011
ReviewState: Used by [Reviews](ctp:api:type:Review).
1112
PaymentState: Used by [PaymentStatus](ctp:api:type:PaymentStatus) in [Payments](ctp:api:type:Payment).

0 commit comments

Comments
 (0)