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

Happy Cabbage Analytics Orders API

Orders

Happy Cabbage Analytics Orders API is one of 14 APIs that Happy Cabbage Analytics publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 13 operations across 8 paths, and defines 12 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, https://api.happycabbage.ai.

13 operations 8 paths 12 schemas 2 DELETE4 GET4 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://api.happycabbage.ai
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Happy Cabbage Analytics Orders API declares 1 security scheme for authenticating requests. An API key is passed in the header as hca-api-key (ApiKeyAuth). By default, every request must be authenticated.

  • ApiKeyAuth — External API key issued by Happy Buyers. Send the key in the hca-api-key header.

Paths & Operations 13

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

Orders 13

Orders

GET
/external/v1/orders/{orderId}/items
List order items
getOrderItems 5 params → 200
PUT
/external/v1/orders/{orderId}/items
Add order item
addOrderItem 1 param body → 200
GET
/external/v1/orders/{orderId}/invoices/{invoiceId}
Get order invoice
getOrderInvoice 2 params → 200
PUT
/external/v1/orders/{orderId}/invoices/{invoiceId}
Update order invoice
updateOrderInvoice 2 params body → 200
DELETE
/external/v1/orders/{orderId}/invoices/{invoiceId}
Remove order invoice
removeOrderInvoice 2 params → 200
PUT
/external/v1/orders/{id}
Update an order
updateOrder 1 param body → 404400401403200
GET
/external/v1/orders
List orders
getOrders 9 params → 200
POST
/external/v1/orders
Create an order
createOrder body → 200400401403
GET
/external/v1/orders/{orderId}/invoices
List order invoices
getOrderInvoices 6 params → 200
POST
/external/v1/orders/{orderId}/invoices
Add order invoice
addOrderInvoice 1 param body → 200
POST
/external/v1/orders/{orderId}/invoices/{invoiceId}/upload-url
Generate order invoice upload URL
generateTemporaryUploadUrl 2 params body → 200
POST
/external/v1/orders/{orderId}/invoices/{invoiceId}/download-url
Generate order invoice download URL
generateTemporaryDownloadUrl 2 params body → 200
DELETE
/external/v1/orders/{orderId}/items/{itemId}/store/{storeId}
Remove order item
removeOrderItem 3 params → 200

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are OrderItemResponse (31 properties), OrderItemAddRequest (15 properties), OrderResponse (10 properties), OrderInvoiceResponse (6 properties). Each schema is shown below with its type and property counts.

LimitOffsetResponseOrderInvoiceResponse
object
5 properties
OrderInvoiceUrlRequest
object
Request body for generating a temporary invoice file URL.
1 property
OrderItemAddRequest
object
Request body for adding an item to an order.
15 properties 1 required
LimitOffsetResponseOrderResponse
object
5 properties
OrderInvoiceCreateRequest
object
Request body for adding an invoice to an order.
2 properties 1 required
CreateRequest
object
3 properties
UpdateRequest
object
4 properties
LimitOffsetResponseOrderItemResponse
object
5 properties
OrderInvoiceResponse
object
Order invoice metadata.
6 properties
OrderItemResponse
object
31 properties
OrderResponse
object
10 properties
OrderInvoiceUpdateRequest
object
Request body for updating an order invoice.
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

happy-cabbage-analytics-orders-api-openapi.yml Raw ↑

Other APIs Happy Cabbage Analytics publishes across the network.

Happy Cabbage Analytics Blockout Dates API
Happy Cabbage Analytics Daily Sales Metadata API
Happy Cabbage Analytics Identity API
Happy Cabbage Analytics Inventory Health API
Happy Cabbage Analytics Packages API
Happy Cabbage Analytics POS Brands API
Happy Cabbage Analytics POS Categories API
Happy Cabbage Analytics Product Inventory API
Happy Cabbage Analytics Product Line Inventory API
Happy Cabbage Analytics Product Lines API
Happy Cabbage Analytics Stores API
Happy Cabbage Analytics Universal Brands API
Where this information came from

This is an independent, third-party profile of Happy Cabbage Analytics Orders 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.