How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Shopmonkey Customers API

Create, update, search, and manage customer records, emails, and phone numbers.

Shopmonkey Customers API is one of 9 APIs that Shopmonkey publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Customers. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 15 operations across 12 paths, and defines 3 schemas. It is described by OpenAPI 3.2.0, at version v3.

Requests are made against a single base URL, https://api.shopmonkey.cloud/v3.

15 operations 12 paths 3 schemas 2 DELETE4 GET1 PATCH5 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v3
Base URL
https://api.shopmonkey.cloud/v3
Authentication
HTTP Bearer
Contact
Resource Areas
1

Authentication & Security 1

Shopmonkey Customers API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — API key generated in the Shopmonkey web app under Settings Integration API Keys, sent as Authorization: Bearer .

Paths & Operations 15

Across 12 paths, the API surfaces 15 operations — 2 DELETE, 4 GET, 1 PATCH, 5 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Customers 15

Create, update, search, and manage customer records, emails, and phone numbers.

POST
/customer
Create a new customer record
createCustomer body → 200
GET
/customer/{id}
Fetch a specific customer's details
getCustomer 1 param → 200
PUT
/customer/{id}
Update customer information
updateCustomer 1 param → 200
PATCH
/customer/{id}
Soft delete a customer
softDeleteCustomer 1 param → 200
POST
/customer/search
Search customer entities
searchCustomers → 200
POST
/customer/search-by-email
Search customers by email address
searchCustomersByEmail → 200
POST
/customer/search-by-phone
Search customers by phone number
searchCustomersByPhone → 200
GET
/customer/{id}/vehicle
Retrieve vehicles linked to a customer
listCustomerVehicles 1 param → 200
GET
/customer/{id}/order
Retrieve orders associated with a specific customer
listCustomerOrders 1 param → 200
GET
/customer/{parentId}/deferred_service
Find all Deferred Services by Customer
listCustomerDeferredServices 1 param → 200
POST
/customer/{id}/email
Create a new email for the specified customer
addCustomerEmail 1 param → 200
PUT
/customer/{id}/email/{emailId}
Update the specified email for a customer
updateCustomerEmail 2 params → 200
DELETE
/customer/{id}/email/{emailId}
Delete the specified email for a customer
deleteCustomerEmail 2 params → 200
PUT
/customer/{id}/phone
Update a customer's phone number
updateCustomerPhone 1 param → 200
DELETE
/customer/{id}/phone/{phoneId}
Remove a phone number from a customer record
deleteCustomerPhone 2 params → 200

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are Vehicle (7 properties), Customer (5 properties), CustomerInput (4 properties). Each schema is shown below with its type and property counts.

Vehicle
object
MODELED from documented vehicle lookup endpoints (years/makes/models/submodels/vin/ymm).
7 properties
CustomerInput
object
4 properties 2 required
Customer
object
MODELED from documented customer email/phone sub-resources.
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

shopmonkey-customers-api-openapi.yml Raw ↑

Other APIs Shopmonkey publishes across the network.

Shopmonkey Appointments API
Shopmonkey Employees API
Shopmonkey Inventory & Parts API
Shopmonkey Invoices & Payments API
Shopmonkey Locations API
Shopmonkey Vehicles API
Shopmonkey Webhooks API
Shopmonkey Work Orders API
Where this information came from

This is an independent, third-party profile of Shopmonkey Customers API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.