Updated API from documentation release

ct-sdks[bot] · ct-sdks[bot] · commit 4fac5bf66caa · 2026-01-08T15:05:11.000Z
diff --git a/api-specs/api/examples/Cart/CartSetPurchaseOrderNumberAction.json b/api-specs/api/examples/Cart/CartSetPurchaseOrderNumberAction.json
@@ -0,0 +1,4 @@
+{
+  "action": "setPurchaseOrderNumber",
+  "purchaseOrderNumber": "purchaseOrderNumberString"
+}
diff --git a/api-specs/api/types/cart/Cart.raml b/api-specs/api/types/cart/Cart.raml
@@ -203,6 +203,12 @@ properties:
     default: 90
     minimum: 1
     maximum: 365250
+  purchaseOrderNumber?:
+    type: string
+    description: |-
+      User-defined identifier of a purchase order.
+
+      It is typically set by the [Buyer](ctp:api:type:Buyer) or Merchant to track the purchase order during the [quote and order flow](/../api/quotes-overview#intended-workflow).
   createdAt:
     type: datetime
     description: |
diff --git a/api-specs/api/types/cart/CartDraft.raml b/api-specs/api/types/cart/CartDraft.raml
@@ -152,3 +152,9 @@ properties:
     type: CustomFieldsDraft
     description: |
       Custom Fields for the Cart.
+  purchaseOrderNumber?:
+    type: string
+    description: |-
+      User-defined identifier of a purchase order.
+
+      It is typically set by the [Buyer](ctp:api:type:Buyer) or Merchant to track the purchase order during the [quote and order flow](/../api/quotes-overview#intended-workflow).
diff --git a/api-specs/api/types/cart/updates/CartSetPurchaseOrderNumberAction.raml b/api-specs/api/types/cart/updates/CartSetPurchaseOrderNumberAction.raml
@@ -0,0 +1,14 @@
+#%RAML 1.0 DataType
+(package): Cart
+example: !include ../../../examples/Cart/CartSetPurchaseOrderNumberAction.json
+type: CartUpdateAction
+displayName: CartSetPurchaseOrderNumberAction
+discriminatorValue: setPurchaseOrderNumber
+description: |
+  Updates the `purchaseOrderNumber` field and produces the [CartPurchaseOrderNumberSet](ctp:api:type:CartPurchaseOrderNumberSetMessage) Message.
+properties:
+  purchaseOrderNumber?:
+    type: string
+    description: |
+      Value to set.
+      If empty, any existing value is removed.
diff --git a/api-specs/api/types/message/CartPurchaseOrderNumberSetMessage.raml b/api-specs/api/types/message/CartPurchaseOrderNumberSetMessage.raml
@@ -0,0 +1,16 @@
+#%RAML 1.0 DataType
+(package): Message
+type: Message
+displayName: CartPurchaseOrderNumberSetMessage
+discriminatorValue: CartPurchaseOrderNumberSet
+description: |
+  Generated after a successful [Set Purchase Order Number](ctp:api:type:CartSetPurchaseOrderNumberAction) update action.
+properties:
+  purchaseOrderNumber?:
+    type: string
+    description: |
+      Purchase order number on the [Cart](ctp:api:type:Cart) after the [Set Purchase Order Number](ctp:api:type:CartSetPurchaseOrderNumberAction) update action.
+  oldPurchaseOrderNumber?:
+    type: string
+    description: |
+      Purchase order number on the [Cart](ctp:api:type:Cart) before the [Set Purchase Order Number](ctp:api:type:CartSetPurchaseOrderNumberAction) update action.
diff --git a/api-specs/api/types/message/payload/CartPurchaseOrderNumberSetMessagePayload.raml b/api-specs/api/types/message/payload/CartPurchaseOrderNumberSetMessagePayload.raml
@@ -0,0 +1,16 @@
+#%RAML 1.0 DataType
+(package): Message
+type: MessagePayload
+displayName: CartPurchaseOrderNumberSetMessagePayload
+discriminatorValue: CartPurchaseOrderNumberSet
+description: |
+  Generated after a successful [Set Purchase Order Number](ctp:api:type:CartSetPurchaseOrderNumberAction) update action.
+properties:
+  purchaseOrderNumber?:
+    type: string
+    description: |
+      Purchase order number on the [Cart](ctp:api:type:Cart) after the [Set Purchase Order Number](ctp:api:type:CartSetPurchaseOrderNumberAction) update action.
+  oldPurchaseOrderNumber?:
+    type: string
+    description: |
+      Purchase order number on the [Cart](ctp:api:type:Cart) before the [Set Purchase Order Number](ctp:api:type:CartSetPurchaseOrderNumberAction) update action.
diff --git a/api-specs/api/types/order/OrderFromCartDraft.raml b/api-specs/api/types/order/OrderFromCartDraft.raml
@@ -27,9 +27,11 @@ properties:
   purchaseOrderNumber?:
     type: string
     description: |-
-      User-defined identifier for a purchase Order.
+      User-defined identifier for a purchase order.
 
-      It is typically set by the [Buyer](ctp:api:type:Buyer) and can be used with [Quotes](/quotes-overview) to track the purchase Order during the [quote and order flow](/../api/quotes-overview#intended-workflow).
+      It is typically set by the [Buyer](ctp:api:type:Buyer) or Merchant to track the purchase order during the [quote and order flow](/../api/quotes-overview#intended-workflow).
+
+      If not provided, the `purchaseOrderNumber` from the referenced [Cart](ctp:api:type:Cart) is used.
   paymentState?:
     type: PaymentState
     description: |
diff --git a/api-specs/api/types/quote-request/QuoteRequest.raml b/api-specs/api/types/quote-request/QuoteRequest.raml
@@ -151,7 +151,7 @@ properties:
     type: string
     description: |
       Identifier for a purchase order, usually in a B2B context.
-      The Purchase Order Number is typically entered by the [Buyer](/quotes-overview#buyer).
+      The purchase order number is typically entered by the [Buyer](/quotes-overview#buyer).
   cart?:
     type: CartReference
     description: |
diff --git a/api-specs/api/types/quote-request/QuoteRequestDraft.raml b/api-specs/api/types/quote-request/QuoteRequestDraft.raml
@@ -36,6 +36,8 @@ properties:
       This reference can point to a State in a custom workflow.
   purchaseOrderNumber?:
     type: string
-    description: |
+    description: |-
       Identifier for a purchase order, usually in a B2B context.
-      The Purchase Order Number is typically entered by the [Buyer](/quotes-overview#buyer).
+      The purchase order number is typically entered by the [Buyer](/quotes-overview#buyer).
+
+      If not provided, the `purchaseOrderNumber` from the referenced [Cart](ctp:api:type:Cart) is used.
diff --git a/api-specs/api/types/quote/Quote.raml b/api-specs/api/types/quote/Quote.raml
@@ -166,7 +166,7 @@ properties:
   purchaseOrderNumber?:
     type: string
     description: |
-      The Purchase Order Number is typically set by the [Buyer](/quotes-overview#buyer) on a [QuoteRequest](ctp:api:type:QuoteRequest) to
+      The purchase order number is typically set by the [Buyer](/quotes-overview#buyer) on a [QuoteRequest](ctp:api:type:QuoteRequest) to
       track the purchase order during the [quote and order flow](/../api/quotes-overview#intended-workflow).
   businessUnit?:
     type: BusinessUnitKeyReference
diff --git a/api-specs/api/types/staged-quote/StagedQuote.raml b/api-specs/api/types/staged-quote/StagedQuote.raml
@@ -68,7 +68,7 @@ properties:
   purchaseOrderNumber?:
     type: string
     description: |
-      The Purchase Order Number is typically set by the [Buyer](/quotes-overview#buyer) on a [QuoteRequest](ctp:api:type:QuoteRequest) to
+      The purchase order number is typically set by the [Buyer](/quotes-overview#buyer) on a [QuoteRequest](ctp:api:type:QuoteRequest) to
       track the purchase order during the [quote and order flow](/../api/quotes-overview#intended-workflow).
   businessUnit?:
     type: BusinessUnitKeyReference
diff --git a/api-specs/api/types/types.raml b/api-specs/api/types/types.raml
@@ -317,6 +317,7 @@ CartSetLineItemTaxAmountAction: !include cart/updates/CartSetLineItemTaxAmountAc
 CartSetLineItemTaxRateAction: !include cart/updates/CartSetLineItemTaxRateAction.raml
 CartSetLineItemTotalPriceAction: !include cart/updates/CartSetLineItemTotalPriceAction.raml
 CartSetLocaleAction: !include cart/updates/CartSetLocaleAction.raml
+CartSetPurchaseOrderNumberAction: !include cart/updates/CartSetPurchaseOrderNumberAction.raml
 CartSetShippingAddressAction: !include cart/updates/CartSetShippingAddressAction.raml
 CartSetShippingAddressCustomFieldAction: !include cart/updates/CartSetShippingAddressCustomFieldAction.raml
 CartSetShippingAddressCustomTypeAction: !include cart/updates/CartSetShippingAddressCustomTypeAction.raml
@@ -974,6 +975,7 @@ CartDiscountStoreAddedMessage: !include message/CartDiscountStoreAddedMessage.ra
 CartDiscountStoreRemovedMessage: !include message/CartDiscountStoreRemovedMessage.raml
 CartDiscountStoresSetMessage: !include message/CartDiscountStoresSetMessage.raml
 CartFrozenMessage: !include message/CartFrozenMessage.raml
+CartPurchaseOrderNumberSetMessage: !include message/CartPurchaseOrderNumberSetMessage.raml
 CartUnfrozenMessage: !include message/CartUnfrozenMessage.raml
 CategoryCreatedMessage: !include message/CategoryCreatedMessage.raml
 CategorySlugChangedMessage: !include message/CategorySlugChangedMessage.raml
@@ -1311,6 +1313,7 @@ CartDiscountStoreAddedMessagePayload: !include message/payload/CartDiscountStore
 CartDiscountStoreRemovedMessagePayload: !include message/payload/CartDiscountStoreRemovedMessagePayload.raml
 CartDiscountStoresSetMessagePayload: !include message/payload/CartDiscountStoresSetMessagePayload.raml
 CartFrozenMessagePayload: !include message/payload/CartFrozenMessagePayload.raml
+CartPurchaseOrderNumberSetMessagePayload: !include message/payload/CartPurchaseOrderNumberSetMessagePayload.raml
 CartUnfrozenMessagePayload: !include message/payload/CartUnfrozenMessagePayload.raml
 CategoryCreatedMessagePayload: !include message/payload/CategoryCreatedMessagePayload.raml
 CategorySlugChangedMessagePayload: !include message/payload/CategorySlugChangedMessagePayload.raml
diff --git a/api-specs/graphql/schema.sdl b/api-specs/graphql/schema.sdl
@@ -1839,6 +1839,7 @@ type Cart implements Versioned & ReferenceExpandable {
   custom: CustomFieldsType
   deleteDaysAfterLastModification: Int
   totalLineItemQuantity: Long
+  purchaseOrderNumber: String
   id: String!
   version: Long!
   createdAt: DateTime!
@@ -2091,12 +2092,19 @@ input CartDraft {
   customerGroup: ResourceIdentifierInput
   shippingRateInput: ShippingRateInputDraft
   origin: CartOrigin = Customer
+  purchaseOrderNumber: String
 }
 
 type CartFrozen implements MessagePayload {
   type: String!
 }
 
+type CartPurchaseOrderNumberSet implements MessagePayload {
+  purchaseOrderNumber: String
+  oldPurchaseOrderNumber: String
+  type: String!
+}
+
 type CartLimitWithCurrent implements LimitWithCurrent {
   limit: Long
   current: Long!
@@ -2232,6 +2240,7 @@ input CartUpdateAction {
   setLineItemTaxRate: SetCartLineItemTaxRate
   setLineItemTotalPrice: SetCartLineItemTotalPrice
   setLocale: SetCartLocale
+  setPurchaseOrderNumber: SetCartPurchaseOrderNumber
   setShippingAddress: SetCartShippingAddress
   setShippingAddressCustomField: SetCartShippingAddressCustomField
   setShippingAddressCustomType: SetCartShippingAddressCustomType
@@ -12698,6 +12707,10 @@ input SetCartLocale {
   locale: Locale
 }
 
+input SetCartPurchaseOrderNumber {
+  purchaseOrderNumber: String
+}
+
 input SetCartShippingAddress {
   address: AddressInput
 }
diff --git a/api-specs/history/types/change/SetPurchaseOrderNumberChange.raml b/api-specs/history/types/change/SetPurchaseOrderNumberChange.raml
@@ -6,6 +6,7 @@ discriminatorValue: SetPurchaseOrderNumberChange
 description: |
   Change triggered by the following update actions:
 
+  - [Set Purchase Order Number](ctp:api:type:CartSetPurchaseOrderNumberAction) on Carts.
   - [Set Purchase Order Number](ctp:api:type:OrderSetPurchaseOrderNumberAction) on Orders.
   - [Set Purchase Order Number](ctp:api:type:StagedOrderSetPurchaseOrderNumberAction) on Staged Orders.
 properties:

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +{
 +  "action": "setPurchaseOrderNumber",
 +  "purchaseOrderNumber": "purchaseOrderNumberString"
 +}