Create an upsell - Shoply Documentation

Node.js

import Shoply from "@shoplygg/node";

const shoply = new Shoply({ apiKey: process.env.SHOPLY_API_KEY });

const result = await shoply.upsells.create({
  kind: "addon",
});

curl --request POST \
  --url https://api.shoply.gg/v1/stores/{storeId}/upsells \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Priority Setup",
  "sells": "product",
  "productId": "<string>",
  "variantId": "<string>",
  "price": 4.99,
  "cost": 123,
  "message": "<string>",
  "offered": "optional",
  "charged": "order",
  "trigger": "product",
  "minSubtotal": 123,
  "discountType": "none",
  "discountValue": 123,
  "targets": [
    {
      "id": "<string>"
    }
  ],
  "words": "<string>",
  "startsAt": "<string>",
  "endsAt": "<string>",
  "firstOrders": false,
  "hideOwned": false,
  "enabled": true
}
'

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.shoply.gg/v1/stores/{storeId}/upsells"

	payload := strings.NewReader("{\n  \"name\": \"Priority Setup\",\n  \"sells\": \"product\",\n  \"productId\": \"<string>\",\n  \"variantId\": \"<string>\",\n  \"price\": 4.99,\n  \"cost\": 123,\n  \"message\": \"<string>\",\n  \"offered\": \"optional\",\n  \"charged\": \"order\",\n  \"trigger\": \"product\",\n  \"minSubtotal\": 123,\n  \"discountType\": \"none\",\n  \"discountValue\": 123,\n  \"targets\": [\n    {\n      \"id\": \"<string>\"\n    }\n  ],\n  \"words\": \"<string>\",\n  \"startsAt\": \"<string>\",\n  \"endsAt\": \"<string>\",\n  \"firstOrders\": false,\n  \"hideOwned\": false,\n  \"enabled\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.shoply.gg/v1/stores/{storeId}/upsells")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Priority Setup\",\n  \"sells\": \"product\",\n  \"productId\": \"<string>\",\n  \"variantId\": \"<string>\",\n  \"price\": 4.99,\n  \"cost\": 123,\n  \"message\": \"<string>\",\n  \"offered\": \"optional\",\n  \"charged\": \"order\",\n  \"trigger\": \"product\",\n  \"minSubtotal\": 123,\n  \"discountType\": \"none\",\n  \"discountValue\": 123,\n  \"targets\": [\n    {\n      \"id\": \"<string>\"\n    }\n  ],\n  \"words\": \"<string>\",\n  \"startsAt\": \"<string>\",\n  \"endsAt\": \"<string>\",\n  \"firstOrders\": false,\n  \"hideOwned\": false,\n  \"enabled\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.shoply.gg/v1/stores/{storeId}/upsells")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Priority Setup\",\n  \"sells\": \"product\",\n  \"productId\": \"<string>\",\n  \"variantId\": \"<string>\",\n  \"price\": 4.99,\n  \"cost\": 123,\n  \"message\": \"<string>\",\n  \"offered\": \"optional\",\n  \"charged\": \"order\",\n  \"trigger\": \"product\",\n  \"minSubtotal\": 123,\n  \"discountType\": \"none\",\n  \"discountValue\": 123,\n  \"targets\": [\n    {\n      \"id\": \"<string>\"\n    }\n  ],\n  \"words\": \"<string>\",\n  \"startsAt\": \"<string>\",\n  \"endsAt\": \"<string>\",\n  \"firstOrders\": false,\n  \"hideOwned\": false,\n  \"enabled\": true\n}"

response = http.request(request)
puts response.read_body

{
  "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": 4.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.717Z"
  }
}

{
  "success": false,
  "message": "<string>",
  "code": "<string>",
  "data": null,
  "errors": {}
}

{
  "success": false,
  "message": "<string>",
  "code": "<string>",
  "data": null,
  "errors": {}
}

{
  "success": false,
  "message": "<string>",
  "code": "<string>",
  "data": null,
  "errors": {}
}

{
  "success": false,
  "message": "<string>",
  "code": "<string>",
  "data": null,
  "errors": {}
}

{
  "success": false,
  "message": "<string>",
  "code": "<string>",
  "data": null,
  "errors": {}
}

POST

stores

{storeId}

upsells

Node.js

import Shoply from "@shoplygg/node";

const shoply = new Shoply({ apiKey: process.env.SHOPLY_API_KEY });

const result = await shoply.upsells.create({
  kind: "addon",
});

