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 Invoices & Payments API

Shared (customer-facing) invoices/PDFs on an order, and manual payment and refund entries.

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

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

This API exposes 11 operations across 11 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.

11 operations 11 paths 3 schemas 1 DELETE6 GET3 POST1 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 Invoices & Payments 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 11

Across 11 paths, the API surfaces 11 operations — 1 DELETE, 6 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Invoices & Payments 11

Shared (customer-facing) invoices/PDFs on an order, and manual payment and refund entries.

GET
/order_shared/{publicId}/pdf
Get the customer-shared Order as a PDF
getSharedOrderPdf 1 param → 200
GET
/order_shared/{publicId}/signed_invoice
Find signed invoices for a shared Order
listSignedInvoices 1 param → 200
GET
/order_shared/{publicId}/signed_invoice/latest
Get the latest signed invoice for a shared Order
getLatestSignedInvoice 1 param → 200
GET
/order_shared/{publicId}/signed_invoice/{id}/pdf
Get a signed invoice as a PDF
getSignedInvoicePdf 2 params → 200
GET
/order_shared/{publicId}/payment
Find payments recorded against a shared Order
listSharedOrderPayments 1 param → 200
POST
/integration/payment/search
Search for Payment Entries
searchPayments → 200
POST
/integration/payment/manual/charge
Record a payment manually
recordManualPayment body → 200
DELETE
/integration/payment/manual/{id}
Remove a manually-recorded payment
deleteManualPayment 1 param → 200
POST
/integration/payment/manual/refund
Create one Manual Refund
createManualRefund → 200
PUT
/integration/payment/manual/refund/{id}
Update one Payment/Refund by id
updateManualRefund 1 param → 200
GET
/integration/payment/manual/refund/{id}/download-pdf
Download a refund receipt as PDF
downloadRefundPdf 1 param → 200

Schemas 3

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

Payment
object
5 properties
SignedInvoice
object
MODELED from the documented ordershared signedinvoice surface.
4 properties
PaymentInput
object
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

shopmonkey-invoices-payments-api-openapi.yml Raw ↑

Other APIs Shopmonkey publishes across the network.

Shopmonkey Appointments API
Shopmonkey Customers API
Shopmonkey Employees API
Shopmonkey Inventory & Parts 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 Invoices & Payments 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.