Skip to content

Commit

Permalink
Update broken links to commercetools docs (#1918)
Browse files Browse the repository at this point in the history
* Test add change

* Update links in docs

* Minor changes
  • Loading branch information
industrian authored Oct 16, 2024
1 parent 1ed5196 commit dec6e9b
Show file tree
Hide file tree
Showing 38 changed files with 75 additions and 75 deletions.
8 changes: 4 additions & 4 deletions docs/cli/category-exporter.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# Category Exporter

A package which exports [commercetools categories](https://docs.commercetools.com/http-api-projects-categories.html) in `JSON` format from the [commercetools platform](https://docs.commercetools.com/).
A package which exports [commercetools categories](https://docs.commercetools.com/api/projects/categories) in `JSON` format from the [commercetools platform](https://docs.commercetools.com/).

## Configuration

The constructor accepts two arguments:

- A required object containing the following values:
- `apiConfig` (Object): `AuthMiddleware` options for authentication on the commercetools platform. (Required. See [here](https://commercetools.github.io/nodejs/sdk/api/sdkMiddlewareAuth.html#named-arguments-options))
- `accessToken` (String): [Access token] to be used to authenticate requests to API. Requires scope of [`view_products`, `manage_products`]. More info on how to get the access token [here](https://docs.commercetools.com/http-api-authorization.html#authorization-flows)
- `predicate` (String): Query string specifying (where) predicate. More info on predicates [here](https://docs.commercetools.com/http-api-query-predicates) (Optional)
- `accessToken` (String): [Access token] to be used to authenticate requests to API. Requires scope of [`view_products`, `manage_products`]. More info on how to get the access token [here](https://docs.commercetools.com/api/authorization)
- `predicate` (String): Query string specifying (where) predicate. More info on predicates [here](https://docs.commercetools.com/api/predicates/query) (Optional)
- An optional logger object having four functions (`info`, `warn`, `error` and `debug`)

## Usage
Expand Down Expand Up @@ -47,7 +47,7 @@ Options:
- If the file specified already exists, it will be overwritten.
- The default location for status report logging is the standard output.
- If no output path is specified, the exported categories will be logged to the standard output as a result, status reports will be logged to a `category-exporter.log` file in the current directory.
- The `where` flag specifies an optional (where) query predicate to be included in the request. This predicate should be wrapped in single quotes ('single quoted predicate'). More info on predicates [here](https://docs.commercetools.com/http-api-query-predicates)
- The `where` flag specifies an optional (where) query predicate to be included in the request. This predicate should be wrapped in single quotes ('single quoted predicate'). More info on predicates [here](https://docs.commercetools.com/api/predicates/query)

### JS

Expand Down
2 changes: 1 addition & 1 deletion docs/cli/csv-parser-discount-code.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# CSV Parser Discount Code

Convert [commercetools discount codes](https://docs.commercetools.com/http-api-projects-discountCodes.html) CSV data to JSON. See example below for CSV format, sample response and usage.
Convert [commercetools discount codes](https://docs.commercetools.com/api/projects/discountCodes) CSV data to JSON. See example below for CSV format, sample response and usage.

## Usage

Expand Down
2 changes: 1 addition & 1 deletion docs/cli/csv-parser-orders.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
[![David Dependencies Status][david-icon]][david]
[![David devDependencies Status][david-dev-icon]][david-dev]

Convert [commercetools order](https://docs.commercetools.com/http-api-projects-orders.html) CSV data to JSON. See examples below for supported CSV format and sample responses.
Convert [commercetools order](https://docs.commercetools.com/api/projects/orders) CSV data to JSON. See examples below for supported CSV format and sample responses.

## Usage

Expand Down
2 changes: 1 addition & 1 deletion docs/cli/csv-parser-price.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
[![David Dependencies Status][david-icon]][david]
[![David devDependencies Status][david-dev-icon]][david-dev]

Convert [commercetools price](https://docs.commercetools.com/http-api-projects-products.html#price) CSV data to JSON. See example below for CSV format and sample response
Convert [commercetools price](https://docs.commercetools.com/api/types#price) CSV data to JSON. See example below for CSV format and sample response

## Usage

Expand Down
2 changes: 1 addition & 1 deletion docs/cli/csv-parser-state.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# CSV Parser State

Convert [commercetools states](https://docs.commercetools.com/http-api-projects-states.html#state) CSV data to JSON. See example below for CSV format, sample response and usage.
Convert [commercetools states](https://docs.commercetools.com/api/projects/states#state) CSV data to JSON. See example below for CSV format, sample response and usage.

## Usage

Expand Down
8 changes: 4 additions & 4 deletions docs/cli/custom-objects-exporter.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# Custom Objects Exporter

A package which exports [commercetools custom objects](https://docs.commercetools.com/http-api-projects-custom-objects.html) in `JSON` format from the [commercetools platform](https://docs.commercetools.com/).
A package which exports [commercetools custom objects](https://docs.commercetools.com/api/projects/custom-objects) in `JSON` format from the [commercetools platform](https://docs.commercetools.com/).

## Configuration

The constructor accepts two arguments:

- A required object containing the following values:
- `apiConfig` (Object): `AuthMiddleware` options for authentication on the commercetools platform. (Required. See [here](https://commercetools.github.io/nodejs/sdk/api/sdkMiddlewareAuth.html#named-arguments-options))
- `accessToken` (String): [Access token] to be used to authenticate requests to API. Requires scope of [`view_products`, `view_orders`, `view_customers`]. More info on how to get the access token [here](https://docs.commercetools.com/http-api-authorization.html#authorization-flows)
- `predicate` (String): Query string specifying (where) predicate. More info on predicates [here](https://docs.commercetools.com/http-api-query-predicates) (Optional)
- `accessToken` (String): [Access token] to be used to authenticate requests to API. Requires scope of [`view_products`, `view_orders`, `view_customers`]. More info on how to get the access token [here](https://docs.commercetools.com/api/authorization)
- `predicate` (String): Query string specifying (where) predicate. More info on predicates [here](https://docs.commercetools.com/api/predicates/query) (Optional)
- An optional logger object having four functions (`info`, `warn`, `error` and `debug`)

## Usage
Expand Down Expand Up @@ -46,7 +46,7 @@ Options:
- If the file specified already exists, it will be overwritten.
- The default location for status report logging is the standard output.
- If no output path is specified, the exported objects will be logged to the standard output as a result, status reports will be logged to a `custom-objects-export.log` file in the current directory.
- The `where` flag specifies an optional (where) query predicate to be included in the request. This predicate should be wrapped in single quotes ('single quoted predicate'). More info on predicates [here](https://docs.commercetools.com/http-api-query-predicates)
- The `where` flag specifies an optional (where) query predicate to be included in the request. This predicate should be wrapped in single quotes ('single quoted predicate'). More info on predicates [here](https://docs.commercetools.com/api/predicates/query)

### JS

Expand Down
2 changes: 1 addition & 1 deletion docs/cli/custom-objects-importer.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Custom Objects Importer

This package helps with importing [commercetools custom objects](https://docs.commercetools.com/http-api-projects-custom-objects.html) in JSON format to the [commercetools platform](https://docs.commercetools.com/).
This package helps with importing [commercetools custom objects](https://docs.commercetools.com/api/projects/custom-objects) in JSON format to the [commercetools platform](https://docs.commercetools.com/).
The package is built to be used in conjunction with [sphere-node-cli](https://github.com/sphereio/sphere-node-cli)

## Configuration
Expand Down
8 changes: 4 additions & 4 deletions docs/cli/customer-groups-exporter.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# Customer Groups Exporter

A package which exports [commercetools customer groups](https://docs.commercetools.com/http-api-projects-customerGroups.html) in `JSON` format from the [commercetools platform](https://docs.commercetools.com/).
A package which exports [commercetools customer groups](https://docs.commercetools.com/api/projects/customerGroups) in `JSON` format from the [commercetools platform](https://docs.commercetools.com/).

## Configuration

The constructor accepts two arguments:

- A required object containing the following values:
- `apiConfig` (Object): `AuthMiddleware` options for authentication on the commercetools platform. (Required. See [here](https://commercetools.github.io/nodejs/sdk/api/sdkMiddlewareAuth.html#named-arguments-options))
- `accessToken` (String): [Access token] to be used to authenticate requests to API. Requires scope of [`view_customers`]. More info on how to get the access token [here](https://docs.commercetools.com/http-api-authorization.html#authorization-flows)
- `predicate` (String): Query string specifying (where) predicate. More info on predicates [here](https://docs.commercetools.com/http-api-query-predicates) (Optional)
- `accessToken` (String): [Access token] to be used to authenticate requests to API. Requires scope of [`view_customers`]. More info on how to get the access token [here](https://docs.commercetools.com/api/authorization)
- `predicate` (String): Query string specifying (where) predicate. More info on predicates [here](https://docs.commercetools.com/api/predicates/query) (Optional)
- An optional logger object having four functions (`info`, `warn`, `error` and `debug`)

## Usage
Expand Down Expand Up @@ -46,7 +46,7 @@ Options:
- If the file specified already exists, it will be overwritten.
- The default location for status report logging is the standard output.
- If no output path is specified, the exported groups will be logged to the standard output as a result, status reports will be logged to a `customer-groups-export.log` file in the current directory.
- The `where` flag specifies an optional (where) query predicate to be included in the request. This predicate should be wrapped in single quotes ('single quoted predicate'). More info on predicates [here](https://docs.commercetools.com/http-api-query-predicates)
- The `where` flag specifies an optional (where) query predicate to be included in the request. This predicate should be wrapped in single quotes ('single quoted predicate'). More info on predicates [here](https://docs.commercetools.com/api/predicates/query)

### JS

Expand Down
6 changes: 3 additions & 3 deletions docs/cli/discount-code-exporter.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Discount Code Exporter

A package that helps with exporting [commercetools discount codes](https://docs.commercetools.com/http-api-projects-discountCodes.html) in `JSON` or `CSV` format from the [commercetools platform](https://docs.commercetools.com/).
A package that helps with exporting [commercetools discount codes](https://docs.commercetools.com/api/projects/discountCodes) in `JSON` or `CSV` format from the [commercetools platform](https://docs.commercetools.com/).

## Configuration

Expand All @@ -14,7 +14,7 @@ The constructor accepts two arguments:
- `delimiter` (String): CSV delimiter (Optional. Default: `','`)
- `multiValueDelimiter` (String): CSV delimiter used in multivalue fields (Optional. Default: `';'`)
- `exportFormat` (String): Export format ['csv', 'json'] (Optional. Default: 'json')
- `predicate` (String): Query string specifying (where) predicate. More info on predicates [here](https://docs.commercetools.com/http-api-query-predicates) (Optional)
- `predicate` (String): Query string specifying (where) predicate. More info on predicates [here](https://docs.commercetools.com/api/predicates/query) (Optional)
- `fields` (Array<String>): An array of column names the exported CSV file should contain. This fields array should contain the required columns of the CSV file (Optional. If omitted, a default set of column fields is used. Currently, these fields are: `name`, `description`, `code`, `cartDiscounts`,`cartPredicate`,`groups`,`isActive`,`validFrom`,`validUntil`,`references`,`maxApplications`,`maxApplicationsPerCustomer`.
The localised fields (`name` and `description` default to the language specified in the `language` value above.
This is synonymous with the `--template` flag in the CLI)
Expand Down Expand Up @@ -66,7 +66,7 @@ Options:
- If no output path is specified, the exported codes will be logged to the standard output as a result, status reports will be logged to a `discount-code-export.log` file in the current directory.
- The `--delimiter` flag specifies the delimiter used in the output file if CSV. Defaults to `','` if omitted.
- The `--multiValueDelimiter` flag specifies the delimiter for multiValue cells in the output file if CSV. Defaults to `';'` if omitted.
- The `where` flag specifies an optional (where) query predicate to be included in the request. This predicate should be wrapped in single quotes ('single quoted predicate'). More info on predicates [here](https://docs.commercetools.com/http-api-query-predicates)
- The `where` flag specifies an optional (where) query predicate to be included in the request. This predicate should be wrapped in single quotes ('single quoted predicate'). More info on predicates [here](https://docs.commercetools.com/api/predicates/query)

### JS

Expand Down
2 changes: 1 addition & 1 deletion docs/cli/discount-code-importer.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Discount Code Importer

A package that helps with importing [commercetools discount codes](https://docs.commercetools.com/http-api-projects-discountCodes.html) in JSON format to the [commercetools platform](https://docs.commercetools.com/).
A package that helps with importing [commercetools discount codes](https://docs.commercetools.com/api/projects/discountCodes) in JSON format to the [commercetools platform](https://docs.commercetools.com/).
This package is built to be used in conjunction with [sphere-node-cli](https://github.com/sphereio/sphere-node-cli)

## Configuration
Expand Down
4 changes: 2 additions & 2 deletions docs/cli/inventories-exporter.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Inventories Exporter

This package helps in exporting [inventories](https://docs.commercetools.com/http-api-projects-inventory.html) from the commercetools platform in `csv` and `json` format
This package helps in exporting [inventories](https://docs.commercetools.com/api/projects/inventory) from the commercetools platform in `csv` and `json` format

## Configuration

Expand Down Expand Up @@ -43,7 +43,7 @@ Options:
Can be used with the query flag
--query, -q Filter query for stocks:
https://docs.commercetools.com/http-api-projects-inventory.html#query-inventory
https://docs.commercetools.com/api/projects/inventory#query-inventory
can be used with channelKey flag
--template, -t Path to a CSV template file with headers which should be
Expand Down
2 changes: 1 addition & 1 deletion docs/cli/personal-data-erasure.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The constructor accepts two arguments:

- A required object containing the following values:
- `apiConfig` (Object): `AuthMiddleware` options for authentication on the commercetools platform. (Required. See [here](https://commercetools.github.io/nodejs/sdk/api/sdkMiddlewareAuth.html#named-arguments-options))
- `accessToken` (String): [Access token] to be used to authenticate requests to API. Requires scope of [`view_products`, `manage_products`, `view_orders`, `manage_orders`, `view_payments`, `manage_payments`, `view_shopping_lists`, `manage_shopping_lists`, `view_customers`, `manage_customers`]. More info on how to get the access token [here](https://docs.commercetools.com/http-api-authorization.html#authorization-flows)
- `accessToken` (String): [Access token] to be used to authenticate requests to API. Requires scope of [`view_products`, `manage_products`, `view_orders`, `manage_orders`, `view_payments`, `manage_payments`, `view_shopping_lists`, `manage_shopping_lists`, `view_customers`, `manage_customers`]. More info on how to get the access token [here](https://docs.commercetools.com/api/authorization)
- An optional logger object having four functions (`info`, `warn`, `error` and `debug`)

## Usage
Expand Down
6 changes: 3 additions & 3 deletions docs/cli/price-exporter.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Price Exporter

A package that helps with exporting [commercetools price](https://docs.commercetools.com/http-api-projects-products.html#price) in `JSON` or `CSV` format from the [commercetools platform](https://docs.commercetools.com/).
A package that helps with exporting [commercetools price](https://docs.commercetools.com/api/types#price) in `JSON` or `CSV` format from the [commercetools platform](https://docs.commercetools.com/).

## Configuration

Expand All @@ -11,7 +11,7 @@ The constructor accepts two arguments:
- `accessToken` (String): Access token to be used to authenticate requests to API. Requires scope of [`view_orders`]
- `delimiter` (String): CSV delimiter (Optional. Default: `','`)
- `exportFormat` (String): Export format ['csv', 'json'] (Optional. Default: 'json')
- `predicate` (String): Query string specifying (where) predicate. More info on predicates [here](https://docs.commercetools.com/http-api-query-predicates) (Optional)
- `predicate` (String): Query string specifying (where) predicate. More info on predicates [here](https://docs.commercetools.com/api/predicates/query) (Optional)
- `staged` (Boolean): Specify if prices should be fetched from all products (true) or only published products (false) (Optional. Default: false)
- `csvHeaders` (Array<String>): Array containing headers for the returned CSV price data. If omitted, all headers will be turned. (Optional)
- An optional logger object having four functions (`info`, `warn`, `error` and `verbose`)
Expand Down Expand Up @@ -59,7 +59,7 @@ Options:
- The default location for status report logging is the standard output.
- If no output path is specified, the exported prices will be logged to the standard output.
- The `--delimiter` flag specifies the delimiter used in the input and output file if CSV. Defaults to `','` if omitted.
- The `where` flag specifies an optional (where) query predicate to be included in the request. This predicate is on the products containing the prices (`product-proections` endpoint) and not on the prices themselves. This predicate should be wrapped in single quotes ('single quoted predicate'). More info on predicates [here](https://docs.commercetools.com/http-api-query-predicates)
- The `where` flag specifies an optional (where) query predicate to be included in the request. This predicate is on the products containing the prices (`product-proections` endpoint) and not on the prices themselves. This predicate should be wrapped in single quotes ('single quoted predicate'). More info on predicates [here](https://docs.commercetools.com/api/predicates/query)
- The `--staged` flag specifies the projection of the products from which the prices should be fetched.
- If passed `true`, prices from published and unpublished products are retrieved
- If passed `false` (or omitted), only prices from published products are retrieved
Expand Down
Loading

0 comments on commit dec6e9b

Please sign in to comment.