@teemill/orders 1.30.4 → 1.31.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/api.ts +11 -7
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +11 -7
- package/dist/api.js +5 -5
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +11 -7
- package/dist/esm/api.js +5 -5
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/docs/OrdersApi.md +4 -4
- package/docs/OrdersListMetaFilters.md +2 -0
- package/index.ts +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @teemill/orders@1.
|
|
1
|
+
## @teemill/orders@1.31.0
|
|
2
2
|
|
|
3
3
|
This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
|
|
4
4
|
|
|
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
|
|
|
36
36
|
_published:_
|
|
37
37
|
|
|
38
38
|
```
|
|
39
|
-
npm install @teemill/orders@1.
|
|
39
|
+
npm install @teemill/orders@1.31.0 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
package/api.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Orders
|
|
5
5
|
* Use this API to create and retrieve updates for print-on-demand orders. Use it to request fulfillment for variants of products attached to the given project. You can fetch details and references to these products and variants from the Product Catalog API.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.
|
|
7
|
+
* The version of the OpenAPI document: 1.31.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -765,6 +765,10 @@ export interface OrdersListMetaFilters {
|
|
|
765
765
|
* When present, always lists `yes` and `no` — the only valid values for `vatRegistered:yes` and `vatRegistered:no` search tags. Omitted for projects where VAT registration filtering is not available.
|
|
766
766
|
*/
|
|
767
767
|
'vatRegistered'?: Array<VatRegisteredFilterOption>;
|
|
768
|
+
/**
|
|
769
|
+
* Source codes present on this project\'s orders (for example `shopify`, `etsy`). Use as `sources:<code>` search tags; only values listed here are valid for the current project. Omitted when the project has no orders with an source.
|
|
770
|
+
*/
|
|
771
|
+
'sources'?: Array<string>;
|
|
768
772
|
}
|
|
769
773
|
export interface OrdersResponse {
|
|
770
774
|
'orders': Array<Order>;
|
|
@@ -1263,7 +1267,7 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
1263
1267
|
* @param {string} project The project identifier to scope the request to.
|
|
1264
1268
|
* @param {string} start Start of the date range to filter by when orders were placed.
|
|
1265
1269
|
* @param {string} [end] End of date range filter. Which date field this applies to is controlled by the `dateFilterType` parameter.
|
|
1266
|
-
* @param {string} [search] Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid Combine both: `status:paid vatRegistered:yes smith@example.com`
|
|
1270
|
+
* @param {string} [search] Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid * `sources:<code>` — filter by order source (allowed values in `meta.filters.sources`) Combine both: `status:paid vatRegistered:yes sources:shopify smith@example.com`
|
|
1267
1271
|
* @param {ExportOrdersDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
1268
1272
|
* @param {*} [options] Override http request option.
|
|
1269
1273
|
* @throws {RequiredError}
|
|
@@ -1435,7 +1439,7 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
1435
1439
|
* @param {string} [fields] Specifies which fields to return, separated by commas
|
|
1436
1440
|
* @param {number} [pageToken] Page reference token
|
|
1437
1441
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1438
|
-
* @param {string} [search] Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid Combine both: `status:paid vatRegistered:yes smith@example.com`
|
|
1442
|
+
* @param {string} [search] Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid * `sources:<code>` — filter by order source (allowed values in `meta.filters.sources`) Combine both: `status:paid vatRegistered:yes sources:shopify smith@example.com`
|
|
1439
1443
|
* @param {Array<string>} [ids] Filter to specific order IDs. Only orders matching these IDs will be returned.
|
|
1440
1444
|
* @param {Array<Status>} [statuses] Filter by order status. Only orders matching one of the given statuses will be returned.
|
|
1441
1445
|
* @param {string} [start] Start of date range filter. Which date field this applies to is controlled by the `dateFilterType` parameter.
|
|
@@ -1815,7 +1819,7 @@ export const OrdersApiFp = function(configuration?: Configuration) {
|
|
|
1815
1819
|
* @param {string} project The project identifier to scope the request to.
|
|
1816
1820
|
* @param {string} start Start of the date range to filter by when orders were placed.
|
|
1817
1821
|
* @param {string} [end] End of date range filter. Which date field this applies to is controlled by the `dateFilterType` parameter.
|
|
1818
|
-
* @param {string} [search] Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid Combine both: `status:paid vatRegistered:yes smith@example.com`
|
|
1822
|
+
* @param {string} [search] Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid * `sources:<code>` — filter by order source (allowed values in `meta.filters.sources`) Combine both: `status:paid vatRegistered:yes sources:shopify smith@example.com`
|
|
1819
1823
|
* @param {ExportOrdersDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
1820
1824
|
* @param {*} [options] Override http request option.
|
|
1821
1825
|
* @throws {RequiredError}
|
|
@@ -1862,7 +1866,7 @@ export const OrdersApiFp = function(configuration?: Configuration) {
|
|
|
1862
1866
|
* @param {string} [fields] Specifies which fields to return, separated by commas
|
|
1863
1867
|
* @param {number} [pageToken] Page reference token
|
|
1864
1868
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1865
|
-
* @param {string} [search] Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid Combine both: `status:paid vatRegistered:yes smith@example.com`
|
|
1869
|
+
* @param {string} [search] Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid * `sources:<code>` — filter by order source (allowed values in `meta.filters.sources`) Combine both: `status:paid vatRegistered:yes sources:shopify smith@example.com`
|
|
1866
1870
|
* @param {Array<string>} [ids] Filter to specific order IDs. Only orders matching these IDs will be returned.
|
|
1867
1871
|
* @param {Array<Status>} [statuses] Filter by order status. Only orders matching one of the given statuses will be returned.
|
|
1868
1872
|
* @param {string} [start] Start of date range filter. Which date field this applies to is controlled by the `dateFilterType` parameter.
|
|
@@ -2169,7 +2173,7 @@ export interface OrdersApiExportOrdersRequest {
|
|
|
2169
2173
|
readonly end?: string
|
|
2170
2174
|
|
|
2171
2175
|
/**
|
|
2172
|
-
* Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid Combine both: `status:paid vatRegistered:yes smith@example.com`
|
|
2176
|
+
* Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid * `sources:<code>` — filter by order source (allowed values in `meta.filters.sources`) Combine both: `status:paid vatRegistered:yes sources:shopify smith@example.com`
|
|
2173
2177
|
*/
|
|
2174
2178
|
readonly search?: string
|
|
2175
2179
|
|
|
@@ -2239,7 +2243,7 @@ export interface OrdersApiGetOrdersRequest {
|
|
|
2239
2243
|
readonly pageSize?: number
|
|
2240
2244
|
|
|
2241
2245
|
/**
|
|
2242
|
-
* Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid Combine both: `status:paid vatRegistered:yes smith@example.com`
|
|
2246
|
+
* Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid * `sources:<code>` — filter by order source (allowed values in `meta.filters.sources`) Combine both: `status:paid vatRegistered:yes sources:shopify smith@example.com`
|
|
2243
2247
|
*/
|
|
2244
2248
|
readonly search?: string
|
|
2245
2249
|
|
package/base.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Orders
|
|
5
5
|
* Use this API to create and retrieve updates for print-on-demand orders. Use it to request fulfillment for variants of products attached to the given project. You can fetch details and references to these products and variants from the Product Catalog API.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.
|
|
7
|
+
* The version of the OpenAPI document: 1.31.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/common.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Orders
|
|
5
5
|
* Use this API to create and retrieve updates for print-on-demand orders. Use it to request fulfillment for variants of products attached to the given project. You can fetch details and references to these products and variants from the Product Catalog API.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.
|
|
7
|
+
* The version of the OpenAPI document: 1.31.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/configuration.ts
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
* Orders
|
|
4
4
|
* Use this API to create and retrieve updates for print-on-demand orders. Use it to request fulfillment for variants of products attached to the given project. You can fetch details and references to these products and variants from the Product Catalog API.
|
|
5
5
|
*
|
|
6
|
-
* The version of the OpenAPI document: 1.
|
|
6
|
+
* The version of the OpenAPI document: 1.31.0
|
|
7
7
|
*
|
|
8
8
|
*
|
|
9
9
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Orders
|
|
3
3
|
* Use this API to create and retrieve updates for print-on-demand orders. Use it to request fulfillment for variants of products attached to the given project. You can fetch details and references to these products and variants from the Product Catalog API.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.31.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -725,6 +725,10 @@ export interface OrdersListMetaFilters {
|
|
|
725
725
|
* When present, always lists `yes` and `no` — the only valid values for `vatRegistered:yes` and `vatRegistered:no` search tags. Omitted for projects where VAT registration filtering is not available.
|
|
726
726
|
*/
|
|
727
727
|
'vatRegistered'?: Array<VatRegisteredFilterOption>;
|
|
728
|
+
/**
|
|
729
|
+
* Source codes present on this project\'s orders (for example `shopify`, `etsy`). Use as `sources:<code>` search tags; only values listed here are valid for the current project. Omitted when the project has no orders with an source.
|
|
730
|
+
*/
|
|
731
|
+
'sources'?: Array<string>;
|
|
728
732
|
}
|
|
729
733
|
export interface OrdersResponse {
|
|
730
734
|
'orders': Array<Order>;
|
|
@@ -1030,7 +1034,7 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
1030
1034
|
* @param {string} project The project identifier to scope the request to.
|
|
1031
1035
|
* @param {string} start Start of the date range to filter by when orders were placed.
|
|
1032
1036
|
* @param {string} [end] End of date range filter. Which date field this applies to is controlled by the `dateFilterType` parameter.
|
|
1033
|
-
* @param {string} [search] Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid Combine both: `status:paid vatRegistered:yes smith@example.com`
|
|
1037
|
+
* @param {string} [search] Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid * `sources:<code>` — filter by order source (allowed values in `meta.filters.sources`) Combine both: `status:paid vatRegistered:yes sources:shopify smith@example.com`
|
|
1034
1038
|
* @param {ExportOrdersDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
1035
1039
|
* @param {*} [options] Override http request option.
|
|
1036
1040
|
* @throws {RequiredError}
|
|
@@ -1062,7 +1066,7 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
1062
1066
|
* @param {string} [fields] Specifies which fields to return, separated by commas
|
|
1063
1067
|
* @param {number} [pageToken] Page reference token
|
|
1064
1068
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1065
|
-
* @param {string} [search] Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid Combine both: `status:paid vatRegistered:yes smith@example.com`
|
|
1069
|
+
* @param {string} [search] Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid * `sources:<code>` — filter by order source (allowed values in `meta.filters.sources`) Combine both: `status:paid vatRegistered:yes sources:shopify smith@example.com`
|
|
1066
1070
|
* @param {Array<string>} [ids] Filter to specific order IDs. Only orders matching these IDs will be returned.
|
|
1067
1071
|
* @param {Array<Status>} [statuses] Filter by order status. Only orders matching one of the given statuses will be returned.
|
|
1068
1072
|
* @param {string} [start] Start of date range filter. Which date field this applies to is controlled by the `dateFilterType` parameter.
|
|
@@ -1163,7 +1167,7 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
|
1163
1167
|
* @param {string} project The project identifier to scope the request to.
|
|
1164
1168
|
* @param {string} start Start of the date range to filter by when orders were placed.
|
|
1165
1169
|
* @param {string} [end] End of date range filter. Which date field this applies to is controlled by the `dateFilterType` parameter.
|
|
1166
|
-
* @param {string} [search] Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid Combine both: `status:paid vatRegistered:yes smith@example.com`
|
|
1170
|
+
* @param {string} [search] Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid * `sources:<code>` — filter by order source (allowed values in `meta.filters.sources`) Combine both: `status:paid vatRegistered:yes sources:shopify smith@example.com`
|
|
1167
1171
|
* @param {ExportOrdersDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
1168
1172
|
* @param {*} [options] Override http request option.
|
|
1169
1173
|
* @throws {RequiredError}
|
|
@@ -1195,7 +1199,7 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
|
1195
1199
|
* @param {string} [fields] Specifies which fields to return, separated by commas
|
|
1196
1200
|
* @param {number} [pageToken] Page reference token
|
|
1197
1201
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1198
|
-
* @param {string} [search] Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid Combine both: `status:paid vatRegistered:yes smith@example.com`
|
|
1202
|
+
* @param {string} [search] Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid * `sources:<code>` — filter by order source (allowed values in `meta.filters.sources`) Combine both: `status:paid vatRegistered:yes sources:shopify smith@example.com`
|
|
1199
1203
|
* @param {Array<string>} [ids] Filter to specific order IDs. Only orders matching these IDs will be returned.
|
|
1200
1204
|
* @param {Array<Status>} [statuses] Filter by order status. Only orders matching one of the given statuses will be returned.
|
|
1201
1205
|
* @param {string} [start] Start of date range filter. Which date field this applies to is controlled by the `dateFilterType` parameter.
|
|
@@ -1432,7 +1436,7 @@ export interface OrdersApiExportOrdersRequest {
|
|
|
1432
1436
|
*/
|
|
1433
1437
|
readonly end?: string;
|
|
1434
1438
|
/**
|
|
1435
|
-
* Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid Combine both: `status:paid vatRegistered:yes smith@example.com`
|
|
1439
|
+
* Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid * `sources:<code>` — filter by order source (allowed values in `meta.filters.sources`) Combine both: `status:paid vatRegistered:yes sources:shopify smith@example.com`
|
|
1436
1440
|
*/
|
|
1437
1441
|
readonly search?: string;
|
|
1438
1442
|
/**
|
|
@@ -1491,7 +1495,7 @@ export interface OrdersApiGetOrdersRequest {
|
|
|
1491
1495
|
*/
|
|
1492
1496
|
readonly pageSize?: number;
|
|
1493
1497
|
/**
|
|
1494
|
-
* Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid Combine both: `status:paid vatRegistered:yes smith@example.com`
|
|
1498
|
+
* Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid * `sources:<code>` — filter by order source (allowed values in `meta.filters.sources`) Combine both: `status:paid vatRegistered:yes sources:shopify smith@example.com`
|
|
1495
1499
|
*/
|
|
1496
1500
|
readonly search?: string;
|
|
1497
1501
|
/**
|
package/dist/api.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Orders
|
|
6
6
|
* Use this API to create and retrieve updates for print-on-demand orders. Use it to request fulfillment for variants of products attached to the given project. You can fetch details and references to these products and variants from the Product Catalog API.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 1.
|
|
8
|
+
* The version of the OpenAPI document: 1.31.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -312,7 +312,7 @@ const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
312
312
|
* @param {string} project The project identifier to scope the request to.
|
|
313
313
|
* @param {string} start Start of the date range to filter by when orders were placed.
|
|
314
314
|
* @param {string} [end] End of date range filter. Which date field this applies to is controlled by the `dateFilterType` parameter.
|
|
315
|
-
* @param {string} [search] Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid Combine both: `status:paid vatRegistered:yes smith@example.com`
|
|
315
|
+
* @param {string} [search] Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid * `sources:<code>` — filter by order source (allowed values in `meta.filters.sources`) Combine both: `status:paid vatRegistered:yes sources:shopify smith@example.com`
|
|
316
316
|
* @param {ExportOrdersDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
317
317
|
* @param {*} [options] Override http request option.
|
|
318
318
|
* @throws {RequiredError}
|
|
@@ -458,7 +458,7 @@ const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
458
458
|
* @param {string} [fields] Specifies which fields to return, separated by commas
|
|
459
459
|
* @param {number} [pageToken] Page reference token
|
|
460
460
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
461
|
-
* @param {string} [search] Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid Combine both: `status:paid vatRegistered:yes smith@example.com`
|
|
461
|
+
* @param {string} [search] Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid * `sources:<code>` — filter by order source (allowed values in `meta.filters.sources`) Combine both: `status:paid vatRegistered:yes sources:shopify smith@example.com`
|
|
462
462
|
* @param {Array<string>} [ids] Filter to specific order IDs. Only orders matching these IDs will be returned.
|
|
463
463
|
* @param {Array<Status>} [statuses] Filter by order status. Only orders matching one of the given statuses will be returned.
|
|
464
464
|
* @param {string} [start] Start of date range filter. Which date field this applies to is controlled by the `dateFilterType` parameter.
|
|
@@ -800,7 +800,7 @@ const OrdersApiFp = function (configuration) {
|
|
|
800
800
|
* @param {string} project The project identifier to scope the request to.
|
|
801
801
|
* @param {string} start Start of the date range to filter by when orders were placed.
|
|
802
802
|
* @param {string} [end] End of date range filter. Which date field this applies to is controlled by the `dateFilterType` parameter.
|
|
803
|
-
* @param {string} [search] Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid Combine both: `status:paid vatRegistered:yes smith@example.com`
|
|
803
|
+
* @param {string} [search] Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid * `sources:<code>` — filter by order source (allowed values in `meta.filters.sources`) Combine both: `status:paid vatRegistered:yes sources:shopify smith@example.com`
|
|
804
804
|
* @param {ExportOrdersDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
805
805
|
* @param {*} [options] Override http request option.
|
|
806
806
|
* @throws {RequiredError}
|
|
@@ -856,7 +856,7 @@ const OrdersApiFp = function (configuration) {
|
|
|
856
856
|
* @param {string} [fields] Specifies which fields to return, separated by commas
|
|
857
857
|
* @param {number} [pageToken] Page reference token
|
|
858
858
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
859
|
-
* @param {string} [search] Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid Combine both: `status:paid vatRegistered:yes smith@example.com`
|
|
859
|
+
* @param {string} [search] Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid * `sources:<code>` — filter by order source (allowed values in `meta.filters.sources`) Combine both: `status:paid vatRegistered:yes sources:shopify smith@example.com`
|
|
860
860
|
* @param {Array<string>} [ids] Filter to specific order IDs. Only orders matching these IDs will be returned.
|
|
861
861
|
* @param {Array<Status>} [statuses] Filter by order status. Only orders matching one of the given statuses will be returned.
|
|
862
862
|
* @param {string} [start] Start of date range filter. Which date field this applies to is controlled by the `dateFilterType` parameter.
|
package/dist/base.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Orders
|
|
3
3
|
* Use this API to create and retrieve updates for print-on-demand orders. Use it to request fulfillment for variants of products attached to the given project. You can fetch details and references to these products and variants from the Product Catalog API.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.31.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/base.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Orders
|
|
6
6
|
* Use this API to create and retrieve updates for print-on-demand orders. Use it to request fulfillment for variants of products attached to the given project. You can fetch details and references to these products and variants from the Product Catalog API.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 1.
|
|
8
|
+
* The version of the OpenAPI document: 1.31.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/common.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Orders
|
|
3
3
|
* Use this API to create and retrieve updates for print-on-demand orders. Use it to request fulfillment for variants of products attached to the given project. You can fetch details and references to these products and variants from the Product Catalog API.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.31.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/common.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Orders
|
|
6
6
|
* Use this API to create and retrieve updates for print-on-demand orders. Use it to request fulfillment for variants of products attached to the given project. You can fetch details and references to these products and variants from the Product Catalog API.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 1.
|
|
8
|
+
* The version of the OpenAPI document: 1.31.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/configuration.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Orders
|
|
3
3
|
* Use this API to create and retrieve updates for print-on-demand orders. Use it to request fulfillment for variants of products attached to the given project. You can fetch details and references to these products and variants from the Product Catalog API.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.31.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/configuration.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Orders
|
|
5
5
|
* Use this API to create and retrieve updates for print-on-demand orders. Use it to request fulfillment for variants of products attached to the given project. You can fetch details and references to these products and variants from the Product Catalog API.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.
|
|
7
|
+
* The version of the OpenAPI document: 1.31.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Orders
|
|
3
3
|
* Use this API to create and retrieve updates for print-on-demand orders. Use it to request fulfillment for variants of products attached to the given project. You can fetch details and references to these products and variants from the Product Catalog API.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.31.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -725,6 +725,10 @@ export interface OrdersListMetaFilters {
|
|
|
725
725
|
* When present, always lists `yes` and `no` — the only valid values for `vatRegistered:yes` and `vatRegistered:no` search tags. Omitted for projects where VAT registration filtering is not available.
|
|
726
726
|
*/
|
|
727
727
|
'vatRegistered'?: Array<VatRegisteredFilterOption>;
|
|
728
|
+
/**
|
|
729
|
+
* Source codes present on this project\'s orders (for example `shopify`, `etsy`). Use as `sources:<code>` search tags; only values listed here are valid for the current project. Omitted when the project has no orders with an source.
|
|
730
|
+
*/
|
|
731
|
+
'sources'?: Array<string>;
|
|
728
732
|
}
|
|
729
733
|
export interface OrdersResponse {
|
|
730
734
|
'orders': Array<Order>;
|
|
@@ -1030,7 +1034,7 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
1030
1034
|
* @param {string} project The project identifier to scope the request to.
|
|
1031
1035
|
* @param {string} start Start of the date range to filter by when orders were placed.
|
|
1032
1036
|
* @param {string} [end] End of date range filter. Which date field this applies to is controlled by the `dateFilterType` parameter.
|
|
1033
|
-
* @param {string} [search] Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid Combine both: `status:paid vatRegistered:yes smith@example.com`
|
|
1037
|
+
* @param {string} [search] Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid * `sources:<code>` — filter by order source (allowed values in `meta.filters.sources`) Combine both: `status:paid vatRegistered:yes sources:shopify smith@example.com`
|
|
1034
1038
|
* @param {ExportOrdersDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
1035
1039
|
* @param {*} [options] Override http request option.
|
|
1036
1040
|
* @throws {RequiredError}
|
|
@@ -1062,7 +1066,7 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
1062
1066
|
* @param {string} [fields] Specifies which fields to return, separated by commas
|
|
1063
1067
|
* @param {number} [pageToken] Page reference token
|
|
1064
1068
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1065
|
-
* @param {string} [search] Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid Combine both: `status:paid vatRegistered:yes smith@example.com`
|
|
1069
|
+
* @param {string} [search] Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid * `sources:<code>` — filter by order source (allowed values in `meta.filters.sources`) Combine both: `status:paid vatRegistered:yes sources:shopify smith@example.com`
|
|
1066
1070
|
* @param {Array<string>} [ids] Filter to specific order IDs. Only orders matching these IDs will be returned.
|
|
1067
1071
|
* @param {Array<Status>} [statuses] Filter by order status. Only orders matching one of the given statuses will be returned.
|
|
1068
1072
|
* @param {string} [start] Start of date range filter. Which date field this applies to is controlled by the `dateFilterType` parameter.
|
|
@@ -1163,7 +1167,7 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
|
1163
1167
|
* @param {string} project The project identifier to scope the request to.
|
|
1164
1168
|
* @param {string} start Start of the date range to filter by when orders were placed.
|
|
1165
1169
|
* @param {string} [end] End of date range filter. Which date field this applies to is controlled by the `dateFilterType` parameter.
|
|
1166
|
-
* @param {string} [search] Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid Combine both: `status:paid vatRegistered:yes smith@example.com`
|
|
1170
|
+
* @param {string} [search] Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid * `sources:<code>` — filter by order source (allowed values in `meta.filters.sources`) Combine both: `status:paid vatRegistered:yes sources:shopify smith@example.com`
|
|
1167
1171
|
* @param {ExportOrdersDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
1168
1172
|
* @param {*} [options] Override http request option.
|
|
1169
1173
|
* @throws {RequiredError}
|
|
@@ -1195,7 +1199,7 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
|
1195
1199
|
* @param {string} [fields] Specifies which fields to return, separated by commas
|
|
1196
1200
|
* @param {number} [pageToken] Page reference token
|
|
1197
1201
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1198
|
-
* @param {string} [search] Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid Combine both: `status:paid vatRegistered:yes smith@example.com`
|
|
1202
|
+
* @param {string} [search] Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid * `sources:<code>` — filter by order source (allowed values in `meta.filters.sources`) Combine both: `status:paid vatRegistered:yes sources:shopify smith@example.com`
|
|
1199
1203
|
* @param {Array<string>} [ids] Filter to specific order IDs. Only orders matching these IDs will be returned.
|
|
1200
1204
|
* @param {Array<Status>} [statuses] Filter by order status. Only orders matching one of the given statuses will be returned.
|
|
1201
1205
|
* @param {string} [start] Start of date range filter. Which date field this applies to is controlled by the `dateFilterType` parameter.
|
|
@@ -1432,7 +1436,7 @@ export interface OrdersApiExportOrdersRequest {
|
|
|
1432
1436
|
*/
|
|
1433
1437
|
readonly end?: string;
|
|
1434
1438
|
/**
|
|
1435
|
-
* Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid Combine both: `status:paid vatRegistered:yes smith@example.com`
|
|
1439
|
+
* Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid * `sources:<code>` — filter by order source (allowed values in `meta.filters.sources`) Combine both: `status:paid vatRegistered:yes sources:shopify smith@example.com`
|
|
1436
1440
|
*/
|
|
1437
1441
|
readonly search?: string;
|
|
1438
1442
|
/**
|
|
@@ -1491,7 +1495,7 @@ export interface OrdersApiGetOrdersRequest {
|
|
|
1491
1495
|
*/
|
|
1492
1496
|
readonly pageSize?: number;
|
|
1493
1497
|
/**
|
|
1494
|
-
* Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid Combine both: `status:paid vatRegistered:yes smith@example.com`
|
|
1498
|
+
* Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid * `sources:<code>` — filter by order source (allowed values in `meta.filters.sources`) Combine both: `status:paid vatRegistered:yes sources:shopify smith@example.com`
|
|
1495
1499
|
*/
|
|
1496
1500
|
readonly search?: string;
|
|
1497
1501
|
/**
|
package/dist/esm/api.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Orders
|
|
5
5
|
* Use this API to create and retrieve updates for print-on-demand orders. Use it to request fulfillment for variants of products attached to the given project. You can fetch details and references to these products and variants from the Product Catalog API.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.
|
|
7
|
+
* The version of the OpenAPI document: 1.31.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -309,7 +309,7 @@ export const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
309
309
|
* @param {string} project The project identifier to scope the request to.
|
|
310
310
|
* @param {string} start Start of the date range to filter by when orders were placed.
|
|
311
311
|
* @param {string} [end] End of date range filter. Which date field this applies to is controlled by the `dateFilterType` parameter.
|
|
312
|
-
* @param {string} [search] Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid Combine both: `status:paid vatRegistered:yes smith@example.com`
|
|
312
|
+
* @param {string} [search] Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid * `sources:<code>` — filter by order source (allowed values in `meta.filters.sources`) Combine both: `status:paid vatRegistered:yes sources:shopify smith@example.com`
|
|
313
313
|
* @param {ExportOrdersDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
314
314
|
* @param {*} [options] Override http request option.
|
|
315
315
|
* @throws {RequiredError}
|
|
@@ -455,7 +455,7 @@ export const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
455
455
|
* @param {string} [fields] Specifies which fields to return, separated by commas
|
|
456
456
|
* @param {number} [pageToken] Page reference token
|
|
457
457
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
458
|
-
* @param {string} [search] Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid Combine both: `status:paid vatRegistered:yes smith@example.com`
|
|
458
|
+
* @param {string} [search] Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid * `sources:<code>` — filter by order source (allowed values in `meta.filters.sources`) Combine both: `status:paid vatRegistered:yes sources:shopify smith@example.com`
|
|
459
459
|
* @param {Array<string>} [ids] Filter to specific order IDs. Only orders matching these IDs will be returned.
|
|
460
460
|
* @param {Array<Status>} [statuses] Filter by order status. Only orders matching one of the given statuses will be returned.
|
|
461
461
|
* @param {string} [start] Start of date range filter. Which date field this applies to is controlled by the `dateFilterType` parameter.
|
|
@@ -796,7 +796,7 @@ export const OrdersApiFp = function (configuration) {
|
|
|
796
796
|
* @param {string} project The project identifier to scope the request to.
|
|
797
797
|
* @param {string} start Start of the date range to filter by when orders were placed.
|
|
798
798
|
* @param {string} [end] End of date range filter. Which date field this applies to is controlled by the `dateFilterType` parameter.
|
|
799
|
-
* @param {string} [search] Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid Combine both: `status:paid vatRegistered:yes smith@example.com`
|
|
799
|
+
* @param {string} [search] Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid * `sources:<code>` — filter by order source (allowed values in `meta.filters.sources`) Combine both: `status:paid vatRegistered:yes sources:shopify smith@example.com`
|
|
800
800
|
* @param {ExportOrdersDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
801
801
|
* @param {*} [options] Override http request option.
|
|
802
802
|
* @throws {RequiredError}
|
|
@@ -852,7 +852,7 @@ export const OrdersApiFp = function (configuration) {
|
|
|
852
852
|
* @param {string} [fields] Specifies which fields to return, separated by commas
|
|
853
853
|
* @param {number} [pageToken] Page reference token
|
|
854
854
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
855
|
-
* @param {string} [search] Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid Combine both: `status:paid vatRegistered:yes smith@example.com`
|
|
855
|
+
* @param {string} [search] Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid * `sources:<code>` — filter by order source (allowed values in `meta.filters.sources`) Combine both: `status:paid vatRegistered:yes sources:shopify smith@example.com`
|
|
856
856
|
* @param {Array<string>} [ids] Filter to specific order IDs. Only orders matching these IDs will be returned.
|
|
857
857
|
* @param {Array<Status>} [statuses] Filter by order status. Only orders matching one of the given statuses will be returned.
|
|
858
858
|
* @param {string} [start] Start of date range filter. Which date field this applies to is controlled by the `dateFilterType` parameter.
|
package/dist/esm/base.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Orders
|
|
3
3
|
* Use this API to create and retrieve updates for print-on-demand orders. Use it to request fulfillment for variants of products attached to the given project. You can fetch details and references to these products and variants from the Product Catalog API.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.31.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/base.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Orders
|
|
5
5
|
* Use this API to create and retrieve updates for print-on-demand orders. Use it to request fulfillment for variants of products attached to the given project. You can fetch details and references to these products and variants from the Product Catalog API.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.
|
|
7
|
+
* The version of the OpenAPI document: 1.31.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/common.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Orders
|
|
3
3
|
* Use this API to create and retrieve updates for print-on-demand orders. Use it to request fulfillment for variants of products attached to the given project. You can fetch details and references to these products and variants from the Product Catalog API.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.31.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/common.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Orders
|
|
5
5
|
* Use this API to create and retrieve updates for print-on-demand orders. Use it to request fulfillment for variants of products attached to the given project. You can fetch details and references to these products and variants from the Product Catalog API.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.
|
|
7
|
+
* The version of the OpenAPI document: 1.31.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Orders
|
|
3
3
|
* Use this API to create and retrieve updates for print-on-demand orders. Use it to request fulfillment for variants of products attached to the given project. You can fetch details and references to these products and variants from the Product Catalog API.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.31.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
* Orders
|
|
4
4
|
* Use this API to create and retrieve updates for print-on-demand orders. Use it to request fulfillment for variants of products attached to the given project. You can fetch details and references to these products and variants from the Product Catalog API.
|
|
5
5
|
*
|
|
6
|
-
* The version of the OpenAPI document: 1.
|
|
6
|
+
* The version of the OpenAPI document: 1.31.0
|
|
7
7
|
*
|
|
8
8
|
*
|
|
9
9
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/index.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Orders
|
|
3
3
|
* Use this API to create and retrieve updates for print-on-demand orders. Use it to request fulfillment for variants of products attached to the given project. You can fetch details and references to these products and variants from the Product Catalog API.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.31.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/index.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Orders
|
|
5
5
|
* Use this API to create and retrieve updates for print-on-demand orders. Use it to request fulfillment for variants of products attached to the given project. You can fetch details and references to these products and variants from the Product Catalog API.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.
|
|
7
|
+
* The version of the OpenAPI document: 1.31.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/index.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Orders
|
|
3
3
|
* Use this API to create and retrieve updates for print-on-demand orders. Use it to request fulfillment for variants of products attached to the given project. You can fetch details and references to these products and variants from the Product Catalog API.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.31.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/index.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Orders
|
|
6
6
|
* Use this API to create and retrieve updates for print-on-demand orders. Use it to request fulfillment for variants of products attached to the given project. You can fetch details and references to these products and variants from the Product Catalog API.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 1.
|
|
8
|
+
* The version of the OpenAPI document: 1.31.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/docs/OrdersApi.md
CHANGED
|
@@ -285,7 +285,7 @@ const apiInstance = new OrdersApi(configuration);
|
|
|
285
285
|
let project: string; //The project identifier to scope the request to. (default to undefined)
|
|
286
286
|
let start: string; //Start of the date range to filter by when orders were placed. (default to undefined)
|
|
287
287
|
let end: string; //End of date range filter. Which date field this applies to is controlled by the `dateFilterType` parameter. (optional) (default to undefined)
|
|
288
|
-
let search: string; //Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid Combine both: `status:paid vatRegistered:yes smith@example.com` (optional) (default to undefined)
|
|
288
|
+
let search: string; //Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid * `sources:<code>` — filter by order source (allowed values in `meta.filters.sources`) Combine both: `status:paid vatRegistered:yes sources:shopify smith@example.com` (optional) (default to undefined)
|
|
289
289
|
let dateFilterType: 'createdAt' | 'updatedAt' | 'paidAt' | 'statusChangedAt' | 'completedAt' | 'refundedAt' | 'quoteAt'; //Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query. (optional) (default to 'createdAt')
|
|
290
290
|
|
|
291
291
|
const { status, data } = await apiInstance.exportOrders(
|
|
@@ -304,7 +304,7 @@ const { status, data } = await apiInstance.exportOrders(
|
|
|
304
304
|
| **project** | [**string**] | The project identifier to scope the request to. | defaults to undefined|
|
|
305
305
|
| **start** | [**string**] | Start of the date range to filter by when orders were placed. | defaults to undefined|
|
|
306
306
|
| **end** | [**string**] | End of date range filter. Which date field this applies to is controlled by the `dateFilterType` parameter. | (optional) defaults to undefined|
|
|
307
|
-
| **search** | [**string**] | Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid Combine both: `status:paid vatRegistered:yes smith@example.com` | (optional) defaults to undefined|
|
|
307
|
+
| **search** | [**string**] | Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid * `sources:<code>` — filter by order source (allowed values in `meta.filters.sources`) Combine both: `status:paid vatRegistered:yes sources:shopify smith@example.com` | (optional) defaults to undefined|
|
|
308
308
|
| **dateFilterType** | [**'createdAt' | 'updatedAt' | 'paidAt' | 'statusChangedAt' | 'completedAt' | 'refundedAt' | 'quoteAt'**]**Array<'createdAt' | 'updatedAt' | 'paidAt' | 'statusChangedAt' | 'completedAt' | 'refundedAt' | 'quoteAt'>** | Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query. | (optional) defaults to 'createdAt'|
|
|
309
309
|
|
|
310
310
|
|
|
@@ -476,7 +476,7 @@ let project: string; //The project identifier to scope the request to. (default
|
|
|
476
476
|
let fields: string; //Specifies which fields to return, separated by commas (optional) (default to undefined)
|
|
477
477
|
let pageToken: number; //Page reference token (optional) (default to 1)
|
|
478
478
|
let pageSize: number; //Max page size. This is the maximum page size that will be returned, but it might be smaller. (optional) (default to 100)
|
|
479
|
-
let search: string; //Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid Combine both: `status:paid vatRegistered:yes smith@example.com` (optional) (default to undefined)
|
|
479
|
+
let search: string; //Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid * `sources:<code>` — filter by order source (allowed values in `meta.filters.sources`) Combine both: `status:paid vatRegistered:yes sources:shopify smith@example.com` (optional) (default to undefined)
|
|
480
480
|
let ids: Array<string>; //Filter to specific order IDs. Only orders matching these IDs will be returned. (optional) (default to undefined)
|
|
481
481
|
let statuses: Array<Status>; //Filter by order status. Only orders matching one of the given statuses will be returned. (optional) (default to undefined)
|
|
482
482
|
let start: string; //Start of date range filter. Which date field this applies to is controlled by the `dateFilterType` parameter. (optional) (default to undefined)
|
|
@@ -505,7 +505,7 @@ const { status, data } = await apiInstance.getOrders(
|
|
|
505
505
|
| **fields** | [**string**] | Specifies which fields to return, separated by commas | (optional) defaults to undefined|
|
|
506
506
|
| **pageToken** | [**number**] | Page reference token | (optional) defaults to 1|
|
|
507
507
|
| **pageSize** | [**number**] | Max page size. This is the maximum page size that will be returned, but it might be smaller. | (optional) defaults to 100|
|
|
508
|
-
| **search** | [**string**] | Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid Combine both: `status:paid vatRegistered:yes smith@example.com` | (optional) defaults to undefined|
|
|
508
|
+
| **search** | [**string**] | Search expression for listing orders. Supports free text and structured filter tags in the same string. **Free text** — words without a `key:value` shape match order reference, customer name, and email. **Filter tags** — use `key:value` tokens (space-separated). Available filters and allowed values are returned on each list response in `meta.filters`; only keys present there are valid for your project. * `status:<code>` — filter by order status (allowed values in `meta.filters.status`) * `vatRegistered:<yes|no>` — filter by whether a billing VAT number was provided; only `vatRegistered:yes` and `vatRegistered:no` are valid * `sources:<code>` — filter by order source (allowed values in `meta.filters.sources`) Combine both: `status:paid vatRegistered:yes sources:shopify smith@example.com` | (optional) defaults to undefined|
|
|
509
509
|
| **ids** | **Array<string>** | Filter to specific order IDs. Only orders matching these IDs will be returned. | (optional) defaults to undefined|
|
|
510
510
|
| **statuses** | **Array<Status>** | Filter by order status. Only orders matching one of the given statuses will be returned. | (optional) defaults to undefined|
|
|
511
511
|
| **start** | [**string**] | Start of date range filter. Which date field this applies to is controlled by the `dateFilterType` parameter. | (optional) defaults to undefined|
|
|
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
9
|
**status** | [**Array<Status>**](Status.md) | Project-specific subset of the `Status` enum. Use as `status:<code>` search tags; only values listed here are valid for the current project. | [optional] [default to undefined]
|
|
10
10
|
**vatRegistered** | [**Array<VatRegisteredFilterOption>**](VatRegisteredFilterOption.md) | When present, always lists `yes` and `no` — the only valid values for `vatRegistered:yes` and `vatRegistered:no` search tags. Omitted for projects where VAT registration filtering is not available. | [optional] [default to undefined]
|
|
11
|
+
**sources** | **Array<string>** | Source codes present on this project\'s orders (for example `shopify`, `etsy`). Use as `sources:<code>` search tags; only values listed here are valid for the current project. Omitted when the project has no orders with an source. | [optional] [default to undefined]
|
|
11
12
|
|
|
12
13
|
## Example
|
|
13
14
|
|
|
@@ -17,6 +18,7 @@ import { OrdersListMetaFilters } from '@teemill/orders';
|
|
|
17
18
|
const instance: OrdersListMetaFilters = {
|
|
18
19
|
status,
|
|
19
20
|
vatRegistered,
|
|
21
|
+
sources,
|
|
20
22
|
};
|
|
21
23
|
```
|
|
22
24
|
|
package/index.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Orders
|
|
5
5
|
* Use this API to create and retrieve updates for print-on-demand orders. Use it to request fulfillment for variants of products attached to the given project. You can fetch details and references to these products and variants from the Product Catalog API.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.
|
|
7
|
+
* The version of the OpenAPI document: 1.31.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|