Skip to content

Commit dec6e9b

Browse files
authored
Update broken links to commercetools docs (#1918)
* Test add change * Update links in docs * Minor changes
1 parent 1ed5196 commit dec6e9b

File tree

38 files changed

+75
-75
lines changed

38 files changed

+75
-75
lines changed

docs/cli/category-exporter.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
# Category Exporter
22

3-
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/).
3+
A package which exports [commercetools categories](https://docs.commercetools.com/api/projects/categories) in `JSON` format from the [commercetools platform](https://docs.commercetools.com/).
44

55
## Configuration
66

77
The constructor accepts two arguments:
88

99
- A required object containing the following values:
1010
- `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))
11-
- `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)
12-
- `predicate` (String): Query string specifying (where) predicate. More info on predicates [here](https://docs.commercetools.com/http-api-query-predicates) (Optional)
11+
- `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)
12+
- `predicate` (String): Query string specifying (where) predicate. More info on predicates [here](https://docs.commercetools.com/api/predicates/query) (Optional)
1313
- An optional logger object having four functions (`info`, `warn`, `error` and `debug`)
1414

1515
## Usage
@@ -47,7 +47,7 @@ Options:
4747
- If the file specified already exists, it will be overwritten.
4848
- The default location for status report logging is the standard output.
4949
- 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.
50-
- 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)
50+
- 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)
5151

5252
### JS
5353

docs/cli/csv-parser-discount-code.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# CSV Parser Discount Code
22

3-
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.
3+
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.
44

55
## Usage
66

docs/cli/csv-parser-orders.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
[![David Dependencies Status][david-icon]][david]
66
[![David devDependencies Status][david-dev-icon]][david-dev]
77

8-
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.
8+
Convert [commercetools order](https://docs.commercetools.com/api/projects/orders) CSV data to JSON. See examples below for supported CSV format and sample responses.
99

1010
## Usage
1111

docs/cli/csv-parser-price.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
[![David Dependencies Status][david-icon]][david]
66
[![David devDependencies Status][david-dev-icon]][david-dev]
77

8-
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
8+
Convert [commercetools price](https://docs.commercetools.com/api/types#price) CSV data to JSON. See example below for CSV format and sample response
99

1010
## Usage
1111

docs/cli/csv-parser-state.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# CSV Parser State
22

3-
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.
3+
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.
44

55
## Usage
66

docs/cli/custom-objects-exporter.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
# Custom Objects Exporter
22

3-
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/).
3+
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/).
44

55
## Configuration
66

77
The constructor accepts two arguments:
88

99
- A required object containing the following values:
1010
- `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))
11-
- `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)
12-
- `predicate` (String): Query string specifying (where) predicate. More info on predicates [here](https://docs.commercetools.com/http-api-query-predicates) (Optional)
11+
- `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)
12+
- `predicate` (String): Query string specifying (where) predicate. More info on predicates [here](https://docs.commercetools.com/api/predicates/query) (Optional)
1313
- An optional logger object having four functions (`info`, `warn`, `error` and `debug`)
1414

1515
## Usage
@@ -46,7 +46,7 @@ Options:
4646
- If the file specified already exists, it will be overwritten.
4747
- The default location for status report logging is the standard output.
4848
- 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.
49-
- 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)
49+
- 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)
5050

5151
### JS
5252

docs/cli/custom-objects-importer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Custom Objects Importer
22

3-
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/).
3+
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/).
44
The package is built to be used in conjunction with [sphere-node-cli](https://github.com/sphereio/sphere-node-cli)
55

66
## Configuration

docs/cli/customer-groups-exporter.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
# Customer Groups Exporter
22

3-
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/).
3+
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/).
44

55
## Configuration
66

77
The constructor accepts two arguments:
88

99
- A required object containing the following values:
1010
- `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))
11-
- `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)
12-
- `predicate` (String): Query string specifying (where) predicate. More info on predicates [here](https://docs.commercetools.com/http-api-query-predicates) (Optional)
11+
- `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)
12+
- `predicate` (String): Query string specifying (where) predicate. More info on predicates [here](https://docs.commercetools.com/api/predicates/query) (Optional)
1313
- An optional logger object having four functions (`info`, `warn`, `error` and `debug`)
1414

1515
## Usage
@@ -46,7 +46,7 @@ Options:
4646
- If the file specified already exists, it will be overwritten.
4747
- The default location for status report logging is the standard output.
4848
- 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.
49-
- 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)
49+
- 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)
5050

5151
### JS
5252

docs/cli/discount-code-exporter.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Discount Code Exporter
22

3-
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/).
3+
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/).
44

55
## Configuration
66

@@ -14,7 +14,7 @@ The constructor accepts two arguments:
1414
- `delimiter` (String): CSV delimiter (Optional. Default: `','`)
1515
- `multiValueDelimiter` (String): CSV delimiter used in multivalue fields (Optional. Default: `';'`)
1616
- `exportFormat` (String): Export format ['csv', 'json'] (Optional. Default: 'json')
17-
- `predicate` (String): Query string specifying (where) predicate. More info on predicates [here](https://docs.commercetools.com/http-api-query-predicates) (Optional)
17+
- `predicate` (String): Query string specifying (where) predicate. More info on predicates [here](https://docs.commercetools.com/api/predicates/query) (Optional)
1818
- `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`.
1919
The localised fields (`name` and `description` default to the language specified in the `language` value above.
2020
This is synonymous with the `--template` flag in the CLI)
@@ -66,7 +66,7 @@ Options:
6666
- 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.
6767
- The `--delimiter` flag specifies the delimiter used in the output file if CSV. Defaults to `','` if omitted.
6868
- The `--multiValueDelimiter` flag specifies the delimiter for multiValue cells in the output file if CSV. Defaults to `';'` if omitted.
69-
- 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)
69+
- 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)
7070

7171
### JS
7272

docs/cli/discount-code-importer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Discount Code Importer
22

3-
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/).
3+
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/).
44
This package is built to be used in conjunction with [sphere-node-cli](https://github.com/sphereio/sphere-node-cli)
55

66
## Configuration

0 commit comments

Comments
 (0)