Skip to content

Commit

Permalink
[DEVDOCS-5831/PAPI-2091]: Carts v3 and Store information V2, add stor…
Browse files Browse the repository at this point in the history
…e-level metafield's open api spec (#197) (#199)

<!-- Ticket number or summary of work -->
# [PAPI-2091] [DEVDOCS-5831]


## What changed?
- Store metafield's open api spec is now available in Store Information
V2

## 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]. -->
* Store metafields is now available for use. Add metafield data to a
merchant's store using this set of APIs. Metafields can be created,
updated, and deleted on stores.

## Anything else?
<!-- Add related PRs, salient notes, additional ticket numbers, etc. -->
[PAPI-2091]:

https://bigcommercecloud.atlassian.net/browse/PAPI-2091?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ

ping @bc-tayvs  



---------

<!-- Ticket number or summary of work -->
# [DEVDOCS-]


## What changed?
<!-- Provide a bulleted list in the present tense -->
*  Add Store metafields is now available. 

## 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}


[PAPI-2091]:
https://bigcommercecloud.atlassian.net/browse/PAPI-2091?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ
[PAPI-2091]:
https://bigcommercecloud.atlassian.net/browse/PAPI-2091?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ

[DEVDOCS-5831]:
https://bigcommercecloud.atlassian.net/browse/DEVDOCS-5831?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ

---------

Co-authored-by: sviat stoliarenko <[email protected]>
Co-authored-by: Sarah Riehl <[email protected]>
Co-authored-by: Traci Porter <[email protected]>
  • Loading branch information
4 people authored Oct 18, 2024
1 parent c17543e commit 327c387
Show file tree
Hide file tree
Showing 3 changed files with 759 additions and 23 deletions.
2 changes: 2 additions & 0 deletions .idea/.gitignore

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

23 changes: 4 additions & 19 deletions reference/carts.v3.yml
Original file line number Diff line number Diff line change
Expand Up @@ -1037,19 +1037,6 @@ paths:
title: Input is invalid
type: 'https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes'
detail: Syntax error
'404':
description: |
The `Metafield` was not found.
content:
application/json:
schema:
$ref: '#/components/schemas/NotFound'
examples:
example-1:
value:
status: 404
title: The resource at that URL was not found.
type: 'https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes'
'422':
description: |
Response object for metafields creation with partial success.
Expand Down Expand Up @@ -3338,12 +3325,10 @@ components:
description: |
Response payload for the BigCommerce API.
x-internal: false
allOf:
- type: object
properties:
data:
$ref: '#/components/schemas/Metafield'
- $ref: '#/components/schemas/metaCollection_open'
type: object
properties:
data:
$ref: '#/components/schemas/Metafield'
Metafield:
description: |
Allows app partners to write custom data to various resources in the API.
Expand Down
Loading

0 comments on commit 327c387

Please sign in to comment.