Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ public function getSlug();

/**
* <p>User-defined unique identifier for the Product.</p>
* <p>This field is optional for backwards compatibility reasons, but we strongly recommend setting it. Keys are mandatory for importing Products with the <a href="/../import-export/">Import API</a> and the <a href="/../merchant-center/import-data">Merchant Center</a>.</p>
* <p>This field is optional for backwards compatibility reasons, but we strongly recommend setting it. Keys are mandatory for importing Products with the <a href="/../api/import-export/">Import API</a> and the <a href="/../merchant-center/import-data">Merchant Center</a>.</p>
* <p>To update a Product using the Import API or Merchant Center, the Product <code>key</code> must match the pattern <code>^[A-Za-z0-9_-]{2,256}$</code>.</p>
*

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,7 @@ public function getSlug()

/**
* <p>User-defined unique identifier for the Product.</p>
* <p>This field is optional for backwards compatibility reasons, but we strongly recommend setting it. Keys are mandatory for importing Products with the <a href="/../import-export/">Import API</a> and the <a href="/../merchant-center/import-data">Merchant Center</a>.</p>
* <p>This field is optional for backwards compatibility reasons, but we strongly recommend setting it. Keys are mandatory for importing Products with the <a href="/../api/import-export/">Import API</a> and the <a href="/../merchant-center/import-data">Merchant Center</a>.</p>
* <p>To update a Product using the Import API or Merchant Center, the Product <code>key</code> must match the pattern <code>^[A-Za-z0-9_-]{2,256}$</code>.</p>
*

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -239,7 +239,7 @@ public function getSlug()

/**
* <p>User-defined unique identifier for the Product.</p>
* <p>This field is optional for backwards compatibility reasons, but we strongly recommend setting it. Keys are mandatory for importing Products with the <a href="/../import-export/">Import API</a> and the <a href="/../merchant-center/import-data">Merchant Center</a>.</p>
* <p>This field is optional for backwards compatibility reasons, but we strongly recommend setting it. Keys are mandatory for importing Products with the <a href="/../api/import-export/">Import API</a> and the <a href="/../merchant-center/import-data">Merchant Center</a>.</p>
* <p>To update a Product using the Import API or Merchant Center, the Product <code>key</code> must match the pattern <code>^[A-Za-z0-9_-]{2,256}$</code>.</p>
*
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ interface ProductSetKeyAction extends ProductUpdateAction

/**
* <p>Value to set. If empty, any existing value will be removed.</p>
* <p>To update a Product using the <a href="/../import-export/">Import API</a> and the <a href="/../merchant-center/import-data">Merchant Center</a>, the Product <code>key</code> must match the pattern <code>^[A-Za-z0-9_-]{2,256}$</code>.</p>
* <p>To update a Product using the <a href="/../api/import-export/">Import API</a> and the <a href="/../merchant-center/import-data">Merchant Center</a>, the Product <code>key</code> must match the pattern <code>^[A-Za-z0-9_-]{2,256}$</code>.</p>
*

* @return null|string
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ final class ProductSetKeyActionBuilder implements Builder

/**
* <p>Value to set. If empty, any existing value will be removed.</p>
* <p>To update a Product using the <a href="/../import-export/">Import API</a> and the <a href="/../merchant-center/import-data">Merchant Center</a>, the Product <code>key</code> must match the pattern <code>^[A-Za-z0-9_-]{2,256}$</code>.</p>
* <p>To update a Product using the <a href="/../api/import-export/">Import API</a> and the <a href="/../merchant-center/import-data">Merchant Center</a>, the Product <code>key</code> must match the pattern <code>^[A-Za-z0-9_-]{2,256}$</code>.</p>
*

* @return null|string
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ public function getAction()

/**
* <p>Value to set. If empty, any existing value will be removed.</p>
* <p>To update a Product using the <a href="/../import-export/">Import API</a> and the <a href="/../merchant-center/import-data">Merchant Center</a>, the Product <code>key</code> must match the pattern <code>^[A-Za-z0-9_-]{2,256}$</code>.</p>
* <p>To update a Product using the <a href="/../api/import-export/">Import API</a> and the <a href="/../merchant-center/import-data">Merchant Center</a>, the Product <code>key</code> must match the pattern <code>^[A-Za-z0-9_-]{2,256}$</code>.</p>
*
*
* @return null|string
Expand Down
2 changes: 1 addition & 1 deletion lib/commercetools-import/docs/RequestBuilder.md
Original file line number Diff line number Diff line change
Expand Up @@ -279,7 +279,7 @@ $request = $builder
## `withProjectKeyValue("projectKey")->productVariantPatches()->importContainers()->withImportContainerKeyValue("importContainerKey")->post(null)`

Creates a new import request for Product Variant Patches.
Returns an [InvalidField](/error#invalidfielderror) error if the [ProductVariantPatchRequest](ctp:import:type:ProductVariantPatchRequest) contains patches with and without the `product` field set.
Returns an [InvalidField](ctp:import:type:InvalidFieldError) error if the [ProductVariantPatchRequest](ctp:import:type:ProductVariantPatchRequest) contains patches with and without the `product` field set.


### Example
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ interface CategoryImport extends ImportResource
public const FIELD_CUSTOM = 'custom';

/**
* <p>User-defined unique identifier. If a <a href="/../api/projects/categories#category">Category</a> with this <code>key</code> exists, it will be updated with the imported data.</p>
* <p>User-defined unique identifier. If a <a href="ctp:api:type:Category">Category</a> with this <code>key</code> exists, it will be updated with the imported data.</p>
*

* @return null|string
Expand Down Expand Up @@ -65,8 +65,8 @@ public function getDescription();

/**
* <p>Maps to <code>Category.parent</code>.
* The Reference to the parent <a href="/../api/projects/categories#category">Category</a> with which the Category is associated.
* If referenced Category does not exist, the <code>state</code> of the <a href="/import-operation#importoperation">ImportOperation</a> will be set to <code>unresolved</code> until the necessary Category is created.</p>
* The Reference to the parent <a href="ctp:api:type:Category">Category</a> with which the Category is associated.
* If referenced Category does not exist, the <code>state</code> of the <a href="ctp:import:type:ImportOperation">ImportOperation</a> will be set to <code>unresolved</code> until the necessary Category is created.</p>
*

* @return null|CategoryKeyReference
Expand Down Expand Up @@ -114,6 +114,8 @@ public function getMetaDescription();
public function getMetaKeywords();

/**
* <p>Maps to <code>Category.assets</code>.</p>
*

* @return null|AssetCollection
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ final class CategoryImportBuilder implements Builder
private $custom;

/**
* <p>User-defined unique identifier. If a <a href="/../api/projects/categories#category">Category</a> with this <code>key</code> exists, it will be updated with the imported data.</p>
* <p>User-defined unique identifier. If a <a href="ctp:api:type:Category">Category</a> with this <code>key</code> exists, it will be updated with the imported data.</p>
*

* @return null|string
Expand Down Expand Up @@ -148,8 +148,8 @@ public function getDescription()

/**
* <p>Maps to <code>Category.parent</code>.
* The Reference to the parent <a href="/../api/projects/categories#category">Category</a> with which the Category is associated.
* If referenced Category does not exist, the <code>state</code> of the <a href="/import-operation#importoperation">ImportOperation</a> will be set to <code>unresolved</code> until the necessary Category is created.</p>
* The Reference to the parent <a href="ctp:api:type:Category">Category</a> with which the Category is associated.
* If referenced Category does not exist, the <code>state</code> of the <a href="ctp:import:type:ImportOperation">ImportOperation</a> will be set to <code>unresolved</code> until the necessary Category is created.</p>
*

* @return null|CategoryKeyReference
Expand Down Expand Up @@ -215,6 +215,8 @@ public function getMetaKeywords()
}

/**
* <p>Maps to <code>Category.assets</code>.</p>
*

* @return null|AssetCollection
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ public function __construct(
}

/**
* <p>User-defined unique identifier. If a <a href="/../api/projects/categories#category">Category</a> with this <code>key</code> exists, it will be updated with the imported data.</p>
* <p>User-defined unique identifier. If a <a href="ctp:api:type:Category">Category</a> with this <code>key</code> exists, it will be updated with the imported data.</p>
*
*
* @return null|string
Expand Down Expand Up @@ -218,8 +218,8 @@ public function getDescription()

/**
* <p>Maps to <code>Category.parent</code>.
* The Reference to the parent <a href="/../api/projects/categories#category">Category</a> with which the Category is associated.
* If referenced Category does not exist, the <code>state</code> of the <a href="/import-operation#importoperation">ImportOperation</a> will be set to <code>unresolved</code> until the necessary Category is created.</p>
* The Reference to the parent <a href="ctp:api:type:Category">Category</a> with which the Category is associated.
* If referenced Category does not exist, the <code>state</code> of the <a href="ctp:import:type:ImportOperation">ImportOperation</a> will be set to <code>unresolved</code> until the necessary Category is created.</p>
*
*
* @return null|CategoryKeyReference
Expand Down Expand Up @@ -343,6 +343,8 @@ public function getMetaKeywords()
}

/**
* <p>Maps to <code>Category.assets</code>.</p>
*
*
* @return null|AssetCollection
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ interface DiscountedPrice extends JsonObject
public const FIELD_DISCOUNT = 'discount';

/**
* <p>Money value of the discounted price.</p>
*

* @return null|TypedMoney
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ final class DiscountedPriceBuilder implements Builder
private $discount;

/**
* <p>Money value of the discounted price.</p>
*

* @return null|TypedMoney
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,8 @@ public function __construct(
}

/**
* <p>Money value of the discounted price.</p>
*
*
* @return null|TypedMoney
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,15 @@ interface UnresolvedReferences extends JsonObject
public const FIELD_TYPE_ID = 'typeId';

/**
* <p>The <code>key</code> of the resource.</p>
*

* @return null|string
*/
public function getKey();

/**
* <p>The type of the referenced resource.</p>
* <p>The type of resource.</p>
*

* @return null|string
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ final class UnresolvedReferencesBuilder implements Builder
private $typeId;

/**
* <p>The <code>key</code> of the resource.</p>
*

* @return null|string
*/
Expand All @@ -42,7 +44,7 @@ public function getKey()
}

/**
* <p>The type of the referenced resource.</p>
* <p>The type of resource.</p>
*

* @return null|string
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,8 @@ public function __construct(
}

/**
* <p>The <code>key</code> of the resource.</p>
*
*
* @return null|string
*/
Expand All @@ -62,7 +64,7 @@ public function getKey()
}

/**
* <p>The type of the referenced resource.</p>
* <p>The type of resource.</p>
*
*
* @return null|string
Expand Down
Loading
Loading