> ## Documentation Index
> Fetch the complete documentation index at: https://www.spacebring.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Partially update a product
> Update the fields of a product that the request sets; omitted fields keep their current values. OAuth
Required scopes: shop
## OpenAPI
````yaml /assets/openapi.json patch /shop/products/v1/{productId}
openapi: 3.0.2
info:
title: Spacebring
version: 1.0.0
termsOfService: https://www.spacebring.com/terms
servers:
- url: https://api.spacebring.com
security: []
paths:
/shop/products/v1/{productId}:
patch:
tags:
- Shop
summary: Partially update a product
description: >-
Update the fields of a product that the request sets; omitted fields
keep their current values. OAuth
Required scopes:
shop
operationId: patchProduct
parameters:
- in: path
name: productId
required: true
description: The id of the product.
schema:
type: string
format: uuid
- in: header
name: spacebring-network-id
schema:
type: string
format: uuid
required: false
description: >-
The id of the network. Required when using bearer token
authentication
requestBody:
$ref: '#/components/requestBodies/patchProduct'
responses:
'204':
description: No Content
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/responseError'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/responseError'
security:
- BasicAuth: []
- OAuth2:
- shop
components:
requestBodies:
patchProduct:
content:
application/json:
schema:
type: object
properties:
product:
type: object
properties:
categoryRef:
description: >-
ID of the category this product belongs to. Send null to
remove the product from its category.
nullable: true
type: string
format: uuid
description:
type: string
description: Product description.
featured:
description: Whether the product is featured.
type: boolean
media:
description: Media files of the product, replacing the current ones.
type: array
items:
type: object
properties:
key:
type: string
description: Storage key of the media file.
required:
- key
options:
description: >-
Purchasable options, replacing the current ones. Keep the
id of every option that should survive; an option keeps
the stored value of every field it omits.
type: array
items:
type: object
properties:
available:
description: Whether this option is available for purchase.
type: boolean
customTax:
description: Custom tax settings for this option.
type: object
properties:
enabled:
type: boolean
description: Whether custom tax is applied to this option.
rate:
description: Custom tax rate (non-negative).
type: number
minimum: 0
description:
type: string
description: Option description.
id:
description: >-
UUID of the option to change. Omit to add a new
option.
type: string
format: uuid
price:
description: Pricing for this option.
type: object
properties:
credits:
description: Credits pricing.
type: object
properties:
amount:
description: Price in location credits.
type: number
minimum: 0
enabled:
type: boolean
description: >-
Whether credits payment is enabled for this
option.
money:
description: Money pricing.
type: object
properties:
amount:
description: Price in money (location currency).
type: number
minimum: 0
enabled:
type: boolean
description: >-
Whether money payment is enabled for this
option.
stock:
description: Stock settings for this option.
type: object
properties:
enabled:
type: boolean
description: Whether stock tracking is enabled.
quantity:
description: Units on hand when stock is enabled.
type: number
minimum: 0
maximum: 1000000
title:
type: string
minLength: 1
description: Option title.
order:
description: Checkout availability settings for this product.
type: object
properties:
enabled:
type: boolean
description: Whether the product can be purchased through checkout.
required:
- enabled
refundPolicy:
type: string
enum:
- noRefund
- statusNew
description: >-
Refund policy. noRefund: purchases are final. statusNew:
refunds allowed while order is in new state.
title:
description: Product title.
type: string
minLength: 1
visibility:
type: string
enum:
- public
- admins
- members
- networkMembers
description: Who can see this product.
description: >-
Product fields to change. Omitted fields keep their current
values.
required:
- product
required: true
schemas:
responseError:
type: object
properties:
message:
type: string
type:
type: string
securitySchemes:
BasicAuth:
type: http
description: >-
See our [authentication
documentation](https://www.spacebring.com/docs/developer/api/authentication#basic-authentication)
for how to authorize your requests
scheme: basic
OAuth2:
type: oauth2
description: >-
See our [authentication
documentation](https://www.spacebring.com/docs/developer/api/authentication#oauth2)
for how to authorize your requests
flows:
authorizationCode:
authorizationUrl: https://oauth2.spacebring.com/api/oauth2/authorize
tokenUrl: https://oauth2.spacebring.com/api/oauth2/token
refreshUrl: https://oauth2.spacebring.com/api/oauth2/token
scopes:
benefits.readonly: Read benefits and applications
benefits: Read and write benefits and applications
checkIns.readonly: Read check-ins
checkIns: Read and write check-ins
community.readonly: Read community companies and memberships
community: Read and write community companies and memberships
events.readonly: Read events and tickets
events: Read and write events and tickets
feed.readonly: Read feed posts
feed: Read and write feed posts
invoices.readonly: Read contracts, credit notes, discounts and invoices
invoices: Read and write contract, credit notes, discounts and invoices
locations.readonly: Read locations
locations: Read and write locations
plans.readonly: Read plans
plans: Read and write plans
resources.readonly: Read resources and bookings
resources: Read and write resources and bookings
subscriptions.readonly: Read subscriptions
subscriptions: Read and write subscriptions
shop.readonly: Read products and orders
shop: Read and write products and orders
support.readonly: Read support tickets
support: Read and write support tickets
transactions.readonly: Read transactions
transactions: Read and write transactions
visitors.readonly: Read visitors
visitors: Read and write visitors
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.