> ## Documentation Index > Fetch the complete documentation index at: https://docs.shoply.gg/llms.txt > Use this file to discover all available pages before exploring further. # Update an upsell > Saves the upsell whole: send every field as it should be, not only what changed. Its kind does not change. Needs the `upsells.write` permission (Change Upsells). ## OpenAPI ````yaml /api-reference/openapi.json put /stores/{storeId}/upsells/{upsellId} openapi: 3.1.0 info: title: Shoply API version: '1' description: >- Everything a store's own server can do with a secret API key: its catalogue, orders, customers, marketing, finance and the rest of what the dashboard does. And the Customer API, which a buyer's own device asks with a token of theirs. servers: - url: https://api.shoply.gg/v1 security: - apiKey: [] tags: - name: API key - name: Store - name: Domain - name: Payment methods - name: Analytics - name: Storefronts - name: Storefront code - name: Payment Routing - name: Custom payment methods - name: Products - name: Product pictures - name: Stock - name: Categories - name: Upsells - name: Subscriptions - name: Orders - name: Invoices - name: Reviews - name: Coupons - name: Coupon categories - name: Coupon pop-up - name: Sales - name: Blog - name: Search settings - name: Redirects - name: Sitemap - name: Cart Recovery - name: Email Marketing - name: Email Templates - name: Customers - name: Affiliates - name: Support Tickets - name: Blacklist - name: Fraud protection - name: Disputes - name: Finance - name: Tax - name: Expenses - name: Expense setup - name: API requests - name: Webhook endpoints - name: Webhook deliveries - name: Customer API paths: /stores/{storeId}/upsells/{upsellId}: put: tags: - Upsells summary: Update an upsell description: >- Saves the upsell whole: send every field as it should be, not only what changed. Its kind does not change. Needs the `upsells.write` permission (Change Upsells). operationId: upsells.update parameters: - name: storeId in: path required: true description: >- The store's ID. A key reaches the store it was made in: `GET /key` answers which. schema: type: string - name: upsellId in: path required: true description: The upsell. schema: type: string - name: tz in: query required: false description: >- The time zone `startsAt` and `endsAt` are read in when they name none, as an IANA name. Left out, UTC. schema: type: string example: Europe/Berlin - $ref: '#/components/parameters/IdempotencyKey' requestBody: required: true content: application/json: schema: type: object properties: kind: type: string description: >- What kind of upsell it is. Set when it is made, and never changes. enum: - addon - cart - checkout - together - upgrade name: type: string description: >- Up to 80 characters. An add-on that is a plain extra needs one: it is what the buyer reads. example: Priority Setup sells: type: string description: >- An add-on only: a plain extra, or one of the store's products. enum: - extra - product default: product productId: type: string description: >- What it sells, or for `together` what is shown. Not for a plain extra. variantId: type: string description: Which of the product's variants. Optional for `together`. price: type: number description: An add-on's price as an add-on, in the store's currency. example: 4.99 cost: type: number description: A plain extra's cost for one, for Finance. message: type: string description: >- A plain extra's message to the buyer after payment, up to 2,000 characters. offered: type: string description: >- An add-on: the buyer ticks it, it is ticked for them, or it is always in the order. enum: - optional - ticked - included default: optional charged: type: string description: 'An add-on: once an order, or for each unit of its line.' enum: - order - item default: order trigger: type: string description: 'A cart or checkout offer: what it asks for in the cart.' enum: - product - category - amount default: product minSubtotal: type: number description: 'With `trigger` `amount`: the cart total it asks for.' discountType: type: string description: >- A cart, checkout or upgrade offer: what it takes off its product, on that order only. enum: - none - percent - amount default: none discountValue: type: number description: >- How much: above 0 and up to 100 for `percent`, an amount for `amount`. targets: type: array description: >- Up to 100. What an add-on is offered with (products or categories), what a cart or checkout offer asks for, what `together` is shown under and what an upgrade replaces (products). items: type: object properties: type: type: string description: What `id` names. enum: - product - category id: type: string description: The product or the category. required: - type - id words: type: string description: >- The line over it where the buyer meets it, up to 80 characters. Left out, the buyer's language's own words. startsAt: type: string description: When it starts, as a date and time. Left out, now. endsAt: type: string description: When it ends, as a date and time. Left out, never. firstOrders: type: boolean description: >- A checkout offer only, since the checkout is where the buyer is known: offered only to a buyer who has never paid at the store. default: false hideOwned: type: boolean description: >- A checkout offer only: not offered to a buyer who has bought it before. default: false enabled: type: boolean description: Whether it is offered. default: true required: - kind responses: '200': description: It worked. content: application/json: schema: type: object properties: success: type: boolean message: nullable: true code: nullable: true data: type: object properties: id: type: string kind: type: string name: type: string enabled: type: boolean sells: type: string productId: nullable: true variantId: nullable: true productName: nullable: true productImage: nullable: true variantLabel: nullable: true variantPrice: nullable: true price: type: number cost: nullable: true message: type: string offered: type: string charged: type: string trigger: type: string minSubtotal: nullable: true discountType: type: string discountValue: type: integer words: type: string startsAt: nullable: true endsAt: nullable: true firstOrders: type: boolean hideOwned: type: boolean targets: type: array items: type: object properties: type: type: string id: type: string name: type: string shown: type: integer taken: type: integer revenue: type: integer dateCreated: type: string updatedAt: type: string example: success: true message: null code: null data: id: 606a408d-8ce9-43d9-9950-231f89f4c901 kind: addon name: Priority Setup enabled: true sells: extra productId: null variantId: null productName: null productImage: null variantLabel: null variantPrice: null price: 5.99 cost: null message: We will be in touch within a day to set it up. offered: optional charged: order trigger: product minSubtotal: null discountType: none discountValue: 0 words: '' startsAt: null endsAt: null firstOrders: false hideOwned: false targets: - type: product id: f463e265-097a-4235-bc2f-5239b19a9874 name: Northwind Pro shown: 0 taken: 0 revenue: 0 dateCreated: '2026-10-22T16:20:18Z' updatedAt: '2026-10-22T16:20:18.728Z' '401': $ref: '#/components/responses/NoKey' '403': $ref: '#/components/responses/NotAllowed' '404': $ref: '#/components/responses/NotFound' '422': $ref: '#/components/responses/Refused' '429': $ref: '#/components/responses/TooMany' x-codeSamples: - lang: javascript label: Node.js source: | import Shoply from "@shoplygg/node"; const shoply = new Shoply({ apiKey: process.env.SHOPLY_API_KEY }); const result = await shoply.upsells.update("UPSELL_ID", { kind: "addon", }); - lang: php label: PHP source: | getenv('SHOPLY_API_KEY')]); $result = $shoply->upsells->update('UPSELL_ID', [ 'kind' => 'addon', ]); - lang: python label: Python source: | import shoply client = shoply.Client() # reads SHOPLY_API_KEY result = client.upsells.update("UPSELL_ID", kind="addon") components: parameters: IdempotencyKey: name: Idempotency-Key in: header required: false description: >- A word of your own for this one change, up to 180 letters, digits, dots, dashes, underscores and colons. Sent again with the same key, the request is not carried out twice: the first answer comes back, with `Idempotent-Replay: true`. schema: type: string responses: NoKey: description: >- No API key was sent, or the one sent is not a live key: `api_key_required`, `invalid_api_key`. content: application/json: schema: $ref: '#/components/schemas/Refusal' NotAllowed: description: >- The key is real and may not do this: `missing_scope` (with `requiredScope`), `ip_not_allowed`, `account_unavailable`, or `dashboard_only` for something only a person in the dashboard may do. content: application/json: schema: $ref: '#/components/schemas/Refusal' NotFound: description: >- There is no such thing in this store: `not_found`. A store that is not the key's own is answered the same way. content: application/json: schema: $ref: '#/components/schemas/Refusal' Refused: description: >- The request was understood and not carried out. `validation_failed` says what is wrong with each field under `errors`; other codes are the route's own. content: application/json: schema: $ref: '#/components/schemas/Refusal' TooMany: description: >- The key has used up its budget for now: `rate_limited`. `Retry-After` says how many seconds to wait. content: application/json: schema: $ref: '#/components/schemas/Refusal' schemas: Refusal: type: object properties: success: type: boolean example: false message: type: string description: What is wrong, in words for a person. code: type: string description: What is wrong, as a word that does not change. data: nullable: true errors: type: object description: >- For `validation_failed`: what is wrong with each field, by the field's name. additionalProperties: type: string required: - success - message - code securitySchemes: apiKey: type: http scheme: bearer description: >- A secret API key, made under Developers in the dashboard: `Authorization: Bearer shoply_sk_...` ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.