Manage customer profiles, identify customers by email, update delivery addresses, vehicles, and favorites, and retrieve order history and favorite orders for personalized ordering. Authenticates with OAuth 2.0 machine-to-machine access tokens.
openapi: 3.1.0
info:
title: Deliverect CRM API
description: Manage customer profiles, identify customers by email, update delivery addresses, vehicles, and favorites, and retrieve order history and favorite orders for personalized ordering. Authenticates
with OAuth 2.0 machine-to-machine access tokens.
version: '1.0'
x-generated-from: documentation
x-source-url: https://developers.deliverect.com/reference
x-last-validated: '2026-06-02'
contact:
name: Kin Lane
email: [email protected]
license:
name: All Rights Reserved
servers:
- url: https://api.deliverect.com
description: Production
- url: https://api.staging.deliverect.com
description: Staging
tags:
- name: Customers
description: Customers operations for the Deliverect CRM API.
- name: Orders
description: Orders operations for the Deliverect CRM API.
paths:
/crm/{accountId}/customers:
post:
description: Endpoint used to register a new customer
responses:
'200':
description: ''
content:
application/json:
examples:
OK:
summary: OK
value:
externalId: 62********************1o
loyaltyProviderId: VjaG***0cm9
deliveryAddresses:
- street: Main Street
subpremise: Unit 210
area: Irvine Business Complex
city: Irvine
postalCode: '92614'
stateOrProvince: CA
country: US
coordinates:
- 40.6456946
- -73.9143276
id: 62********************6y
default: true
- street: 5678 Ocean View Drive
subpremise: Apt 5B
area: Pacific Beach
city: San Diego
postalCode: '92109'
stateOrProvince: CA
country: US
coordinates:
- 40.6456946
- -73.9143276
id: 62********************8p
default: false
billingAddress:
street: 9480 Talbert and Bushard Street
subpremise: Suite 12
area: Downtown Fountain Valley
city: Fountain Valley
postalCode: '92708'
stateOrProvince: CA
country: US
coordinates:
- 40.6456946
- -73.9143276
metadata: {}
vehicles:
- id: 62********************3b
make: honda
model: civic
color: yellow
default: true
- id: 62********************7h
make: toyota
model: corolla
color: blue
default: false
id: 62********************1m
accountId: 62********************8g
channel: 10000
created: YYYY-MM-DDTHH:mm:ss.SSSSSSZ
updated: YYYY-MM-DDTHH:mm:ss.SSSSSSZ
contact:
email: [email protected]
firstName: John
lastName: Doe
birthdate: '1970-01-01'
phone: '+5519999999999'
fullName: John Doe
favorites:
- type: order
orderId: 62********************9v
label: My favorite order
- type: order
orderId: 62********************3d
label: My 2nd favorite order
- type: item
item: '123'
- type: item
item: ABC
- type: store
storeId: 62********************0s
- type: store
storeId: 62********************7m
schema:
type: object
properties:
id:
type: string
example: '{id}'
accountId:
type: string
example: '{accountId}'
externalId:
type: string
example: '{externalId}'
channel:
type: string
example: '{channel}'
created:
type: string
example: YYYY-MM-DDTHH:mm:ss.SSSSSSZ
updated:
type: string
example: YYYY-MM-DDTHH:mm:ss.SSSSSSZ
contact:
type: object
properties:
email:
type: string
example: '{email}'
firstName:
type: string
example: '{firstName}'
lastName:
type: string
example: '{lastName}'
phone:
type: string
example: '{phone}'
fullName:
type: string
example: '{fullName}'
deliveryAddress:
type: object
properties:
country:
type: string
example: '{countryCode}'
stateOrProvince:
type: string
example: '{stateOrProvince}'
city:
type: string
example: '{city}'
streetName:
type: string
example: '{streetName}'
postalCode:
type: string
example: '{postalCode}'
houseNumber:
type: string
example: '{houseNumber}'
billingAddress:
type: object
properties:
country:
type: string
example: '{countryCode}'
stateOrProvince:
type: string
example: '{stateOrProvince}'
city:
type: string
example: '{city}'
streetName:
type: string
example: '{streetName}'
postalCode:
type: string
example: '{postalCode}'
houseNumber:
type: string
example: '{houseNumber}'
metadata:
type: object
properties:
vehicle:
type: object
properties:
make:
type: string
example: '{vehicleMake}'
model:
type: string
example: '{vehicleModel}'
color:
type: string
example: '{vehicleColor}'
favorites:
type: array
items:
type: object
properties:
type:
type: string
example: order
orderIds:
type: array
items:
type: object
properties: {}
parameters:
- in: path
name: accountId
schema:
type: string
required: true
description: The accountId value.
example: 5b71c6489f00290d4
requestBody:
content:
application/json:
schema:
type: object
properties:
contact:
type: object
properties:
email:
type: string
example: [email protected]
firstName:
type: string
example: Deliverect's Pizza Place
lastName:
type: string
example: Deliverect's Pizza Place
birthdate:
type: string
example: '2026-03-15T14:30:00Z'
phone:
type: string
example: '+15555550123'
required:
- email
externalId:
type: string
example: 609a1b2c3d4e5f6a7b8c9d0e
loyaltyProviderId:
type: string
example: 609a1b2c3d4e5f6a7b8c9d0e
deliveryAddresses:
type: array
items:
properties:
street:
type: string
example: string
subpremise:
type: string
example: string
city:
type: string
example: string
stateOrProvince:
type: string
example: string
postalCode:
type: string
example: string
country:
type: string
example: BE
default:
type: boolean
example: true
area:
type: string
example: string
coordinates:
type: array
items:
type: number
format: float
example: 1.0
type: object
billingAddress:
type: object
properties:
street:
type: string
example: string
subpremise:
type: string
example: string
city:
type: string
example: string
stateOrProvince:
type: string
example: string
postalCode:
type: string
example: string
country:
type: string
example: BE
area:
type: string
example: string
coordinates:
type: array
items:
type: number
format: float
example: 1.0
metadata:
type: object
properties: {}
vehicles:
type: array
items:
properties:
make:
type: string
example: string
model:
type: string
example: string
color:
type: string
example: string
default:
type: boolean
example: true
type: object
required:
- contact
examples:
Example:
summary: Example
value:
email: [email protected]
tags:
- Customers
summary: Deliverect Create Customer
operationId: post_crm_accountid_customers
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/crm/{accountId}/customers/lookup:
post:
description: Deliverect Lookup Customer by Email
responses:
'200':
description: ''
content:
application/json:
examples:
OK:
summary: OK
value:
externalId: 62********************1o
loyaltyProviderId: VjaG***0cm9
deliveryAddresses:
- street: Main Street
subpremise: Unit 210
area: Irvine Business Complex
city: Irvine
postalCode: '92614'
stateOrProvince: CA
country: US
coordinates:
- 40.6456946
- -73.9143276
id: 62********************6y
default: true
- street: 5678 Ocean View Drive
subpremise: Apt 5B
area: Pacific Beach
city: San Diego
postalCode: '92109'
stateOrProvince: CA
country: US
coordinates:
- 40.6456946
- -73.9143276
id: 62********************8p
default: false
billingAddress:
street: 9480 Talbert and Bushard Street
subpremise: Suite 12
area: Downtown Fountain Valley
city: Fountain Valley
postalCode: '92708'
stateOrProvince: CA
country: US
coordinates:
- 40.6456946
- -73.9143276
metadata: {}
vehicles:
- id: 62********************3b
make: honda
model: civic
color: yellow
default: true
- id: 62********************7h
make: toyota
model: corolla
color: blue
default: false
id: 62********************1m
accountId: 62********************8g
channel: 10000
created: YYYY-MM-DDTHH:mm:ss.SSSSSSZ
updated: YYYY-MM-DDTHH:mm:ss.SSSSSSZ
contact:
email: [email protected]
firstName: John
lastName: Doe
birthdate: '1970-01-01'
phone: '+5519999999999'
fullName: John Doe
favorites:
- type: order
orderId: 62********************9v
label: My favorite order
- type: order
orderId: 62********************3d
label: My 2nd favorite order
- type: item
item: '123'
- type: item
item: ABC
- type: store
storeId: 62********************0s
- type: store
storeId: 62********************7m
schema:
type: object
properties:
id:
type: string
example: '{id}'
accountId:
type: string
example: '{accountId}'
externalId:
type: string
example: '{externalId}'
channel:
type: string
example: '{channel}'
created:
type: string
example: YYYY-MM-DDTHH:mm:ss.SSSSSSZ
updated:
type: string
example: YYYY-MM-DDTHH:mm:ss.SSSSSSZ
contact:
type: object
properties:
email:
type: string
example: '{email}'
firstName:
type: string
example: '{firstName}'
lastName:
type: string
example: '{lastName}'
phone:
type: string
example: '{phone}'
fullName:
type: string
example: '{fullName}'
deliveryAddress:
type: object
properties:
country:
type: string
example: '{countryCode}'
stateOrProvince:
type: string
example: '{stateOrProvince}'
city:
type: string
example: '{city}'
streetName:
type: string
example: '{streetName}'
postalCode:
type: string
example: '{postalCode}'
houseNumber:
type: string
example: '{houseNumber}'
billingAddress:
type: object
properties:
country:
type: string
example: '{countryCode}'
stateOrProvince:
type: string
example: '{stateOrProvince}'
city:
type: string
example: '{city}'
streetName:
type: string
example: '{streetName}'
postalCode:
type: string
example: '{postalCode}'
houseNumber:
type: string
example: '{houseNumber}'
metadata:
type: object
properties:
vehicle:
type: object
properties:
make:
type: string
example: '{vehicleMake}'
model:
type: string
example: '{vehicleModel}'
color:
type: string
example: '{vehicleColor}'
favorites:
type: array
items:
type: object
properties:
type:
type: string
example: order
orderIds:
type: array
items:
type: object
properties: {}
parameters:
- in: path
name: accountId
schema:
type: string
required: true
description: The accountId value.
example: 5b71c6489f00290d4
requestBody:
content:
application/json:
schema:
type: object
properties:
email:
type: string
example: [email protected]
required:
- email
examples:
Example:
summary: Example
value:
email: [email protected]
tags:
- Customers
summary: Deliverect Lookup Customer by Email
operationId: post_crm_accountid_customers_lookup
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/crm/{accountId}/customers/{crmProfileId}:
get:
description: Deliverect Customer Profile
responses:
'200':
description: ''
content:
application/json:
examples:
OK:
summary: OK
value:
externalId: f965248c-3a00
loyaltyProviderId: VjaG***0cm9
deliveryAddresses:
- street: Main Street
subpremise: Unit 210
area: Irvine Business Complex
city: Irvine
postalCode: '92614'
stateOrProvince: CA
country: US
coordinates:
- 33.674
- -117.838
id: 61********************b1
default: true
- street: 5678 Ocean View Drive
subpremise: Apt 5B
area: Pacific Beach
city: San Diego
postalCode: '92109'
stateOrProvince: CA
country: US
coordinates:
- 32.8
- -117.25
id: 61********************b2
default: false
billingAddress:
street: 9480 Talbert and Bushard Street
subpremise: Suite 12
area: Downtown Fountain Valley
city: Fountain Valley
postalCode: '92708'
stateOrProvince: CA
country: US
coordinates:
- 33.709
- -117.953
metadata: {}
vehicles:
- id: 61********************b3
make: honda
model: civic
color: yellow
default: true
- id: 61********************b2
make: toyota
model: corolla
color: blue
default: false
id: 62********************7c
accountId: 62********************3c
channel: 10000
created: YYYY-MM-DDTHH:mm:ss.SSSSSSZ
updated: YYYY-MM-DDTHH:mm:ss.SSSSSSZ
contact:
email: [email protected]
firstName: John
lastName: Doe
phone: '+14048091678'
birthdate: '1970-01-01T00:00:00Z'
fullName: John Doe
favorites: []
schema:
type: object
properties:
id:
type: string
example: '{id}'
accountId:
type: string
example: '{accountId}'
externalId:
type: string
example: '{externalId}'
channel:
type: string
example: '{channel}'
created:
type: string
example: YYYY-MM-DDTHH:mm:ss.SSSSSSZ
updated:
type: string
example: YYYY-MM-DDTHH:mm:ss.SSSSSSZ
contact:
type: object
properties:
email:
type: string
example: '{email}'
firstName:
type: string
example: '{firstName}'
lastName:
type: string
example: '{lastName}'
phone:
type: string
example: '{phone}'
fullName:
type: string
example: '{fullName}'
deliveryAddress:
type: object
properties:
country:
type: string
example: '{countryCode}'
stateOrProvince:
type: string
example: '{stateOrProvince}'
city:
type: string
example: '{city}'
streetName:
type: string
example: '{streetName}'
postalCode:
type: string
example: '{postalCode}'
houseNumber:
type: string
example: '{houseNumber}'
billingAddress:
type: object
properties:
country:
type: string
example: '{countryCode}'
stateOrProvince:
type: string
example: '{stateOrProvince}'
city:
type: string
example: '{city}'
streetName:
type: string
example: '{streetName}'
postalCode:
type: string
example: '{postalCode}'
houseNumber:
type: string
example: '{houseNumber}'
metadata:
type: object
properties:
vehicle:
type: object
properties:
make:
type: string
example: '{vehicleMake}'
model:
type: string
example: '{vehicleModel}'
color:
type: string
example: '{vehicleColor}'
favorites:
type: array
items:
type: object
properties:
type:
type: string
example: order
orderIds:
type: array
items:
type: object
properties: {}
parameters:
- in: path
name: crmProfileId
schema:
type: string
required: true
description: The crmProfileId value.
example: 609a1b2c3d4e5f6a7b8c9d0e
- in: path
name: accountId
schema:
type: string
required: true
description: The accountId value.
example: 5b71c6489f00290d4
tags:
- Customers
summary: Deliverect Customer Profile
operationId: get_crm_accountid_customers_crmprofileid
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
patch:
description: Deliverect Update Customer Profile
parameters:
- in: path
name: crmProfileId
schema:
type: string
required: true
description: The crmProfileId value.
example: 609a1b2c3d4e5f6a7b8c9d0e
- in: path
name: accountId
schema:
type: string
required: true
description: The accountId value.
example: 5b71c6489f00290d4
requestBody:
content:
application/json:
schema:
type: object
properties:
contact:
type: object
properties:
email:
type: string
example: [email protected]
firstName:
type: string
example: Deliverect's Pizza Place
lastName:
type: string
example: Deliverect's Pizza Place
birthdate:
type: string
example: '2026-03-15T14:30:00Z'
phone:
type: string
example: '+15555550123'
externalId:
type: string
example: 609a1b2c3d4e5f6a7b8c9d0e
loyaltyProviderId:
type: string
example: 609a1b2c3d4e5f6a7b8c9d0e
deliveryAddresses:
type: array
items:
type: object
properties:
street:
type: string
example: string
subpremise:
type: string
example: string
city:
type: string
example: string
stateOrProvince:
type: string
example: string
postalCode:
type: string
example: string
country:
type: string
example: BE
default:
type: boolean
example: true
area:
type: string
example: string
coordinates:
type: string
example: string
billingAddress:
type: object
properties:
street:
type: string
example: string
subpremise:
type: string
example: string
city:
type: string
example: string
stateOrProvince:
type: string
example: string
postalCode:
type: string
example: string
country:
type: string
example: BE
area:
type: string
example: string
coordinates:
type: string
example: string
metadata:
type: object
properties: {}
vehicles:
type: array
items:
type: object
properties:
make:
type: string
example: string
model:
# --- truncated at 32 KB (74 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/deliverect/refs/heads/main/openapi/deliverect-crm-api-openapi-original.yml