Update offer

Update an existing upsell offer or order bump.

PUT /api/public/v1/offers/{id}

Update offer

cURL

curl --request PUT \
  --url http://app.localhost:3000/api/public/v1/offers/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": {
    "offerTitle": "<string>",
    "enabled": true,
    "triggers": [
      {
        "productId": "<string>"
      }
    ],
    "offers": [
      {
        "productId": "<string>",
        "variantId": "<string>",
        "priceId": "<string>",
        "title": "<string>",
        "titleTrans": {}
      }
    ],
    "orderBumpOffers": [
      {
        "productId": "<string>",
        "variantId": "<string>",
        "priceId": "<string>",
        "precheck": true,
        "overrideImageUrl": "<string>",
        "id": "<string>",
        "quantity": 1,
        "titleTrans": {},
        "descriptionTrans": {},
        "displayPrice": true,
        "displayCompareAtPrice": false,
        "compareAtPriceDiscount": 20,
        "rules": []
      }
    ]
  }
}
'

default

{
  "message": "<string>",
  "code": "<string>",
  "issues": [
    {
      "message": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id · string · required

Body

application/json

data · object · required

Show child attributes

Response

200

application/json

Successful response