Sign in
Order Controller

Create customer upSell order

Allows customers to purchase recommended products. Fetches details from parent order. No authentication required.

post/orders/upsell

Request body

parentOrderIdnumber required

Parent order ID to fetch customer and shipping details

productIdsnumber[] required

Array of product IDs to purchase as upsell

upSellSource'ORDER' | 'EMAIL' | 'ADMIN' | 'Document Link'

Source of the upsell order

orderLng'en' | 'fr' | 'es'

Order language

suburbstring

Property suburb

shippingAddress1string

Shipping address line 1

shippingAddress2string

Shipping address line 2

shippingCitystring

Shipping city

shippingPostcodestring

Shipping postcode

shippingCountystring

Shipping county

shippingPhonestring

Shipping phone number

shippingFirstNamestring

Shipping first name

shippingLastNamestring

Shipping last name

hasSwimmingPoolboolean

Whether property has a swimming pool

instrumentCopyNumberstring

Instrument copy number (optional)

Example request

{
  "parentOrderId": 123,
  "productIds": [
    2,
    3,
    5
  ],
  "upSellSource": "ORDER",
  "orderLng": "en",
  "suburb": "Ponsonby",
  "shippingAddress1": "221B Baker Street",
  "shippingAddress2": "Marylebone",
  "shippingCity": "London",
  "shippingPostcode": "NW1 6XE",
  "shippingCounty": "Greater London",
  "shippingPhone": "+441234567890",
  "shippingFirstName": "Sherlock",
  "shippingLastName": "Holmes",
  "hasSwimmingPool": true,
  "instrumentCopyNumber": "123456789"
}

Response

UpSell order created successfully

orderIdnumber required

Order ID

customerEmailstring required

Customer email

emailValidboolean required

Email valid

emailValidationStatusstring

Email validation status (UNKNOWN, VALID, INVALID)

isNewCustomerboolean

True if customer was auto-created during this order

documentAccessLinkstring

Permanent document access link

Example response

{
  "orderId": 1,
  "customerEmail": "customer@example.com",
  "emailValid": true,
  "emailValidationStatus": "UNKNOWN",
  "isNewCustomer": true,
  "documentAccessLink": "https://api.example.com/orders/track/abc-123-xyz"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.