Custom API Documentatie | Nousu
nousuCustom APIv1.0.0

Nousu Custom API

Standaard API-contract waarmee bedrijven met een eigen e-commerce systeem integreren met het Nousu AI-klantenserviceplatform. **Hoe het werkt**: je implementeert de onderstaande endpoints in je eigen backend. Nousu roept deze aan wanneer een klant via de chatbot vraagt naar bestellingen, retouren of producten.

Authenticatie

Alle requests vereisen een Bearer token in de Authorization header:

http
Authorization: Bearer {jouw_api_token}
Content-Type: application/json
User-Agent: Nousu/1.0

Orders

Bestelinformatie ophalen

Returns

Retouren aanmaken en updaten

Products

Producten zoeken en catalogus synchroniseren

Customers

Klantgegevens opzoeken en verifiëren

Mutations

Gegevens wijzigen (adres, e-mail)

Policies

Winkelbeleid en kortingscodes

Webhooks

Real-time event notificaties (optioneel)

Schemas

Hieronder staan alle datamodellen die gebruikt worden in requests en responses. Verplichte velden zijn gemarkeerd.

ErrorResponse

successverplicht
boolean
errorverplicht
object
codeverplicht
string

Machine-leesbare foutcode

messageverplicht
string

Leesbare foutmelding

details
string

Optionele extra context

Address

name
string
street
string
city
string
postalCode
string
country
string

ISO 3166-1 alpha-2 landcode

OrderResponse

successverplicht
boolean
dataverplicht
StandardOrder
idverplicht
string
numberverplicht
string
statusverplicht
string · enum
pendingprocessingshippeddeliveredcancelled
createdAtverplicht
string · date-time
displayFulfillmentStatusverplicht
string

Leesbare fulfillment-status (bijv. 'Verzonden', 'In verwerking')

displayFinancialStatusverplicht
string

Leesbare betaalstatus (bijv. 'Betaald', 'Terugbetaald')

customerverplicht
OrderCustomer
email
string · email
phone
string
name
string
itemsverplicht
array
idverplicht
string
titleverplicht
string
quantityverplicht
integer
variant
object
totalsverplicht
OrderTotals
amountverplicht
string

Bedrag als string (bijv. '49.99')

currencyCodeverplicht
string

ISO 4217 valutacode

fulfillmentsverplicht
array
id
string
status
string
trackingInfo
array

StandardOrder

idverplicht
string
numberverplicht
string
statusverplicht
string · enum
pendingprocessingshippeddeliveredcancelled
createdAtverplicht
string · date-time
displayFulfillmentStatusverplicht
string

Leesbare fulfillment-status (bijv. 'Verzonden', 'In verwerking')

displayFinancialStatusverplicht
string

Leesbare betaalstatus (bijv. 'Betaald', 'Terugbetaald')

customerverplicht
OrderCustomer
email
string · email
phone
string
name
string
itemsverplicht
array
idverplicht
string
titleverplicht
string
quantityverplicht
integer
variant
object
title
string
totalsverplicht
OrderTotals
amountverplicht
string

Bedrag als string (bijv. '49.99')

currencyCodeverplicht
string

ISO 4217 valutacode

fulfillmentsverplicht
array
id
string
status
string
trackingInfo
array
number
string

Track & trace nummer

url
string · uri

Link naar tracking pagina

company
string

Vervoerder

OrderCustomer

email
string · email
phone
string
name
string

OrderItem

idverplicht
string
titleverplicht
string
quantityverplicht
integer
variant
object
title
string

OrderTotals

amountverplicht
string

Bedrag als string (bijv. '49.99')

currencyCodeverplicht
string

ISO 4217 valutacode

Fulfillment

id
string
status
string
trackingInfo
array
number
string

Track & trace nummer

url
string · uri

Link naar tracking pagina

company
string

Vervoerder

CreateReturnRequest

orderNumberverplicht
string
customerEmailverplicht
string · email
reasonverplicht
string

Reden voor retour

items
array
itemIdverplicht
string
quantityverplicht
integer
reason
string
customerMessage
string

Optioneel bericht van de klant

UpdateReturnRequest

statusverplicht
string · enum
approvedrejectedprocessingcompleted
staffNotes
string
refundAmount
string

Bedrag als string (bijv. '24.99')

refundMethod
string

bijv. 'original_payment_method', 'store_credit'

ReturnResponse

successverplicht
boolean
dataverplicht
object
idverplicht
string
statusverplicht
string · enum
pendingapprovedrejectedprocessingcompleted
orderNumberverplicht
string
estimatedProcessingTime
string
returnInstructions
object
returnAddress
Address
returnLabel
string · uri

URL naar retourlabel PDF

instructions
string

ProductSearchResponse

successverplicht
boolean
dataverplicht
object
queryverplicht
string
resultsverplicht
array
idverplicht
string
titleverplicht
string
description
string
priceverplicht
object
images
array
variants
array
urlverplicht
string · uri
categories
array
relevanceScore
number
totalResultsverplicht
integer
processingTime
string

Product

idverplicht
string
titleverplicht
string
description
string
priceverplicht
object
amountverplicht
string
currencyCodeverplicht
string
images
array
url
string · uri
alt
string
variants
array
id
string
title
string
available
boolean
price
string
urlverplicht
string · uri
categories
array
relevanceScore
number

ProductCatalogPage

successverplicht
boolean
dataverplicht
object
productsverplicht
array
idverplicht
string
titleverplicht
string
description
string
priceverplicht
object
images
array
variants
array
urlverplicht
string · uri
categories
array
relevanceScore
number
paginationverplicht
object
pageverplicht
integer
limitverplicht
integer
totalPagesverplicht
integer
totalProductsverplicht
integer
hasNextPage
boolean

CustomerLookupResponse

successverplicht
boolean
dataverplicht
object
idverplicht
string
emailverplicht
string · email
phone
string
name
string
createdAt
string · date-time
ordersCount
integer
defaultAddress
Address
name
string
street
string
city
string
postalCode
string
country
string

ISO 3166-1 alpha-2 landcode

UpdateAddressRequest

name
string
streetverplicht
string
cityverplicht
string
postalCodeverplicht
string
countryverplicht
string

PolicyBundleResponse

successverplicht
boolean
dataverplicht
object
shipping
PolicySection
titleverplicht
string
bodyverplicht
string

Beleidsinhoud (mag Markdown bevatten)

returns
PolicySection
titleverplicht
string
bodyverplicht
string

Beleidsinhoud (mag Markdown bevatten)

refund
PolicySection
titleverplicht
string
bodyverplicht
string

Beleidsinhoud (mag Markdown bevatten)

privacy
PolicySection
titleverplicht
string
bodyverplicht
string

Beleidsinhoud (mag Markdown bevatten)

PolicySection

titleverplicht
string
bodyverplicht
string

Beleidsinhoud (mag Markdown bevatten)

DiscountCheckResponse

successverplicht
boolean
dataverplicht
object
codeverplicht
string
validverplicht
boolean
type
string · enum
percentagefixed_amountfree_shipping
value
number

Kortingswaarde (percentage als getal, bedrag in EUR)

minOrderAmount
string
expiresAt
string · date-time
applicableProducts
string

'all' of komma-gescheiden product IDs

OrderUpdatedWebhook

eventverplicht
string
orderNumberverplicht
string
newStatusverplicht
string
timestampverplicht
string · date-time
trackingUpdate
object
status
string
location
string
timestamp
string · date-time

ReturnUpdatedWebhook

eventverplicht
string
returnIdverplicht
string
newStatusverplicht
string
timestampverplicht
string · date-time
refundAmount
string