API Reference
  1. WSHOP API
  2. Cross Sells

Update a cross-sell

patch
https://{instance}.wshop.cloud/api/v1/cross-sells/update/

Only the documented HTTP method is accepted (CROSSSELL0001 otherwise).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

ID of the cross-sell to update

Body Params

Only the provided fields are updated. Unknown fields are rejected. lang is required when a text field is sent.

integer

Site of the cross-sell, among the sites of the API user. Default: first site of the user (the cross-sell is not found if it belongs to another site).

string
length ≤ 2

Language of the texts (title, wording, description, cta, link); must be a language of the site

string
length between 1 and 100

Cross-sell title on the back office

string
length between 1 and 100

Cross-sell title on the front office

string

Cross-sell description for the front office

string
length between 1 and 50

Title of the CTA

string
length between 1 and 255

CTA link

integer
enum

Must be an integer (not a string or boolean)

Allowed:
integer
enum

Cross-sell merch type (1 = manual, 2 = dynamic). Dynamic is only available for the cart location (3).

Allowed:
integer
enum

Cross-sell display (1 = carousel, 2 = without carousel, 3 = all products)

Allowed:
integer
enum

Cross-sell location (1 = product page, 2 = home or page ADV, 3 = cart)

Allowed:
content
array of strings

Replaces all the products. External references of products of the site; only for manual cross-sells (type 1).

content
rules
array of objects

Replaces all the rules. Only for dynamic cross-sells (type 2, cart location).

rules
Responses

Updated 2 months ago

Did this page help you?
Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 months ago

Did this page help you?