Skip to content

Commit f94d2f4

Browse files
bc-traciporterbc-traciporter
authored
DEVDOCS-5953: [update] add date created and date modified query parameters (#322)
<!-- Ticket number or summary of work --> # [DEVDOCS-5953] ## What changed? add date created and date modified query parameters ## Release notes draft <!-- Provide an entry for the release notes using simple, conversational language. Don't be too technical. Explain how the change will benefit the merchant and link to the feature. Examples: * The newly-released [X feature] is now available to use. Now, you’ll be able to [perform Y action]. * We're happy to announce [X feature], which can help you [perform Y action]. * [X feature] helps you to create [Y response] using the [Z query parameter]. Now, you can deliver [ex, localized shopping experiences for your customers]. * Fixed a bug in the [X endpoint]. Now the [Y field] will appear when you click [Z option]. --> * ## Anything else? <!-- Add related PRs, salient notes, additional ticket numbers, etc. --> ping {names} [DEVDOCS-5953]: https://bigcommercecloud.atlassian.net/browse/DEVDOCS-5953?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ
1 parent 1350955 commit f94d2f4

8 files changed

+271
-27
lines changed

‎reference/carts.v3.yml

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1056,6 +1056,10 @@ paths:
10561056
- $ref: '#/components/parameters/MetafieldNamespaceInParam'
10571057
- $ref: '#/components/parameters/DirectionParam'
10581058
- $ref: '#/components/parameters/IncludeFieldsParamMetafields'
1059+
- $ref: '#/components/parameters/date_modified_min'
1060+
- $ref: '#/components/parameters/date_modified_max'
1061+
- $ref: '#/components/parameters/date_created_min'
1062+
- $ref: '#/components/parameters/date_created_max'
10591063
post:
10601064
summary: Create multiple Metafields
10611065
tags:
@@ -3818,6 +3822,38 @@ components:
38183822
in: query
38193823
schema:
38203824
type: integer
3825+
date_created_min:
3826+
name: 'date_created:min'
3827+
description: |
3828+
'Query parameter that lets you filter by the minimum date created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields created after this date.'
3829+
required: false
3830+
in: query
3831+
schema:
3832+
type: string
3833+
date_created_max:
3834+
name: 'date_created:max'
3835+
description: |
3836+
'Query parameter that lets you filter by the maximum date created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields created before this date.'
3837+
required: false
3838+
in: query
3839+
schema:
3840+
type: string
3841+
date_modified_max:
3842+
name: 'date_modified:max'
3843+
description: |
3844+
'Query parameter that lets you filter by the maximum date modified created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields modified before this date.'
3845+
required: false
3846+
in: query
3847+
schema:
3848+
type: string
3849+
date_modified_min:
3850+
name: 'date_modified:min'
3851+
description: |
3852+
'Query parameter that lets you filter by the minimum date modified created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields modified after this date.'
3853+
required: false
3854+
in: query
3855+
schema:
3856+
type: string
38213857
DirectionParam:
38223858
name: direction
38233859
description: |

‎reference/catalog/brands_catalog.v3.yml

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2431,6 +2431,38 @@ components:
24312431
type: array
24322432
items:
24332433
type: string
2434+
date_created_min:
2435+
name: 'date_created:min'
2436+
description: |
2437+
'Query parameter that lets you filter by the minimum date created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields created after this date.'
2438+
required: false
2439+
in: query
2440+
schema:
2441+
type: string
2442+
date_created_max:
2443+
name: 'date_created:max'
2444+
description: |
2445+
'Query parameter that lets you filter by the maximum date created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields created before this date.'
2446+
required: false
2447+
in: query
2448+
schema:
2449+
type: string
2450+
date_modified_max:
2451+
name: 'date_modified:max'
2452+
description: |
2453+
'Query parameter that lets you filter by the maximum date modified created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields modified before this date.'
2454+
required: false
2455+
in: query
2456+
schema:
2457+
type: string
2458+
date_modified_min:
2459+
name: 'date_modified:min'
2460+
description: |
2461+
'Query parameter that lets you filter by the minimum date modified created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields modified after this date.'
2462+
required: false
2463+
in: query
2464+
schema:
2465+
type: string
24342466
DirectionParam:
24352467
name: direction
24362468
description: |

‎reference/catalog/categories_catalog.v3.yml

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1547,6 +1547,10 @@ paths:
15471547
- $ref: '#/components/parameters/MetafieldNamespaceInParam'
15481548
- $ref: '#/components/parameters/DirectionParam'
15491549
- $ref: '#/components/parameters/IncludeFieldsParamMetafields'
1550+
- $ref: '#/components/parameters/date_modified_min'
1551+
- $ref: '#/components/parameters/date_modified_max'
1552+
- $ref: '#/components/parameters/date_created_min'
1553+
- $ref: '#/components/parameters/date_created_max'
15501554
post:
15511555
summary: Create multiple Metafields
15521556
tags:
@@ -2820,6 +2824,38 @@ components:
28202824
enum:
28212825
- asc
28222826
- desc
2827+
date_created_min:
2828+
name: 'date_created:min'
2829+
description: |
2830+
'Query parameter that lets you filter by the minimum date created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields created after this date.'
2831+
required: false
2832+
in: query
2833+
schema:
2834+
type: string
2835+
date_created_max:
2836+
name: 'date_created:max'
2837+
description: |
2838+
'Query parameter that lets you filter by the maximum date created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields created before this date.'
2839+
required: false
2840+
in: query
2841+
schema:
2842+
type: string
2843+
date_modified_max:
2844+
name: 'date_modified:max'
2845+
description: |
2846+
'Query parameter that lets you filter by the maximum date modified created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields modified before this date.'
2847+
required: false
2848+
in: query
2849+
schema:
2850+
type: string
2851+
date_modified_min:
2852+
name: 'date_modified:min'
2853+
description: |
2854+
'Query parameter that lets you filter by the minimum date modified created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields modified after this date.'
2855+
required: false
2856+
in: query
2857+
schema:
2858+
type: string
28232859
IncludeFieldsParam:
28242860
name: include_fields
28252861
in: query

‎reference/catalog/product-variants_catalog.v3.yml

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1677,6 +1677,10 @@ paths:
16771677
- $ref: '#/components/parameters/MetafieldNamespaceInParam'
16781678
- $ref: '#/components/parameters/DirectionParam'
16791679
- $ref: '#/components/parameters/IncludeFieldsParamMetafields'
1680+
- $ref: '#/components/parameters/date_created_min'
1681+
- $ref: '#/components/parameters/date_created_max'
1682+
- $ref: '#/components/parameters/date_modified_min'
1683+
- $ref: '#/components/parameters/date_modified_max'
16801684
post:
16811685
summary: Create multiple Metafields
16821686
tags:
@@ -3032,6 +3036,38 @@ components:
30323036
enum:
30333037
- asc
30343038
- desc
3039+
date_created_min:
3040+
name: 'date_created:min'
3041+
description: |
3042+
'Query parameter that lets you filter by the minimum date created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields created after this date.'
3043+
required: false
3044+
in: query
3045+
schema:
3046+
type: string
3047+
date_created_max:
3048+
name: 'date_created:max'
3049+
description: |
3050+
'Query parameter that lets you filter by the maximum date created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields created before this date.'
3051+
required: false
3052+
in: query
3053+
schema:
3054+
type: string
3055+
date_modified_max:
3056+
name: 'date_modified:max'
3057+
description: |
3058+
'Query parameter that lets you filter by the maximum date modified, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields modified before this date.'
3059+
required: false
3060+
in: query
3061+
schema:
3062+
type: string
3063+
date_modified_min:
3064+
name: 'date_modified:min'
3065+
description: |
3066+
'Query parameter that lets you filter by the minimum date modified, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields modified after this date.'
3067+
required: false
3068+
in: query
3069+
schema:
3070+
type: string
30353071
IncludeFieldsParam:
30363072
name: include_fields
30373073
in: query

‎reference/catalog/products_catalog.v3.yml

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4930,6 +4930,10 @@ paths:
49304930
- $ref: '#/components/parameters/MetafieldNamespaceInParam'
49314931
- $ref: '#/components/parameters/DirectionParam'
49324932
- $ref: '#/components/parameters/IncludeFieldsParamMetafields'
4933+
- $ref: '#/components/parameters/date_modified_min'
4934+
- $ref: '#/components/parameters/date_modified_max'
4935+
- $ref: '#/components/parameters/date_created_min'
4936+
- $ref: '#/components/parameters/date_created_max'
49334937
post:
49344938
summary: Create multiple Metafields
49354939
tags:
@@ -8758,6 +8762,38 @@ components:
87588762
type: integer
87598763
default: 50
87608764
maximum: 250
8765+
date_created_min:
8766+
name: 'date_created:min'
8767+
description: |
8768+
'Query parameter that lets you filter by the minimum date created, ffor example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields created after this date.'
8769+
required: false
8770+
in: query
8771+
schema:
8772+
type: string
8773+
date_created_max:
8774+
name: 'date_created:max'
8775+
description: |
8776+
'Query parameter that lets you filter by the maximum date created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields created before this date.'
8777+
required: false
8778+
in: query
8779+
schema:
8780+
type: string
8781+
date_modified_max:
8782+
name: 'date_modified:max'
8783+
description: |
8784+
'Query parameter that lets you filter by the maximum date modified created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields modified before this date.'
8785+
required: false
8786+
in: query
8787+
schema:
8788+
type: string
8789+
date_modified_min:
8790+
name: 'date_modified:min'
8791+
description: |
8792+
'Query parameter that lets you filter by the minimum date modified created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields modified after this date.'
8793+
required: false
8794+
in: query
8795+
schema:
8796+
type: string
87618797
DirectionParam:
87628798
name: direction
87638799
description: |

‎reference/channels.v3.yml

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -886,6 +886,10 @@ paths:
886886
- $ref: '#/components/parameters/MetafieldNamespaceInParam'
887887
- $ref: '#/components/parameters/DirectionParam'
888888
- $ref: '#/components/parameters/IncludeFieldsParamMetafields'
889+
- $ref: '#/components/parameters/date_modified_min'
890+
- $ref: '#/components/parameters/date_modified_max'
891+
- $ref: '#/components/parameters/date_created_min'
892+
- $ref: '#/components/parameters/date_created_max'
889893
post:
890894
summary: Create multiple Metafields
891895
tags:
@@ -1222,42 +1226,42 @@ components:
12221226
- 'facebook by meta,amazon'
12231227
date_created:
12241228
name: date_created
1225-
description: 'Filter items by date_created. For example, `date_created=2019-09-04T00:00:00`, `date_created=2019-09-04`, or `date_created=1567573200`'
1229+
description: 'Filter items by date created. For example, `date_created=2024-05-14T09:34:00` or `date_created=2024-05-14`.'
12261230
in: query
12271231
required: false
12281232
schema:
12291233
type: string
12301234
date_created_min:
12311235
name: 'date_created:min'
1232-
description: 'Filter items by minimum date_created. For example, `date_created:min=2019-09-04T00:00:00`, `date_created:min=2019-09-04`, or `date_created:min=1567573200`'
1236+
description: 'Filter items by minimum date created. For example, `date_created=2024-05-14T09:34:00` or `date_created=2024-05-14`. Returns metafields created after this date.'
12331237
in: query
12341238
required: false
12351239
schema:
12361240
type: string
12371241
date_created_max:
12381242
name: 'date_created:max'
1239-
description: 'Filter items by maximum date_created. For example, `date_created:max=2019-09-04T00:00:00`, `date_created:max=2019-09-04`, or `date_created:max=1567573200`'
1243+
description: 'Filter items by maximum date created. For example, `date_created=2024-05-14T09:34:00` or `date_created=2024-05-14`. Returns metafields created before this date.'
12401244
in: query
12411245
required: false
12421246
schema:
12431247
type: string
12441248
date_modified:
12451249
name: date_modified
1246-
description: 'Filter items by date_modified. For example, `date_modified=2019-09-04T00:00:00`, `date_modified=2019-09-04`, or `date_modified=1567573200`'
1250+
description: 'Filter items by date modified. For example, `date_created=2024-05-14T09:34:00` or `date_created=2024-05-14`.'
12471251
in: query
12481252
required: false
12491253
schema:
12501254
type: string
12511255
date_modified_min:
12521256
name: 'date_modified:min'
1253-
description: 'Filter items by minimum date_modified. For example, `date_modified:min=2019-09-04T00:00:00`, `date_modified:min=2019-09-04`, or `date_modified:min=1567573200`'
1257+
description: 'Filter items by minimum date modified. For example, `date_created=2024-05-14T09:34:00` or `date_created=2024-05-14`. Returns metafields modified after this date.'
12541258
in: query
12551259
required: false
12561260
schema:
12571261
type: string
12581262
date_modified_max:
12591263
name: 'date_modified:max'
1260-
description: 'Filter items by maximum date_modified. For example, `date_modified:max=2019-09-04T00:00:00`, `date_modified:max=2019-09-04`, or `date_modified:max=1567573200`'
1264+
description: 'Filter items by maximum date modified. For example, `date_created=2024-05-14T09:34:00` or `date_created=2024-05-14`. Returns metafields modified before this date.'
12611265
in: query
12621266
required: false
12631267
schema:

0 commit comments

Comments
 (0)