curl --request POST \
  --url https://api.shoply.gg/v1/stores/{storeId}/upsells \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Priority Setup",
  "sells": "product",
  "productId": "<string>",
  "variantId": "<string>",
  "price": 4.99,
  "cost": 123,
  "message": "<string>",
  "offered": "optional",
  "charged": "order",
  "trigger": "product",
  "minSubtotal": 123,
  "discountType": "none",
  "discountValue": 123,
  "targets": [
    {
      "id": "<string>"
    }
  ],
  "words": "<string>",
  "startsAt": "<string>",
  "endsAt": "<string>",
  "firstOrders": false,
  "hideOwned": false,
  "enabled": true
}
'

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.shoply.gg/v1/stores/{storeId}/upsells"

	payload := strings.NewReader("{\n  \"name\": \"Priority Setup\",\n  \"sells\": \"product\",\n  \"productId\": \"<string>\",\n  \"variantId\": \"<string>\",\n  \"price\": 4.99,\n  \"cost\": 123,\n  \"message\": \"<string>\",\n  \"offered\": \"optional\",\n  \"charged\": \"order\",\n  \"trigger\": \"product\",\n  \"minSubtotal\": 123,\n  \"discountType\": \"none\",\n  \"discountValue\": 123,\n  \"targets\": [\n    {\n      \"id\": \"<string>\"\n    }\n  ],\n  \"words\": \"<string>\",\n  \"startsAt\": \"<string>\",\n  \"endsAt\": \"<string>\",\n  \"firstOrders\": false,\n  \"hideOwned\": false,\n  \"enabled\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.shoply.gg/v1/stores/{storeId}/upsells")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Priority Setup\",\n  \"sells\": \"product\",\n  \"productId\": \"<string>\",\n  \"variantId\": \"<string>\",\n  \"price\": 4.99,\n  \"cost\": 123,\n  \"message\": \"<string>\",\n  \"offered\": \"optional\",\n  \"charged\": \"order\",\n  \"trigger\": \"product\",\n  \"minSubtotal\": 123,\n  \"discountType\": \"none\",\n  \"discountValue\": 123,\n  \"targets\": [\n    {\n      \"id\": \"<string>\"\n    }\n  ],\n  \"words\": \"<string>\",\n  \"startsAt\": \"<string>\",\n  \"endsAt\": \"<string>\",\n  \"firstOrders\": false,\n  \"hideOwned\": false,\n  \"enabled\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.shoply.gg/v1/stores/{storeId}/upsells")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Priority Setup\",\n  \"sells\": \"product\",\n  \"productId\": \"<string>\",\n  \"variantId\": \"<string>\",\n  \"price\": 4.99,\n  \"cost\": 123,\n  \"message\": \"<string>\",\n  \"offered\": \"optional\",\n  \"charged\": \"order\",\n  \"trigger\": \"product\",\n  \"minSubtotal\": 123,\n  \"discountType\": \"none\",\n  \"discountValue\": 123,\n  \"targets\": [\n    {\n      \"id\": \"<string>\"\n    }\n  ],\n  \"words\": \"<string>\",\n  \"startsAt\": \"<string>\",\n  \"endsAt\": \"<string>\",\n  \"firstOrders\": false,\n  \"hideOwned\": false,\n  \"enabled\": true\n}"

response = http.request(request)
puts response.read_body

{
  "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": 4.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.717Z"
  }
}

{
  "success": false,
  "message": "<string>",
  "code": "<string>",
  "data": null,
  "errors": {}
}

{
  "success": false,
  "message": "<string>",
  "code": "<string>",
  "data": null,
  "errors": {}
}

{
  "success": false,
  "message": "<string>",
  "code": "<string>",
  "data": null,
  "errors": {}
}

{
  "success": false,
  "message": "<string>",
  "code": "<string>",
  "data": null,
  "errors": {}
}

{
  "success": false,
  "message": "<string>",
  "code": "<string>",
  "data": null,
  "errors": {}
}

Authorizations

Authorization

string

header

required

A secret API key, made under Developers in the dashboard: Authorization: Bearer shoply_sk_...

Headers

Idempotency-Key

string

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.

Path Parameters

storeId

string

required

The store's ID. A key reaches the store it was made in: GET /key answers which.

Query Parameters

string

The time zone startsAt and endsAt are read in when they name none, as an IANA name. Left out, UTC.

Example:

"Europe/Berlin"

Body

application/json

kind

enum<string>

required

What kind of upsell it is. Set when it is made, and never changes.

Available options:

addon,

cart,

checkout,

together,

upgrade

name

string

Up to 80 characters. An add-on that is a plain extra needs one: it is what the buyer reads.

Example:

"Priority Setup"

sells

enum<string>

default:product

An add-on only: a plain extra, or one of the store's products.

Available options:

extra,

product

productId

string

What it sells, or for together what is shown. Not for a plain extra.

variantId

string

Which of the product's variants. Optional for together.

price

number

An add-on's price as an add-on, in the store's currency.

Example:

4.99

cost

number

A plain extra's cost for one, for Finance.

message

string

A plain extra's message to the buyer after payment, up to 2,000 characters.

offered

enum<string>

default:optional

An add-on: the buyer ticks it, it is ticked for them, or it is always in the order.

Available options:

optional,

ticked,

included

charged

enum<string>

default:order

An add-on: once an order, or for each unit of its line.

Available options:

order,

item

trigger

enum<string>

default:product

A cart or checkout offer: what it asks for in the cart.

Available options:

product,

category,

amount

minSubtotal

number

With trigger amount: the cart total it asks for.

discountType

enum<string>

default:none

A cart, checkout or upgrade offer: what it takes off its product, on that order only.

Available options:

none,

percent,

amount

discountValue

number

How much: above 0 and up to 100 for percent, an amount for amount.

targets

object[]

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).

Show child attributes

words

string

The line over it where the buyer meets it, up to 80 characters. Left out, the buyer's language's own words.

startsAt

string

When it starts, as a date and time. Left out, now.

endsAt

string

When it ends, as a date and time. Left out, never.

firstOrders

boolean

default:false

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.

hideOwned

boolean

default:false

A checkout offer only: not offered to a buyer who has bought it before.

enabled

boolean

default:true

Whether it is offered.

Response

It worked.

success

boolean

message

unknown

code

unknown

data

object

Show child attributes