Path parameters

  • channelLinkId string Required
application/json

Body Required

  • account string Required
  • location string Required
  • items array[object] Required
    Hide items attributes Show items attributes object
    • plu string Required
    • quantity integer

      Default value is 1.

Responses

  • 200 application/json

    Success

    Hide response attributes Show response attributes object
    • items array[object]
      Hide items attributes Show items attributes object
      • plu string
      • quantity integer
    • upsellMetricId string
  • 403 application/json

    Forbidden

  • 422 application/json

    Validation Error

POST /upsell/channel/{channelLinkId}
curl \
 --request POST 'https://api.staging.deliverect.com/upsell/channel/{channelLinkId}' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"items":[{"plu":"PLU1","quantity":1},{"plu":"PLU2","quantity":2},{"plu":"PLU3","quantity":1}],"account":"67f93fc709a75f7e9e36da7f","location":"67f9413754e4db73b3ed1e9f","channelLink":"67f94128c490d2ed895a34e7"}'
Request example
{
  "items": [
    {
      "plu": "PLU1",
      "quantity": 1
    },
    {
      "plu": "PLU2",
      "quantity": 2
    },
    {
      "plu": "PLU3",
      "quantity": 1
    }
  ],
  "account": "67f93fc709a75f7e9e36da7f",
  "location": "67f9413754e4db73b3ed1e9f",
  "channelLink": "67f94128c490d2ed895a34e7"
}
Response examples (200)
{
  "items": [
    {
      "plu": "PLU-1",
      "quantity": 1
    },
    {
      "plu": "PLU-2",
      "quantity": 1
    },
    {
      "plu": "PLU-3",
      "quantity": 1
    }
  ],
  "upsellMetricId": "686ecf6141884e91f9126fc9"
}
Response examples (403)
{
  "code": "insufficient_permissions",
  "description": "Not allowed to access this location."
}
Response examples (422)
[
  {
    "loc": [
      "location"
    ],
    "msg": "Field required",
    "type": "missing"
  }
]