Skip to content

Commit

Permalink
Updated API from documentation release
Browse files Browse the repository at this point in the history
  • Loading branch information
ct-sdks[bot] committed Apr 24, 2024
1 parent f39e14a commit c50b9ff
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 0 deletions.
7 changes: 7 additions & 0 deletions api-specs/import/types/price-import.raml
Original file line number Diff line number Diff line change
Expand Up @@ -76,9 +76,16 @@ types:
type: common.DiscountedPrice
publish?:
type: boolean
(annotations.markDeprecated): true
default: false
description: |
Only the [Embedded Price](/../api/projects/products#embedded-price) updates will be published to `staged` and `current` projection.
staged?:
type: boolean
default: true
description: |
- Set to `false` to update both the [current and staged projections](/../api/projects/productProjections#current--staged) of the [Product](/../api/projects/products#product) with the new Price data.
- Leave empty or set to `true` to only update the staged projection.
tiers?:
description: The tiered prices for this price.
type: common.PriceTier[]
Expand Down
7 changes: 7 additions & 0 deletions api-specs/import/types/product-variant-import.raml
Original file line number Diff line number Diff line change
Expand Up @@ -234,11 +234,18 @@ types:
Maps to `ProductVariant.assets`.
type: common.Asset[]
publish?:
(annotations.markDeprecated): true
type: boolean
description: |
If `publish` is set to either `true` or `false`, both staged and current projections are set to the same value provided by the import data.
If `publish` is not set, the staged projection is set to the provided import data, but the current projection stays unchanged.
However, if the import data contains no update, that is, if it matches the staged projection of the existing Product, the import induces no change in the existing Product whether `publish` is set or not.
staged?:
type: boolean
default: true
description: |
- Set to `false` to update both the [current and staged projections](/../api/projects/productProjections#current--staged) of the [Product](/../api/projects/products#product) with the new Product Variant data.
- Leave empty or set to `true` to only update the staged projection.
product:
description: |
The [Product](/../api/projects/products#productvariant) to which this Product Variant belongs. Maps to `ProductVariant.product`.
Expand Down

0 comments on commit c50b9ff

Please sign in to comment.