Next Commerce

Orders Upsell Create

Add an upsell to an existing order.

POST
/api/v1/orders/{ref_id}/upsells/

Authorization

API Authentication
Authorization<token>

Campaign token based authentication.

In: header

Path Parameters

ref_id*string

Order reference ID

Request Body

lines*array<>

Array of package IDs

payment_detail?
vouchers?array<>

Array of voucher codes

Response Body

application/json

curl -X POST "https://campaigns.apps.29next.com/api/v1/orders/string/upsells/" \
  -H "Authorization: " \
  -H "Content-Type: application/json" \
  -d '{
    "lines": [
      {
        "package_id": 0
      }
    ]
  }'
{
  "attribution": {
    "affiliate": "string",
    "funnel": "string",
    "gclid": "string",
    "metadata": null,
    "subaffiliate1": "string",
    "subaffiliate2": "string",
    "subaffiliate3": "string",
    "subaffiliate4": "string",
    "subaffiliate5": "string",
    "utm_campaign": "string",
    "utm_content": "string",
    "utm_medium": "string",
    "utm_source": "string",
    "utm_term": "string"
  },
  "billing_address": {
    "country": "string",
    "first_name": "string",
    "last_name": "string",
    "line1": "string",
    "line2": "string",
    "line3": "string",
    "line4": "string",
    "notes": "string",
    "phone_number": "string",
    "postcode": "string",
    "state": "string"
  },
  "currency": "str",
  "discounts": [
    {
      "amount": "string",
      "description": "string",
      "name": "string",
      "offer_id": 0
    }
  ],
  "display_taxes": "string",
  "is_test": true,
  "lines": [
    {
      "id": 0,
      "image": "string",
      "is_upsell": true,
      "price_excl_tax": "string",
      "price_excl_tax_excl_discounts": "string",
      "price_incl_tax": "string",
      "price_incl_tax_excl_discounts": "string",
      "product_id": 0,
      "product_sku": "string",
      "product_title": "string",
      "quantity": 0,
      "variant_id": 0
    }
  ],
  "number": "string",
  "order_status_url": "string",
  "payment_method": "apple_pay",
  "ref_id": "string",
  "shipping_address": {
    "country": "string",
    "first_name": "string",
    "last_name": "string",
    "line1": "string",
    "line2": "string",
    "line3": "string",
    "line4": "string",
    "notes": "string",
    "phone_number": "string",
    "postcode": "string",
    "state": "string"
  },
  "shipping_code": "string",
  "shipping_excl_tax": "string",
  "shipping_incl_tax": "string",
  "shipping_method": "string",
  "shipping_tax": "string",
  "statement_descriptor": "string",
  "supports_post_purchase_upsells": true,
  "total_discounts": "string",
  "total_excl_tax": "string",
  "total_incl_tax": "string",
  "total_tax": "string",
  "user": {
    "accepts_marketing": true,
    "email": "user@example.com",
    "first_name": "string",
    "ip": "string",
    "language": "string",
    "last_name": "string",
    "phone_number": "string",
    "user_agent": "string"
  }
}