From fdb9a50aaf64f9cc2d9c9df25f8c60dd00fa11db Mon Sep 17 00:00:00 2001 From: sviat stoliarenko Date: Tue, 13 Jan 2026 18:52:46 +0200 Subject: [PATCH 1/4] add cursor related data --- package-lock.json | 2 +- reference/carts.v3.yml | 161 +++++++++++++++++++++++++++----------- reference/channels.v3.yml | 161 +++++++++++++++++++++++++++----------- reference/orders.v3.yml | 116 +++++++++++++++------------ 4 files changed, 297 insertions(+), 143 deletions(-) diff --git a/package-lock.json b/package-lock.json index 4e3f8f486..c59d4cfc5 100644 --- a/package-lock.json +++ b/package-lock.json @@ -12,7 +12,7 @@ "eslint-plugin-mdx": "^2.0.5" }, "engines": { - "node": ">= 14.0.0" + "node": ">= 18.0.0" } }, "node_modules/@babel/code-frame": { diff --git a/reference/carts.v3.yml b/reference/carts.v3.yml index 8afc63f3e..552b1ac7c 100644 --- a/reference/carts.v3.yml +++ b/reference/carts.v3.yml @@ -1109,6 +1109,8 @@ paths: - $ref: '#/components/parameters/date_modified_max' - $ref: '#/components/parameters/date_created_min' - $ref: '#/components/parameters/date_created_max' + - $ref: '#/components/parameters/BeforeCursorParam' + - $ref: '#/components/parameters/AfterCursorParam' post: summary: Create multiple Metafields tags: @@ -1290,6 +1292,101 @@ paths: $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess_DELETE' components: schemas: + Pagination: + type: object + description: Data about the response, including pagination and collection totals. + title: Pagination + properties: + total: + type: integer + description: | + Total number of items in the result set. + example: 36 + count: + type: integer + description: | + Total number of items in the collection response. + example: 36 + per_page: + type: integer + description: | + The amount of items returned in the collection per page, controlled by the limit parameter. + example: 50 + current_page: + type: integer + description: | + The page you are currently on within the collection. + example: 1 + total_pages: + type: integer + description: | + The total number of pages in the collection. + example: 1 + links: + type: object + description: | + Pagination links for the previous and next parts of the whole collection. + properties: + previous: + type: string + description: | + Link to the previous page returned in the response. + current: + type: string + description: | + Link to the current page returned in the response. + example: '?page=1&limit=50' + next: + type: string + description: | + Link to the next page returned in the response. + x-internal: false + CursorPagination: + type: object + description: Data about the response, including cursor pagination and collection totals. + title: CursorPagination + properties: + count: + type: integer + description: | + Total number of items in the collection response. + example: 36 + per_page: + type: integer + description: | + The amount of items returned in the collection per page, controlled by the limit parameter. + example: 50 + start_cursor: + type: string + description: | + Cursor that is referring to a start of current page. + example: "aWQ6Nw==" + end_cursor: + type: string + description: | + Cursor that is referring to a end of current page. Should be used to fetch next page. + example: "aWQ6Nw==" + links: + type: object + description: | + Pagination links for the previous and next parts of the whole collection. + properties: + previous: + type: string + description: | + Cursor to the previous page returned in the response. + example: '?page=1&after=aWQ6Nw%3D%3D' + current: + type: string + description: | + Cursor to the current page returned in the response. + example: '?page=1&after=aWQ6Nw%3D%3D' + next: + type: string + description: | + Cursor to the next page returned in the response. + example: '?page=1&after=aWQ6Nw%3D%3D' + x-internal: false CartUpdateRequest: type: object properties: @@ -3667,53 +3764,9 @@ components: description: Data about the response, including pagination and collection totals. properties: pagination: - type: object - description: Data about the response, including pagination and collection totals. - title: Pagination - properties: - total: - type: integer - description: | - Total number of items in the result set. - example: 36 - count: - type: integer - description: | - Total number of items in the collection response. - example: 36 - per_page: - type: integer - description: | - The amount of items returned in the collection per page, controlled by the limit parameter. - example: 50 - current_page: - type: integer - description: | - The page you are currently on within the collection. - example: 1 - total_pages: - type: integer - description: | - The total number of pages in the collection. - example: 1 - links: - type: object - description: | - Pagination links for the previous and next parts of the whole collection. - properties: - previous: - type: string - description: | - Link to the previous page returned in the response. - current: - type: string - description: | - Link to the current page returned in the response. - example: '?page=1&limit=50' - next: - type: string - description: | - Link to the next page returned in the response. + $ref: '#/components/schemas/Pagination' + cursor_pagination: + $ref: '#/components/schemas/CursorPagination' additionalProperties: true title: Collection Meta x-internal: false @@ -3779,6 +3832,20 @@ components: meta: $ref: '#/components/schemas/metaCollection_open' parameters: + BeforeCursorParam: + name: 'before' + description: 'Specify a cursor starting from which next page will be fetched (Backward order). Not required for a first page. For all subsequent page requests use a value from meta.cursor_pagination.end_cursor obtained by previous request. Works with limit, direction and other parameters. Overrides offset pagination parameter as page. Can not be used with after parameter' + in: query + required: false + schema: + type: string + AfterCursorParam: + name: 'after' + description: 'Specify a cursor starting from which next page will be fetched (Forward order). Not required for a first page. For all subsequent page requests use a value from meta.cursor_pagination.end_cursor obtained by previous request. Works with limit, direction and other parameters. Overrides offset pagination parameter as page. Can not be used with before parameter' + in: query + required: false + schema: + type: string Accept: name: Accept in: header diff --git a/reference/channels.v3.yml b/reference/channels.v3.yml index ff1442ab4..fa76c7ae5 100644 --- a/reference/channels.v3.yml +++ b/reference/channels.v3.yml @@ -952,6 +952,8 @@ paths: - $ref: '#/components/parameters/date_modified_max' - $ref: '#/components/parameters/date_created_min' - $ref: '#/components/parameters/date_created_max' + - $ref: '#/components/parameters/BeforeCursorParam' + - $ref: '#/components/parameters/AfterCursorParam' post: summary: Create multiple Metafields tags: @@ -1112,6 +1114,20 @@ paths: $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess_DELETE' components: parameters: + BeforeCursorParam: + name: 'before' + description: 'Specify a cursor starting from which next page will be fetched (Backward order). Not required for a first page. For all subsequent page requests use a value from meta.cursor_pagination.end_cursor obtained by previous request. Works with limit, direction and other parameters. Overrides offset pagination parameter as page. Can not be used with after parameter' + in: query + required: false + schema: + type: string + AfterCursorParam: + name: 'after' + description: 'Specify a cursor starting from which next page will be fetched (Forward order). Not required for a first page. For all subsequent page requests use a value from meta.cursor_pagination.end_cursor obtained by previous request. Works with limit, direction and other parameters. Overrides offset pagination parameter as page. Can not be used with before parameter' + in: query + required: false + schema: + type: string Accept: name: Accept in: header @@ -2403,6 +2419,101 @@ components: type: apiKey in: header schemas: + Pagination: + type: object + description: Data about the response, including pagination and collection totals. + title: Pagination + properties: + total: + type: integer + description: | + Total number of items in the result set. + example: 36 + count: + type: integer + description: | + Total number of items in the collection response. + example: 36 + per_page: + type: integer + description: | + The amount of items returned in the collection per page, controlled by the limit parameter. + example: 50 + current_page: + type: integer + description: | + The page you are currently on within the collection. + example: 1 + total_pages: + type: integer + description: | + The total number of pages in the collection. + example: 1 + links: + type: object + description: | + Pagination links for the previous and next parts of the whole collection. + properties: + previous: + type: string + description: | + Link to the previous page returned in the response. + current: + type: string + description: | + Link to the current page returned in the response. + example: '?page=1&limit=50' + next: + type: string + description: | + Link to the next page returned in the response. + x-internal: false + CursorPagination: + type: object + description: Data about the response, including cursor pagination and collection totals. + title: CursorPagination + properties: + count: + type: integer + description: | + Total number of items in the collection response. + example: 36 + per_page: + type: integer + description: | + The amount of items returned in the collection per page, controlled by the limit parameter. + example: 50 + start_cursor: + type: string + description: | + Cursor that is referring to a start of current page. + example: "aWQ6Nw==" + end_cursor: + type: string + description: | + Cursor that is referring to a end of current page. Should be used to fetch next page. + example: "aWQ6Nw==" + links: + type: object + description: | + Pagination links for the previous and next parts of the whole collection. + properties: + previous: + type: string + description: | + Cursor to the previous page returned in the response. + example: '?page=1&after=aWQ6Nw%3D%3D' + current: + type: string + description: | + Cursor to the current page returned in the response. + example: '?page=1&after=aWQ6Nw%3D%3D' + next: + type: string + description: | + Cursor to the next page returned in the response. + example: '?page=1&after=aWQ6Nw%3D%3D' + x-internal: false ChannelId: type: integer format: int64 @@ -2796,53 +2907,9 @@ components: description: Data about the response, including pagination and collection totals. properties: pagination: - type: object - description: Data about the response, including pagination and collection totals. - title: Pagination - properties: - total: - type: integer - description: | - Total number of items in the result set. - example: 36 - count: - type: integer - description: | - Total number of items in the collection response. - example: 36 - per_page: - type: integer - description: | - The amount of items returned in the collection per page, controlled by the limit parameter. - example: 50 - current_page: - type: integer - description: | - The page you are currently on within the collection. - example: 1 - total_pages: - type: integer - description: | - The total number of pages in the collection. - example: 1 - links: - type: object - description: | - Pagination links for the previous and next parts of the whole collection. - properties: - previous: - type: string - description: | - Link to the previous page returned in the response. - current: - type: string - description: | - Link to the current page returned in the response. - example: '?page=1&limit=50' - next: - type: string - description: | - Link to the next page returned in the response. + $ref: '#/components/schemas/Pagination' + cursor_pagination: + $ref: '#/components/schemas/CursorPagination' additionalProperties: true title: Collection Meta x-internal: false diff --git a/reference/orders.v3.yml b/reference/orders.v3.yml index bffaa176d..f56376e7c 100644 --- a/reference/orders.v3.yml +++ b/reference/orders.v3.yml @@ -864,6 +864,8 @@ paths: - $ref: '#/components/parameters/date_created_max' - $ref: '#/components/parameters/date_modified_min' - $ref: '#/components/parameters/date_modified_max' + - $ref: '#/components/parameters/BeforeCursorParam' + - $ref: '#/components/parameters/AfterCursorParam' post: summary: Create multiple Metafields tags: @@ -1327,6 +1329,52 @@ components: description: | Link to the next page returned in the response. x-internal: false + CursorPagination: + type: object + description: Data about the response, including cursor pagination and collection totals. + title: CursorPagination + properties: + count: + type: integer + description: | + Total number of items in the collection response. + example: 36 + per_page: + type: integer + description: | + The amount of items returned in the collection per page, controlled by the limit parameter. + example: 50 + start_cursor: + type: string + description: | + Cursor that is referring to a start of current page. + example: "aWQ6Nw==" + end_cursor: + type: string + description: | + Cursor that is referring to a end of current page. Should be used to fetch next page. + example: "aWQ6Nw==" + links: + type: object + description: | + Pagination links for the previous and next parts of the whole collection. + properties: + previous: + type: string + description: | + Cursor to the previous page returned in the response. + example: '?page=1&after=aWQ6Nw%3D%3D' + current: + type: string + description: | + Cursor to the current page returned in the response. + example: '?page=1&after=aWQ6Nw%3D%3D' + next: + type: string + description: | + Cursor to the next page returned in the response. + example: '?page=1&after=aWQ6Nw%3D%3D' + x-internal: false ReceivedItems_Put: type: array items: @@ -1463,56 +1511,12 @@ components: x-internal: false CollectionMeta: type: object - description: Data about the response, including pagination and collection totals. + description: Data about the response, including pagination (for a first page and offset-based and cursor-based pagination data are returned) and collection totals. properties: pagination: - type: object - description: Data about the response, including pagination and collection totals. - title: Pagination - properties: - total: - type: integer - description: | - Total number of items in the result set. - example: 36 - count: - type: integer - description: | - Total number of items in the collection response. - example: 36 - per_page: - type: integer - description: | - The amount of items returned in the collection per page, controlled by the limit parameter. - example: 50 - current_page: - type: integer - description: | - The page you are currently on within the collection. - example: 1 - total_pages: - type: integer - description: | - The total number of pages in the collection. - example: 1 - links: - type: object - description: | - Pagination links for the previous and next parts of the whole collection. - properties: - previous: - type: string - description: | - Link to the previous page returned in the response. - current: - type: string - description: | - Link to the current page returned in the response. - example: '?page=1&limit=50' - next: - type: string - description: | - Link to the next page returned in the response. + $ref: '#/components/schemas/Pagination' + cursor_pagination: + $ref: '#/components/schemas/CursorPagination' title: Collection Meta x-internal: false Meta: @@ -3483,6 +3487,8 @@ components: properties: pagination: $ref: '#/components/schemas/Pagination' + cursor_pagination: + $ref: '#/components/schemas/CursorPagination' ReturnStatus_Resp: description: '' content: @@ -3991,6 +3997,20 @@ components: - owner_client_id - date_created - date_modified + BeforeCursorParam: + name: 'before' + description: 'Specify a cursor starting from which next page will be fetched (Backward order). Not required for a first page. For all subsequent page requests use a value from meta.cursor_pagination.end_cursor obtained by previous request. Works with limit, direction and other parameters. Overrides offset pagination parameter as page. Can not be used with after parameter' + in: query + required: false + schema: + type: string + AfterCursorParam: + name: 'after' + description: 'Specify a cursor starting from which next page will be fetched (Forward order). Not required for a first page. For all subsequent page requests use a value from meta.cursor_pagination.end_cursor obtained by previous request. Works with limit, direction and other parameters. Overrides offset pagination parameter as page. Can not be used with before parameter' + in: query + required: false + schema: + type: string securitySchemes: X-Auth-Token: name: X-Auth-Token From 5c93c70775fc8a1c1373fcacf5fb1bf385efd1f0 Mon Sep 17 00:00:00 2001 From: sviat stoliarenko Date: Tue, 13 Jan 2026 19:00:25 +0200 Subject: [PATCH 2/4] add cursor related data --- reference/customers.v3.yml | 155 +++++++++++++++++++---------------- reference/locations.v3.yml | 161 ++++++++++++++++++++++++++----------- 2 files changed, 200 insertions(+), 116 deletions(-) diff --git a/reference/customers.v3.yml b/reference/customers.v3.yml index cc9004191..afb84d50f 100644 --- a/reference/customers.v3.yml +++ b/reference/customers.v3.yml @@ -1964,6 +1964,8 @@ paths: - $ref: '#/components/parameters/date_modified_max' - $ref: '#/components/parameters/date_created_min' - $ref: '#/components/parameters/date_created_max' + - $ref: '#/components/parameters/BeforeCursorParam' + - $ref: '#/components/parameters/AfterCursorParam' post: summary: Create Multiple Metafields tags: @@ -2135,6 +2137,20 @@ paths: $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess_DELETE' components: parameters: + BeforeCursorParam: + name: 'before' + description: 'Specify a cursor starting from which next page will be fetched (Backward order). Not required for a first page. For all subsequent page requests use a value from meta.cursor_pagination.end_cursor obtained by previous request. Works with limit, direction and other parameters. Overrides offset pagination parameter as page. Can not be used with after parameter' + in: query + required: false + schema: + type: string + AfterCursorParam: + name: 'after' + description: 'Specify a cursor starting from which next page will be fetched (Forward order). Not required for a first page. For all subsequent page requests use a value from meta.cursor_pagination.end_cursor obtained by previous request. Works with limit, direction and other parameters. Overrides offset pagination parameter as page. Can not be used with before parameter' + in: query + required: false + schema: + type: string metafieldId: name: metafieldId in: path @@ -3180,54 +3196,99 @@ components: in: header schemas: Pagination: - title: Pagination - description: Data about the response, including pagination and collection totals. type: object + description: Data about the response, including pagination and collection totals. + title: Pagination properties: total: - description: Total number of items in the result set. type: integer - format: int32 + description: | + Total number of items in the result set. + example: 36 count: - description: Total number of items in the collection response. type: integer - format: int32 + description: | + Total number of items in the collection response. + example: 36 per_page: - description: 'The amount of items returned in the collection per page, controlled by the limit parameter.' type: integer - format: int32 + description: | + The amount of items returned in the collection per page, controlled by the limit parameter. + example: 50 current_page: - description: The page you are currently on within the collection. type: integer - format: int32 + description: | + The page you are currently on within the collection. + example: 1 total_pages: - description: The total number of pages in the collection. type: integer - format: int32 + description: | + The total number of pages in the collection. + example: 1 links: - $ref: '#/components/schemas/Links' + type: object + description: | + Pagination links for the previous and next parts of the whole collection. + properties: + previous: + type: string + description: | + Link to the previous page returned in the response. + current: + type: string + description: | + Link to the current page returned in the response. + example: '?page=1&limit=50' + next: + type: string + description: | + Link to the next page returned in the response. x-internal: false CursorPagination: - title: Cursor Pagination - description: Data about cursor pagination. type: object + description: Data about the response, including cursor pagination and collection totals. + title: CursorPagination properties: count: - description: Total number of items in the collection response. type: integer - format: int32 + description: | + Total number of items in the collection response. + example: 36 per_page: - description: The amount of items returned in the collection per page, controlled by the limit parameter. type: integer - format: int32 + description: | + The amount of items returned in the collection per page, controlled by the limit parameter. + example: 50 start_cursor: - description: A string representing the starting point of the current page in the collection type: string + description: | + Cursor that is referring to a start of current page. + example: "aWQ6Nw==" end_cursor: - description: A string representing the ending point of the current page in the collection. type: string + description: | + Cursor that is referring to a end of current page. Should be used to fetch next page. + example: "aWQ6Nw==" links: - $ref: '#/components/schemas/Links' + type: object + description: | + Pagination links for the previous and next parts of the whole collection. + properties: + previous: + type: string + description: | + Cursor to the previous page returned in the response. + example: '?page=1&after=aWQ6Nw%3D%3D' + current: + type: string + description: | + Cursor to the current page returned in the response. + example: '?page=1&after=aWQ6Nw%3D%3D' + next: + type: string + description: | + Cursor to the next page returned in the response. + example: '?page=1&after=aWQ6Nw%3D%3D' x-internal: false _metaCollection: title: _metaCollection @@ -4826,53 +4887,9 @@ components: description: Data about the response, including pagination and collection totals. properties: pagination: - type: object - description: Data about the response, including pagination and collection totals. - title: Pagination - properties: - total: - type: integer - description: | - Total number of items in the result set. - example: 36 - count: - type: integer - description: | - Total number of items in the collection response. - example: 36 - per_page: - type: integer - description: | - The amount of items returned in the collection per page, controlled by the limit parameter. - example: 50 - current_page: - type: integer - description: | - The page you are currently on within the collection. - example: 1 - total_pages: - type: integer - description: | - The total number of pages in the collection. - example: 1 - links: - type: object - description: | - Pagination links for the previous and next parts of the whole collection. - properties: - previous: - type: string - description: | - Link to the previous page returned in the response. - current: - type: string - description: | - Link to the current page returned in the response. - example: '?page=1&limit=50' - next: - type: string - description: | - Link to the next page returned in the response. + $ref: '#/components/schemas/Pagination' + cursor_pagination: + $ref: '#/components/schemas/CursorPagination' additionalProperties: true title: Collection Meta x-internal: false diff --git a/reference/locations.v3.yml b/reference/locations.v3.yml index 65765b0ed..35f2be484 100644 --- a/reference/locations.v3.yml +++ b/reference/locations.v3.yml @@ -504,6 +504,8 @@ paths: - $ref: '#/components/parameters/date_modified_max' - $ref: '#/components/parameters/date_created_min' - $ref: '#/components/parameters/date_created_max' + - $ref: '#/components/parameters/BeforeCursorParam' + - $ref: '#/components/parameters/AfterCursorParam' post: summary: Create multiple Metafields tags: @@ -661,6 +663,101 @@ paths: $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess_DELETE' components: schemas: + Pagination: + type: object + description: Data about the response, including pagination and collection totals. + title: Pagination + properties: + total: + type: integer + description: | + Total number of items in the result set. + example: 36 + count: + type: integer + description: | + Total number of items in the collection response. + example: 36 + per_page: + type: integer + description: | + The amount of items returned in the collection per page, controlled by the limit parameter. + example: 50 + current_page: + type: integer + description: | + The page you are currently on within the collection. + example: 1 + total_pages: + type: integer + description: | + The total number of pages in the collection. + example: 1 + links: + type: object + description: | + Pagination links for the previous and next parts of the whole collection. + properties: + previous: + type: string + description: | + Link to the previous page returned in the response. + current: + type: string + description: | + Link to the current page returned in the response. + example: '?page=1&limit=50' + next: + type: string + description: | + Link to the next page returned in the response. + x-internal: false + CursorPagination: + type: object + description: Data about the response, including cursor pagination and collection totals. + title: CursorPagination + properties: + count: + type: integer + description: | + Total number of items in the collection response. + example: 36 + per_page: + type: integer + description: | + The amount of items returned in the collection per page, controlled by the limit parameter. + example: 50 + start_cursor: + type: string + description: | + Cursor that is referring to a start of current page. + example: "aWQ6Nw==" + end_cursor: + type: string + description: | + Cursor that is referring to a end of current page. Should be used to fetch next page. + example: "aWQ6Nw==" + links: + type: object + description: | + Pagination links for the previous and next parts of the whole collection. + properties: + previous: + type: string + description: | + Cursor to the previous page returned in the response. + example: '?page=1&after=aWQ6Nw%3D%3D' + current: + type: string + description: | + Cursor to the current page returned in the response. + example: '?page=1&after=aWQ6Nw%3D%3D' + next: + type: string + description: | + Cursor to the next page returned in the response. + example: '?page=1&after=aWQ6Nw%3D%3D' + x-internal: false ErrorResponse: type: object properties: @@ -1446,53 +1543,9 @@ components: description: Data about the response, including pagination and collection totals. properties: pagination: - type: object - description: Data about the response, including pagination and collection totals. - title: Pagination - properties: - total: - type: integer - description: | - Total number of items in the result set. - example: 36 - count: - type: integer - description: | - Total number of items in the collection response. - example: 36 - per_page: - type: integer - description: | - The amount of items returned in the collection per page, controlled by the limit parameter. - example: 50 - current_page: - type: integer - description: | - The page you are currently on within the collection. - example: 1 - total_pages: - type: integer - description: | - The total number of pages in the collection. - example: 1 - links: - type: object - description: | - Pagination links for the previous and next parts of the whole collection. - properties: - previous: - type: string - description: | - Link to the previous page returned in the response. - current: - type: string - description: | - Link to the current page returned in the response. - example: '?page=1&limit=50' - next: - type: string - description: | - Link to the next page returned in the response. + $ref: '#/components/schemas/Pagination' + cursor_pagination: + $ref: '#/components/schemas/CursorPagination' additionalProperties: true title: Collection Meta x-internal: false @@ -1604,6 +1657,20 @@ components: maxLength: 255 example: Name of Staff Member parameters: + BeforeCursorParam: + name: 'before' + description: 'Specify a cursor starting from which next page will be fetched (Backward order). Not required for a first page. For all subsequent page requests use a value from meta.cursor_pagination.end_cursor obtained by previous request. Works with limit, direction and other parameters. Overrides offset pagination parameter as page. Can not be used with after parameter' + in: query + required: false + schema: + type: string + AfterCursorParam: + name: 'after' + description: 'Specify a cursor starting from which next page will be fetched (Forward order). Not required for a first page. For all subsequent page requests use a value from meta.cursor_pagination.end_cursor obtained by previous request. Works with limit, direction and other parameters. Overrides offset pagination parameter as page. Can not be used with before parameter' + in: query + required: false + schema: + type: string Accept: name: Accept in: header From 300de09b55323c22be75ea4b211885410ff7edce Mon Sep 17 00:00:00 2001 From: sviat stoliarenko Date: Tue, 13 Jan 2026 19:26:56 +0200 Subject: [PATCH 3/4] add cursor related data --- reference/catalog/brands_catalog.v3.yml | 165 +++++++++---- reference/catalog/categories_catalog.v3.yml | 124 +++++++++- .../catalog/product-variants_catalog.v3.yml | 124 +++++++++- reference/catalog/products_catalog.v3.yml | 161 +++++++++---- reference/store_information.v3.yml | 219 ++++++++++++++---- 5 files changed, 650 insertions(+), 143 deletions(-) diff --git a/reference/catalog/brands_catalog.v3.yml b/reference/catalog/brands_catalog.v3.yml index 34c567f8a..6600912ff 100644 --- a/reference/catalog/brands_catalog.v3.yml +++ b/reference/catalog/brands_catalog.v3.yml @@ -1456,6 +1456,12 @@ paths: - $ref: '#/components/parameters/MetafieldNamespaceInParam' - $ref: '#/components/parameters/DirectionParam' - $ref: '#/components/parameters/IncludeFieldsParamMetafields' + - $ref: '#/components/parameters/date_modified_min' + - $ref: '#/components/parameters/date_modified_max' + - $ref: '#/components/parameters/date_created_min' + - $ref: '#/components/parameters/date_created_max' + - $ref: '#/components/parameters/BeforeCursorParam' + - $ref: '#/components/parameters/AfterCursorParam' post: summary: Create multiple metafields tags: @@ -1656,6 +1662,101 @@ paths: - $ref: '#/components/parameters/Accept' components: schemas: + Pagination: + type: object + description: Data about the response, including pagination and collection totals. + title: Pagination + properties: + total: + type: integer + description: | + Total number of items in the result set. + example: 36 + count: + type: integer + description: | + Total number of items in the collection response. + example: 36 + per_page: + type: integer + description: | + The amount of items returned in the collection per page, controlled by the limit parameter. + example: 50 + current_page: + type: integer + description: | + The page you are currently on within the collection. + example: 1 + total_pages: + type: integer + description: | + The total number of pages in the collection. + example: 1 + links: + type: object + description: | + Pagination links for the previous and next parts of the whole collection. + properties: + previous: + type: string + description: | + Link to the previous page returned in the response. + current: + type: string + description: | + Link to the current page returned in the response. + example: '?page=1&limit=50' + next: + type: string + description: | + Link to the next page returned in the response. + x-internal: false + CursorPagination: + type: object + description: Data about the response, including cursor pagination and collection totals. + title: CursorPagination + properties: + count: + type: integer + description: | + Total number of items in the collection response. + example: 36 + per_page: + type: integer + description: | + The amount of items returned in the collection per page, controlled by the limit parameter. + example: 50 + start_cursor: + type: string + description: | + Cursor that is referring to a start of current page. + example: "aWQ6Nw==" + end_cursor: + type: string + description: | + Cursor that is referring to a end of current page. Should be used to fetch next page. + example: "aWQ6Nw==" + links: + type: object + description: | + Pagination links for the previous and next parts of the whole collection. + properties: + previous: + type: string + description: | + Cursor to the previous page returned in the response. + example: '?page=1&after=aWQ6Nw%3D%3D' + current: + type: string + description: | + Cursor to the current page returned in the response. + example: '?page=1&after=aWQ6Nw%3D%3D' + next: + type: string + description: | + Cursor to the next page returned in the response. + example: '?page=1&after=aWQ6Nw%3D%3D' + x-internal: false brand_Full: title: brand_Full required: @@ -2190,53 +2291,9 @@ components: description: Data about the response, including pagination and collection totals. properties: pagination: - type: object - description: Data about the response, including pagination and collection totals. - title: Pagination - properties: - total: - type: integer - description: | - Total number of items in the result set. - example: 36 - count: - type: integer - description: | - Total number of items in the collection response. - example: 36 - per_page: - type: integer - description: | - The amount of items returned in the collection per page, controlled by the limit parameter. - example: 50 - current_page: - type: integer - description: | - The page you are currently on within the collection. - example: 1 - total_pages: - type: integer - description: | - The total number of pages in the collection. - example: 1 - links: - type: object - description: | - Pagination links for the previous and next parts of the whole collection. - properties: - previous: - type: string - description: | - Link to the previous page returned in the response. - current: - type: string - description: | - Link to the current page returned in the response. - example: '?page=1&limit=50' - next: - type: string - description: | - Link to the next page returned in the response. + $ref: '#/components/schemas/Pagination' + cursor_pagination: + $ref: '#/components/schemas/CursorPagination' additionalProperties: true title: Collection Meta x-internal: false @@ -2395,6 +2452,20 @@ components: type: object properties: { } parameters: + BeforeCursorParam: + name: 'before' + description: 'Specify a cursor starting from which next page will be fetched (Backward order). Not required for a first page. For all subsequent page requests use a value from meta.cursor_pagination.end_cursor obtained by previous request. Works with limit, direction and other parameters. Overrides offset pagination parameter as page. Can not be used with after parameter' + in: query + required: false + schema: + type: string + AfterCursorParam: + name: 'after' + description: 'Specify a cursor starting from which next page will be fetched (Forward order). Not required for a first page. For all subsequent page requests use a value from meta.cursor_pagination.end_cursor obtained by previous request. Works with limit, direction and other parameters. Overrides offset pagination parameter as page. Can not be used with before parameter' + in: query + required: false + schema: + type: string DirectionQuery: name: direction in: query diff --git a/reference/catalog/categories_catalog.v3.yml b/reference/catalog/categories_catalog.v3.yml index 102f544a7..44b237fd3 100644 --- a/reference/catalog/categories_catalog.v3.yml +++ b/reference/catalog/categories_catalog.v3.yml @@ -1555,6 +1555,8 @@ paths: - $ref: '#/components/parameters/date_modified_max' - $ref: '#/components/parameters/date_created_min' - $ref: '#/components/parameters/date_created_max' + - $ref: '#/components/parameters/BeforeCursorParam' + - $ref: '#/components/parameters/AfterCursorParam' post: summary: Create multiple Metafields tags: @@ -1742,6 +1744,101 @@ paths: - $ref: '#/components/parameters/Accept' components: schemas: + Pagination: + type: object + description: Data about the response, including pagination and collection totals. + title: Pagination + properties: + total: + type: integer + description: | + Total number of items in the result set. + example: 36 + count: + type: integer + description: | + Total number of items in the collection response. + example: 36 + per_page: + type: integer + description: | + The amount of items returned in the collection per page, controlled by the limit parameter. + example: 50 + current_page: + type: integer + description: | + The page you are currently on within the collection. + example: 1 + total_pages: + type: integer + description: | + The total number of pages in the collection. + example: 1 + links: + type: object + description: | + Pagination links for the previous and next parts of the whole collection. + properties: + previous: + type: string + description: | + Link to the previous page returned in the response. + current: + type: string + description: | + Link to the current page returned in the response. + example: '?page=1&limit=50' + next: + type: string + description: | + Link to the next page returned in the response. + x-internal: false + CursorPagination: + type: object + description: Data about the response, including cursor pagination and collection totals. + title: CursorPagination + properties: + count: + type: integer + description: | + Total number of items in the collection response. + example: 36 + per_page: + type: integer + description: | + The amount of items returned in the collection per page, controlled by the limit parameter. + example: 50 + start_cursor: + type: string + description: | + Cursor that is referring to a start of current page. + example: "aWQ6Nw==" + end_cursor: + type: string + description: | + Cursor that is referring to a end of current page. Should be used to fetch next page. + example: "aWQ6Nw==" + links: + type: object + description: | + Pagination links for the previous and next parts of the whole collection. + properties: + previous: + type: string + description: | + Cursor to the previous page returned in the response. + example: '?page=1&after=aWQ6Nw%3D%3D' + current: + type: string + description: | + Cursor to the current page returned in the response. + example: '?page=1&after=aWQ6Nw%3D%3D' + next: + type: string + description: | + Cursor to the next page returned in the response. + example: '?page=1&after=aWQ6Nw%3D%3D' + x-internal: false category_Full: title: category_Full type: object @@ -2353,7 +2450,7 @@ components: items: $ref: '#/components/schemas/Metafield' meta: - $ref: '#/components/schemas/CollectionMeta' + $ref: '#/components/schemas/BatchPaginationCollectionMeta' x-internal: false MetaFieldCollectionResponse_POST_PUT: type: object @@ -2502,6 +2599,17 @@ components: example: "1": "Unauthorized to delete" "2": "Metafield does not exist" + BatchPaginationCollectionMeta: + type: object + description: Data about the response, including pagination and collection totals. + properties: + pagination: + $ref: '#/components/schemas/Pagination' + cursor_pagination: + $ref: '#/components/schemas/CursorPagination' + additionalProperties: true + title: Collection Meta + x-internal: false CollectionMeta: type: object description: Data about the response, including pagination and collection totals. @@ -2690,6 +2798,20 @@ components: schema: type: string parameters: + BeforeCursorParam: + name: 'before' + description: 'Specify a cursor starting from which next page will be fetched (Backward order). Not required for a first page. For all subsequent page requests use a value from meta.cursor_pagination.end_cursor obtained by previous request. Works with limit, direction and other parameters. Overrides offset pagination parameter as page. Can not be used with after parameter' + in: query + required: false + schema: + type: string + AfterCursorParam: + name: 'after' + description: 'Specify a cursor starting from which next page will be fetched (Forward order). Not required for a first page. For all subsequent page requests use a value from meta.cursor_pagination.end_cursor obtained by previous request. Works with limit, direction and other parameters. Overrides offset pagination parameter as page. Can not be used with before parameter' + in: query + required: false + schema: + type: string CategoryIdParam: name: category_id in: path diff --git a/reference/catalog/product-variants_catalog.v3.yml b/reference/catalog/product-variants_catalog.v3.yml index 0e43bd474..45e2d8c3e 100644 --- a/reference/catalog/product-variants_catalog.v3.yml +++ b/reference/catalog/product-variants_catalog.v3.yml @@ -1686,6 +1686,8 @@ paths: - $ref: '#/components/parameters/date_created_max' - $ref: '#/components/parameters/date_modified_min' - $ref: '#/components/parameters/date_modified_max' + - $ref: '#/components/parameters/BeforeCursorParam' + - $ref: '#/components/parameters/AfterCursorParam' post: summary: Create multiple Metafields tags: @@ -1873,6 +1875,101 @@ paths: - $ref: '#/components/parameters/Accept' components: schemas: + Pagination: + type: object + description: Data about the response, including pagination and collection totals. + title: Pagination + properties: + total: + type: integer + description: | + Total number of items in the result set. + example: 36 + count: + type: integer + description: | + Total number of items in the collection response. + example: 36 + per_page: + type: integer + description: | + The amount of items returned in the collection per page, controlled by the limit parameter. + example: 50 + current_page: + type: integer + description: | + The page you are currently on within the collection. + example: 1 + total_pages: + type: integer + description: | + The total number of pages in the collection. + example: 1 + links: + type: object + description: | + Pagination links for the previous and next parts of the whole collection. + properties: + previous: + type: string + description: | + Link to the previous page returned in the response. + current: + type: string + description: | + Link to the current page returned in the response. + example: '?page=1&limit=50' + next: + type: string + description: | + Link to the next page returned in the response. + x-internal: false + CursorPagination: + type: object + description: Data about the response, including cursor pagination and collection totals. + title: CursorPagination + properties: + count: + type: integer + description: | + Total number of items in the collection response. + example: 36 + per_page: + type: integer + description: | + The amount of items returned in the collection per page, controlled by the limit parameter. + example: 50 + start_cursor: + type: string + description: | + Cursor that is referring to a start of current page. + example: "aWQ6Nw==" + end_cursor: + type: string + description: | + Cursor that is referring to a end of current page. Should be used to fetch next page. + example: "aWQ6Nw==" + links: + type: object + description: | + Pagination links for the previous and next parts of the whole collection. + properties: + previous: + type: string + description: | + Cursor to the previous page returned in the response. + example: '?page=1&after=aWQ6Nw%3D%3D' + current: + type: string + description: | + Cursor to the current page returned in the response. + example: '?page=1&after=aWQ6Nw%3D%3D' + next: + type: string + description: | + Cursor to the next page returned in the response. + example: '?page=1&after=aWQ6Nw%3D%3D' + x-internal: false categoriesTree_Resp: title: categoriesTree_Resp type: object @@ -2622,7 +2719,7 @@ components: items: $ref: '#/components/schemas/Metafield' meta: - $ref: '#/components/schemas/CollectionMeta' + $ref: '#/components/schemas/BatchPaginationCollectionMeta' x-internal: false MetaFieldCollectionResponse_POST_PUT: type: object @@ -2787,6 +2884,17 @@ components: example: "1": "Unauthorized to delete" "2": "Metafield does not exist" + BatchPaginationCollectionMeta: + type: object + description: Data about the response, including pagination and collection totals. + properties: + pagination: + $ref: '#/components/schemas/Pagination' + cursor_pagination: + $ref: '#/components/schemas/CursorPagination' + additionalProperties: true + title: Collection Meta + x-internal: false CollectionMeta: type: object description: Data about the response, including pagination and collection totals. @@ -2950,6 +3058,20 @@ components: maxLength: 255 example: Name of Staff Member parameters: + BeforeCursorParam: + name: 'before' + description: 'Specify a cursor starting from which next page will be fetched (Backward order). Not required for a first page. For all subsequent page requests use a value from meta.cursor_pagination.end_cursor obtained by previous request. Works with limit, direction and other parameters. Overrides offset pagination parameter as page. Can not be used with after parameter' + in: query + required: false + schema: + type: string + AfterCursorParam: + name: 'after' + description: 'Specify a cursor starting from which next page will be fetched (Forward order). Not required for a first page. For all subsequent page requests use a value from meta.cursor_pagination.end_cursor obtained by previous request. Works with limit, direction and other parameters. Overrides offset pagination parameter as page. Can not be used with before parameter' + in: query + required: false + schema: + type: string ProductIdPathParam: name: product_id in: path diff --git a/reference/catalog/products_catalog.v3.yml b/reference/catalog/products_catalog.v3.yml index c7dd8fe7b..57c1332c8 100644 --- a/reference/catalog/products_catalog.v3.yml +++ b/reference/catalog/products_catalog.v3.yml @@ -4898,6 +4898,8 @@ paths: - $ref: '#/components/parameters/date_modified_max' - $ref: '#/components/parameters/date_created_min' - $ref: '#/components/parameters/date_created_max' + - $ref: '#/components/parameters/BeforeCursorParam' + - $ref: '#/components/parameters/AfterCursorParam' post: summary: Create multiple Metafields tags: @@ -5079,6 +5081,101 @@ paths: $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess_DELETE' components: schemas: + Pagination: + type: object + description: Data about the response, including pagination and collection totals. + title: Pagination + properties: + total: + type: integer + description: | + Total number of items in the result set. + example: 36 + count: + type: integer + description: | + Total number of items in the collection response. + example: 36 + per_page: + type: integer + description: | + The amount of items returned in the collection per page, controlled by the limit parameter. + example: 50 + current_page: + type: integer + description: | + The page you are currently on within the collection. + example: 1 + total_pages: + type: integer + description: | + The total number of pages in the collection. + example: 1 + links: + type: object + description: | + Pagination links for the previous and next parts of the whole collection. + properties: + previous: + type: string + description: | + Link to the previous page returned in the response. + current: + type: string + description: | + Link to the current page returned in the response. + example: '?page=1&limit=50' + next: + type: string + description: | + Link to the next page returned in the response. + x-internal: false + CursorPagination: + type: object + description: Data about the response, including cursor pagination and collection totals. + title: CursorPagination + properties: + count: + type: integer + description: | + Total number of items in the collection response. + example: 36 + per_page: + type: integer + description: | + The amount of items returned in the collection per page, controlled by the limit parameter. + example: 50 + start_cursor: + type: string + description: | + Cursor that is referring to a start of current page. + example: "aWQ6Nw==" + end_cursor: + type: string + description: | + Cursor that is referring to a end of current page. Should be used to fetch next page. + example: "aWQ6Nw==" + links: + type: object + description: | + Pagination links for the previous and next parts of the whole collection. + properties: + previous: + type: string + description: | + Cursor to the previous page returned in the response. + example: '?page=1&after=aWQ6Nw%3D%3D' + current: + type: string + description: | + Cursor to the current page returned in the response. + example: '?page=1&after=aWQ6Nw%3D%3D' + next: + type: string + description: | + Cursor to the next page returned in the response. + example: '?page=1&after=aWQ6Nw%3D%3D' + x-internal: false modifierCondition: type: object properties: @@ -8838,53 +8935,9 @@ components: description: Data about the response, including pagination and collection totals. properties: pagination: - type: object - description: Data about the response, including pagination and collection totals. - title: Pagination - properties: - total: - type: integer - description: | - Total number of items in the result set. - example: 36 - count: - type: integer - description: | - Total number of items in the collection response. - example: 36 - per_page: - type: integer - description: | - The amount of items returned in the collection per page, controlled by the limit parameter. - example: 50 - current_page: - type: integer - description: | - The page you are currently on within the collection. - example: 1 - total_pages: - type: integer - description: | - The total number of pages in the collection. - example: 1 - links: - type: object - description: | - Pagination links for the previous and next parts of the whole collection. - properties: - previous: - type: string - description: | - Link to the previous page returned in the response. - current: - type: string - description: | - Link to the current page returned in the response. - example: '?page=1&limit=50' - next: - type: string - description: | - Link to the next page returned in the response. + $ref: '#/components/schemas/Pagination' + cursor_pagination: + $ref: '#/components/schemas/CursorPagination' additionalProperties: true title: Collection Meta x-internal: false @@ -9240,6 +9293,20 @@ components: meta: $ref: '#/components/schemas/metaEmptyFull' parameters: + BeforeCursorParam: + name: 'before' + description: 'Specify a cursor starting from which next page will be fetched (Backward order). Not required for a first page. For all subsequent page requests use a value from meta.cursor_pagination.end_cursor obtained by previous request. Works with limit, direction and other parameters. Overrides offset pagination parameter as page. Can not be used with after parameter' + in: query + required: false + schema: + type: string + AfterCursorParam: + name: 'after' + description: 'Specify a cursor starting from which next page will be fetched (Forward order). Not required for a first page. For all subsequent page requests use a value from meta.cursor_pagination.end_cursor obtained by previous request. Works with limit, direction and other parameters. Overrides offset pagination parameter as page. Can not be used with before parameter' + in: query + required: false + schema: + type: string ProductIdParam: name: product_id in: path diff --git a/reference/store_information.v3.yml b/reference/store_information.v3.yml index 08ec70b26..2918d292c 100644 --- a/reference/store_information.v3.yml +++ b/reference/store_information.v3.yml @@ -68,7 +68,14 @@ paths: - $ref: '#/components/parameters/MetafieldKeyInParam' - $ref: '#/components/parameters/MetafieldNamespaceParam' - $ref: '#/components/parameters/MetafieldNamespaceInParam' + - $ref: '#/components/parameters/IncludeFieldsParamMetafields' + - $ref: '#/components/parameters/date_modified_min' + - $ref: '#/components/parameters/date_modified_max' + - $ref: '#/components/parameters/date_created_min' + - $ref: '#/components/parameters/date_created_max' - $ref: '#/components/parameters/DirectionParam' + - $ref: '#/components/parameters/BeforeCursorParam' + - $ref: '#/components/parameters/AfterCursorParam' post: summary: Create multiple Metafields tags: @@ -292,6 +299,101 @@ components: type: apiKey in: header schemas: + Pagination: + type: object + description: Data about the response, including pagination and collection totals. + title: Pagination + properties: + total: + type: integer + description: | + Total number of items in the result set. + example: 36 + count: + type: integer + description: | + Total number of items in the collection response. + example: 36 + per_page: + type: integer + description: | + The amount of items returned in the collection per page, controlled by the limit parameter. + example: 50 + current_page: + type: integer + description: | + The page you are currently on within the collection. + example: 1 + total_pages: + type: integer + description: | + The total number of pages in the collection. + example: 1 + links: + type: object + description: | + Pagination links for the previous and next parts of the whole collection. + properties: + previous: + type: string + description: | + Link to the previous page returned in the response. + current: + type: string + description: | + Link to the current page returned in the response. + example: '?page=1&limit=50' + next: + type: string + description: | + Link to the next page returned in the response. + x-internal: false + CursorPagination: + type: object + description: Data about the response, including cursor pagination and collection totals. + title: CursorPagination + properties: + count: + type: integer + description: | + Total number of items in the collection response. + example: 36 + per_page: + type: integer + description: | + The amount of items returned in the collection per page, controlled by the limit parameter. + example: 50 + start_cursor: + type: string + description: | + Cursor that is referring to a start of current page. + example: "aWQ6Nw==" + end_cursor: + type: string + description: | + Cursor that is referring to a end of current page. Should be used to fetch next page. + example: "aWQ6Nw==" + links: + type: object + description: | + Pagination links for the previous and next parts of the whole collection. + properties: + previous: + type: string + description: | + Cursor to the previous page returned in the response. + example: '?page=1&after=aWQ6Nw%3D%3D' + current: + type: string + description: | + Cursor to the current page returned in the response. + example: '?page=1&after=aWQ6Nw%3D%3D' + next: + type: string + description: | + Cursor to the next page returned in the response. + example: '?page=1&after=aWQ6Nw%3D%3D' + x-internal: false NotFound: description: Error payload for the BigCommerce API. type: object @@ -650,53 +752,9 @@ components: description: Data about the response, including pagination and collection totals. properties: pagination: - type: object - description: Data about the response, including pagination and collection totals. - title: Pagination - properties: - total: - type: integer - description: | - Total number of items in the result set. - example: 36 - count: - type: integer - description: | - Total number of items in the collection response. - example: 36 - per_page: - type: integer - description: | - The amount of items returned in the collection per page, controlled by the limit parameter. - example: 50 - current_page: - type: integer - description: | - The page you are currently on within the collection. - example: 1 - total_pages: - type: integer - description: | - The total number of pages in the collection. - example: 1 - links: - type: object - description: | - Pagination links for the previous and next parts of the whole collection. - properties: - previous: - type: string - description: | - Link to the previous page returned in the response. - current: - type: string - description: | - Link to the current page returned in the response. - example: '?page=1&limit=50' - next: - type: string - description: | - Link to the next page returned in the response. + $ref: '#/components/schemas/Pagination' + cursor_pagination: + $ref: '#/components/schemas/CursorPagination' additionalProperties: true title: Collection Meta x-internal: false @@ -706,6 +764,73 @@ components: properties: {} description: Response metadata. parameters: + IncludeFieldsParamMetafields: + name: include_fields + in: query + description: Fields to include, in a comma-separated list. The ID and the specified fields will be returned. + style: form + explode: false + schema: + type: array + items: + type: string + enum: + - resource_id + - key + - value + - namespace + - permission_set + - resource_type + - description + - owner_client_id + - date_created + - date modified + date_created_min: + name: 'date_created:min' + description: | + 'Query parameter that lets you filter by the minimum date created, for example, `2024-05-14T09:34:00`, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields created after this date.' + required: false + in: query + schema: + type: string + date_created_max: + name: 'date_created:max' + description: | + 'Query parameter that lets you filter by the maximum date created, for example, `2024-05-14T09:34:00`, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields created before this date.' + required: false + in: query + schema: + type: string + date_modified_max: + name: 'date_modified:max' + description: | + 'Query parameter that lets you filter by the maximum date modified, for example, `2024-05-14T09:34:00`, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields modified before this date.' + required: false + in: query + schema: + type: string + date_modified_min: + name: 'date_modified:min' + description: | + 'Query parameter that lets you filter by the minimum date modified, for example, `2024-05-14T09:34:00`, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields modified after this date.' + required: false + in: query + schema: + type: string + BeforeCursorParam: + name: 'before' + description: 'Specify a cursor starting from which next page will be fetched (Backward order). Not required for a first page. For all subsequent page requests use a value from meta.cursor_pagination.end_cursor obtained by previous request. Works with limit, direction and other parameters. Overrides offset pagination parameter as page. Can not be used with after parameter' + in: query + required: false + schema: + type: string + AfterCursorParam: + name: 'after' + description: 'Specify a cursor starting from which next page will be fetched (Forward order). Not required for a first page. For all subsequent page requests use a value from meta.cursor_pagination.end_cursor obtained by previous request. Works with limit, direction and other parameters. Overrides offset pagination parameter as page. Can not be used with before parameter' + in: query + required: false + schema: + type: string ContentType: name: Content-Type in: header From 7229e5c83e11489707492d6c3deeb4081933eea9 Mon Sep 17 00:00:00 2001 From: sviat stoliarenko Date: Tue, 13 Jan 2026 19:40:02 +0200 Subject: [PATCH 4/4] add cursor related data --- reference/carts.v3.yml | 4 ++-- reference/catalog/brands_catalog.v3.yml | 4 ++-- reference/catalog/categories_catalog.v3.yml | 4 ++-- reference/catalog/product-variants_catalog.v3.yml | 4 ++-- reference/catalog/products_catalog.v3.yml | 4 ++-- reference/channels.v3.yml | 4 ++-- reference/customers.v3.yml | 4 ++-- reference/locations.v3.yml | 4 ++-- reference/orders.v3.yml | 4 ++-- reference/store_information.v3.yml | 4 ++-- 10 files changed, 20 insertions(+), 20 deletions(-) diff --git a/reference/carts.v3.yml b/reference/carts.v3.yml index 552b1ac7c..b55dd16ba 100644 --- a/reference/carts.v3.yml +++ b/reference/carts.v3.yml @@ -3834,14 +3834,14 @@ components: parameters: BeforeCursorParam: name: 'before' - description: 'Specify a cursor starting from which next page will be fetched (Backward order). Not required for a first page. For all subsequent page requests use a value from meta.cursor_pagination.end_cursor obtained by previous request. Works with limit, direction and other parameters. Overrides offset pagination parameter as page. Can not be used with after parameter' + description: 'A cursor indicating where to start retrieving the previous page of results. Use this parameter to paginate backward. Not required for the initial request. For subsequent requests, use the end_cursor value returned in meta.cursor_pagination from the previous response. Works with limit, direction, and other supported query parameters. When specified, offset-based pagination (page) is ignored. Cannot be used in combination with the after parameter.' in: query required: false schema: type: string AfterCursorParam: name: 'after' - description: 'Specify a cursor starting from which next page will be fetched (Forward order). Not required for a first page. For all subsequent page requests use a value from meta.cursor_pagination.end_cursor obtained by previous request. Works with limit, direction and other parameters. Overrides offset pagination parameter as page. Can not be used with before parameter' + description: 'A cursor indicating where to start retrieving the next page of results. Use this parameter to paginate forward. Not required for the initial request. For subsequent requests, use the start_cursor value returned in meta.cursor_pagination from the previous response. Works with limit, direction, and other supported query parameters. When specified, offset-based pagination (page) is ignored. Cannot be used in combination with the before parameter.' in: query required: false schema: diff --git a/reference/catalog/brands_catalog.v3.yml b/reference/catalog/brands_catalog.v3.yml index 6600912ff..8d7487671 100644 --- a/reference/catalog/brands_catalog.v3.yml +++ b/reference/catalog/brands_catalog.v3.yml @@ -2454,14 +2454,14 @@ components: parameters: BeforeCursorParam: name: 'before' - description: 'Specify a cursor starting from which next page will be fetched (Backward order). Not required for a first page. For all subsequent page requests use a value from meta.cursor_pagination.end_cursor obtained by previous request. Works with limit, direction and other parameters. Overrides offset pagination parameter as page. Can not be used with after parameter' + description: 'A cursor indicating where to start retrieving the previous page of results. Use this parameter to paginate backward. Not required for the initial request. For subsequent requests, use the end_cursor value returned in meta.cursor_pagination from the previous response. Works with limit, direction, and other supported query parameters. When specified, offset-based pagination (page) is ignored. Cannot be used in combination with the after parameter.' in: query required: false schema: type: string AfterCursorParam: name: 'after' - description: 'Specify a cursor starting from which next page will be fetched (Forward order). Not required for a first page. For all subsequent page requests use a value from meta.cursor_pagination.end_cursor obtained by previous request. Works with limit, direction and other parameters. Overrides offset pagination parameter as page. Can not be used with before parameter' + description: 'A cursor indicating where to start retrieving the next page of results. Use this parameter to paginate forward. Not required for the initial request. For subsequent requests, use the start_cursor value returned in meta.cursor_pagination from the previous response. Works with limit, direction, and other supported query parameters. When specified, offset-based pagination (page) is ignored. Cannot be used in combination with the before parameter.' in: query required: false schema: diff --git a/reference/catalog/categories_catalog.v3.yml b/reference/catalog/categories_catalog.v3.yml index 44b237fd3..91192cca0 100644 --- a/reference/catalog/categories_catalog.v3.yml +++ b/reference/catalog/categories_catalog.v3.yml @@ -2800,14 +2800,14 @@ components: parameters: BeforeCursorParam: name: 'before' - description: 'Specify a cursor starting from which next page will be fetched (Backward order). Not required for a first page. For all subsequent page requests use a value from meta.cursor_pagination.end_cursor obtained by previous request. Works with limit, direction and other parameters. Overrides offset pagination parameter as page. Can not be used with after parameter' + description: 'A cursor indicating where to start retrieving the previous page of results. Use this parameter to paginate backward. Not required for the initial request. For subsequent requests, use the end_cursor value returned in meta.cursor_pagination from the previous response. Works with limit, direction, and other supported query parameters. When specified, offset-based pagination (page) is ignored. Cannot be used in combination with the after parameter.' in: query required: false schema: type: string AfterCursorParam: name: 'after' - description: 'Specify a cursor starting from which next page will be fetched (Forward order). Not required for a first page. For all subsequent page requests use a value from meta.cursor_pagination.end_cursor obtained by previous request. Works with limit, direction and other parameters. Overrides offset pagination parameter as page. Can not be used with before parameter' + description: 'A cursor indicating where to start retrieving the next page of results. Use this parameter to paginate forward. Not required for the initial request. For subsequent requests, use the start_cursor value returned in meta.cursor_pagination from the previous response. Works with limit, direction, and other supported query parameters. When specified, offset-based pagination (page) is ignored. Cannot be used in combination with the before parameter.' in: query required: false schema: diff --git a/reference/catalog/product-variants_catalog.v3.yml b/reference/catalog/product-variants_catalog.v3.yml index 45e2d8c3e..b68a3b20b 100644 --- a/reference/catalog/product-variants_catalog.v3.yml +++ b/reference/catalog/product-variants_catalog.v3.yml @@ -3060,14 +3060,14 @@ components: parameters: BeforeCursorParam: name: 'before' - description: 'Specify a cursor starting from which next page will be fetched (Backward order). Not required for a first page. For all subsequent page requests use a value from meta.cursor_pagination.end_cursor obtained by previous request. Works with limit, direction and other parameters. Overrides offset pagination parameter as page. Can not be used with after parameter' + description: 'A cursor indicating where to start retrieving the previous page of results. Use this parameter to paginate backward. Not required for the initial request. For subsequent requests, use the end_cursor value returned in meta.cursor_pagination from the previous response. Works with limit, direction, and other supported query parameters. When specified, offset-based pagination (page) is ignored. Cannot be used in combination with the after parameter.' in: query required: false schema: type: string AfterCursorParam: name: 'after' - description: 'Specify a cursor starting from which next page will be fetched (Forward order). Not required for a first page. For all subsequent page requests use a value from meta.cursor_pagination.end_cursor obtained by previous request. Works with limit, direction and other parameters. Overrides offset pagination parameter as page. Can not be used with before parameter' + description: 'A cursor indicating where to start retrieving the next page of results. Use this parameter to paginate forward. Not required for the initial request. For subsequent requests, use the start_cursor value returned in meta.cursor_pagination from the previous response. Works with limit, direction, and other supported query parameters. When specified, offset-based pagination (page) is ignored. Cannot be used in combination with the before parameter.' in: query required: false schema: diff --git a/reference/catalog/products_catalog.v3.yml b/reference/catalog/products_catalog.v3.yml index 57c1332c8..c3f48d943 100644 --- a/reference/catalog/products_catalog.v3.yml +++ b/reference/catalog/products_catalog.v3.yml @@ -9295,14 +9295,14 @@ components: parameters: BeforeCursorParam: name: 'before' - description: 'Specify a cursor starting from which next page will be fetched (Backward order). Not required for a first page. For all subsequent page requests use a value from meta.cursor_pagination.end_cursor obtained by previous request. Works with limit, direction and other parameters. Overrides offset pagination parameter as page. Can not be used with after parameter' + description: 'A cursor indicating where to start retrieving the previous page of results. Use this parameter to paginate backward. Not required for the initial request. For subsequent requests, use the end_cursor value returned in meta.cursor_pagination from the previous response. Works with limit, direction, and other supported query parameters. When specified, offset-based pagination (page) is ignored. Cannot be used in combination with the after parameter.' in: query required: false schema: type: string AfterCursorParam: name: 'after' - description: 'Specify a cursor starting from which next page will be fetched (Forward order). Not required for a first page. For all subsequent page requests use a value from meta.cursor_pagination.end_cursor obtained by previous request. Works with limit, direction and other parameters. Overrides offset pagination parameter as page. Can not be used with before parameter' + description: 'A cursor indicating where to start retrieving the next page of results. Use this parameter to paginate forward. Not required for the initial request. For subsequent requests, use the start_cursor value returned in meta.cursor_pagination from the previous response. Works with limit, direction, and other supported query parameters. When specified, offset-based pagination (page) is ignored. Cannot be used in combination with the before parameter.' in: query required: false schema: diff --git a/reference/channels.v3.yml b/reference/channels.v3.yml index fa76c7ae5..d70138eeb 100644 --- a/reference/channels.v3.yml +++ b/reference/channels.v3.yml @@ -1116,14 +1116,14 @@ components: parameters: BeforeCursorParam: name: 'before' - description: 'Specify a cursor starting from which next page will be fetched (Backward order). Not required for a first page. For all subsequent page requests use a value from meta.cursor_pagination.end_cursor obtained by previous request. Works with limit, direction and other parameters. Overrides offset pagination parameter as page. Can not be used with after parameter' + description: 'A cursor indicating where to start retrieving the previous page of results. Use this parameter to paginate backward. Not required for the initial request. For subsequent requests, use the end_cursor value returned in meta.cursor_pagination from the previous response. Works with limit, direction, and other supported query parameters. When specified, offset-based pagination (page) is ignored. Cannot be used in combination with the after parameter.' in: query required: false schema: type: string AfterCursorParam: name: 'after' - description: 'Specify a cursor starting from which next page will be fetched (Forward order). Not required for a first page. For all subsequent page requests use a value from meta.cursor_pagination.end_cursor obtained by previous request. Works with limit, direction and other parameters. Overrides offset pagination parameter as page. Can not be used with before parameter' + description: 'A cursor indicating where to start retrieving the next page of results. Use this parameter to paginate forward. Not required for the initial request. For subsequent requests, use the start_cursor value returned in meta.cursor_pagination from the previous response. Works with limit, direction, and other supported query parameters. When specified, offset-based pagination (page) is ignored. Cannot be used in combination with the before parameter.' in: query required: false schema: diff --git a/reference/customers.v3.yml b/reference/customers.v3.yml index afb84d50f..c22e704de 100644 --- a/reference/customers.v3.yml +++ b/reference/customers.v3.yml @@ -2139,14 +2139,14 @@ components: parameters: BeforeCursorParam: name: 'before' - description: 'Specify a cursor starting from which next page will be fetched (Backward order). Not required for a first page. For all subsequent page requests use a value from meta.cursor_pagination.end_cursor obtained by previous request. Works with limit, direction and other parameters. Overrides offset pagination parameter as page. Can not be used with after parameter' + description: 'A cursor indicating where to start retrieving the previous page of results. Use this parameter to paginate backward. Not required for the initial request. For subsequent requests, use the end_cursor value returned in meta.cursor_pagination from the previous response. Works with limit, direction, and other supported query parameters. When specified, offset-based pagination (page) is ignored. Cannot be used in combination with the after parameter.' in: query required: false schema: type: string AfterCursorParam: name: 'after' - description: 'Specify a cursor starting from which next page will be fetched (Forward order). Not required for a first page. For all subsequent page requests use a value from meta.cursor_pagination.end_cursor obtained by previous request. Works with limit, direction and other parameters. Overrides offset pagination parameter as page. Can not be used with before parameter' + description: 'A cursor indicating where to start retrieving the next page of results. Use this parameter to paginate forward. Not required for the initial request. For subsequent requests, use the start_cursor value returned in meta.cursor_pagination from the previous response. Works with limit, direction, and other supported query parameters. When specified, offset-based pagination (page) is ignored. Cannot be used in combination with the before parameter.' in: query required: false schema: diff --git a/reference/locations.v3.yml b/reference/locations.v3.yml index 35f2be484..292cd7ffa 100644 --- a/reference/locations.v3.yml +++ b/reference/locations.v3.yml @@ -1659,14 +1659,14 @@ components: parameters: BeforeCursorParam: name: 'before' - description: 'Specify a cursor starting from which next page will be fetched (Backward order). Not required for a first page. For all subsequent page requests use a value from meta.cursor_pagination.end_cursor obtained by previous request. Works with limit, direction and other parameters. Overrides offset pagination parameter as page. Can not be used with after parameter' + description: 'A cursor indicating where to start retrieving the previous page of results. Use this parameter to paginate backward. Not required for the initial request. For subsequent requests, use the end_cursor value returned in meta.cursor_pagination from the previous response. Works with limit, direction, and other supported query parameters. When specified, offset-based pagination (page) is ignored. Cannot be used in combination with the after parameter.' in: query required: false schema: type: string AfterCursorParam: name: 'after' - description: 'Specify a cursor starting from which next page will be fetched (Forward order). Not required for a first page. For all subsequent page requests use a value from meta.cursor_pagination.end_cursor obtained by previous request. Works with limit, direction and other parameters. Overrides offset pagination parameter as page. Can not be used with before parameter' + description: 'A cursor indicating where to start retrieving the next page of results. Use this parameter to paginate forward. Not required for the initial request. For subsequent requests, use the start_cursor value returned in meta.cursor_pagination from the previous response. Works with limit, direction, and other supported query parameters. When specified, offset-based pagination (page) is ignored. Cannot be used in combination with the before parameter.' in: query required: false schema: diff --git a/reference/orders.v3.yml b/reference/orders.v3.yml index f56376e7c..5551d18ef 100644 --- a/reference/orders.v3.yml +++ b/reference/orders.v3.yml @@ -3999,14 +3999,14 @@ components: - date_modified BeforeCursorParam: name: 'before' - description: 'Specify a cursor starting from which next page will be fetched (Backward order). Not required for a first page. For all subsequent page requests use a value from meta.cursor_pagination.end_cursor obtained by previous request. Works with limit, direction and other parameters. Overrides offset pagination parameter as page. Can not be used with after parameter' + description: 'A cursor indicating where to start retrieving the previous page of results. Use this parameter to paginate backward. Not required for the initial request. For subsequent requests, use the end_cursor value returned in meta.cursor_pagination from the previous response. Works with limit, direction, and other supported query parameters. When specified, offset-based pagination (page) is ignored. Cannot be used in combination with the after parameter.' in: query required: false schema: type: string AfterCursorParam: name: 'after' - description: 'Specify a cursor starting from which next page will be fetched (Forward order). Not required for a first page. For all subsequent page requests use a value from meta.cursor_pagination.end_cursor obtained by previous request. Works with limit, direction and other parameters. Overrides offset pagination parameter as page. Can not be used with before parameter' + description: 'A cursor indicating where to start retrieving the next page of results. Use this parameter to paginate forward. Not required for the initial request. For subsequent requests, use the start_cursor value returned in meta.cursor_pagination from the previous response. Works with limit, direction, and other supported query parameters. When specified, offset-based pagination (page) is ignored. Cannot be used in combination with the before parameter.' in: query required: false schema: diff --git a/reference/store_information.v3.yml b/reference/store_information.v3.yml index 2918d292c..c0c98277c 100644 --- a/reference/store_information.v3.yml +++ b/reference/store_information.v3.yml @@ -819,14 +819,14 @@ components: type: string BeforeCursorParam: name: 'before' - description: 'Specify a cursor starting from which next page will be fetched (Backward order). Not required for a first page. For all subsequent page requests use a value from meta.cursor_pagination.end_cursor obtained by previous request. Works with limit, direction and other parameters. Overrides offset pagination parameter as page. Can not be used with after parameter' + description: 'A cursor indicating where to start retrieving the previous page of results. Use this parameter to paginate backward. Not required for the initial request. For subsequent requests, use the end_cursor value returned in meta.cursor_pagination from the previous response. Works with limit, direction, and other supported query parameters. When specified, offset-based pagination (page) is ignored. Cannot be used in combination with the after parameter.' in: query required: false schema: type: string AfterCursorParam: name: 'after' - description: 'Specify a cursor starting from which next page will be fetched (Forward order). Not required for a first page. For all subsequent page requests use a value from meta.cursor_pagination.end_cursor obtained by previous request. Works with limit, direction and other parameters. Overrides offset pagination parameter as page. Can not be used with before parameter' + description: 'A cursor indicating where to start retrieving the next page of results. Use this parameter to paginate forward. Not required for the initial request. For subsequent requests, use the start_cursor value returned in meta.cursor_pagination from the previous response. Works with limit, direction, and other supported query parameters. When specified, offset-based pagination (page) is ignored. Cannot be used in combination with the before parameter.' in: query required: false schema: