CompuDime API docs

API reference

Every endpoint, read from the live OpenAPI document. Code generators and API tools can read the same document: https://api.compudime.com/openapi.json.

To try the endpoints in Postman, import the Postman collection: one request for each endpoint below, generated from the same document.

Address: https://api.compudime.com. Send your key on every call; see Authentication. Prices are the list prices of pricing version 2026-10-09.2; see Pricing.

Two order APIs share this address. /v1/orders is the public API described here: your app sends an order into a store's POS, then reads where it stands. /api/v1/orders/... is the CompuDime Orders API: delivery and ordering services push orders into a store's queue, and the store's POS collects them from there. They are separate APIs with their own requests and answers. These pages cover /v1/orders only. For the Orders API, write to support@compudime.com.

Catalog

EndpointWhat it doesPrice
GET /v1/catalog/snapshots/currentGet current catalog snapshot1 credit
GET /v1/productsList catalog products1 credit; 5 fields included, 1 more per extra field
GET /v1/products/lookup/{code}Look up a product live by any code5 credits; 5 fields included, 1 more per extra field
GET /v1/products/{productCode}Get catalog product1 credit; 5 fields included, 1 more per extra field

Store lists and profile

EndpointWhat it doesPrice
GET /v1/brandsList the store's brands live1 credit
GET /v1/categoriesList the store's departments, categories and sub-categories live1 credit
GET /v1/reasonsList the register's discount and return reasons live1 credit
GET /v1/storeGet the store's business profile live1 credit
GET /v1/tagsList the store's product tags live1 credit

Promotions

EndpointWhat it doesPrice
GET /v1/promotionsList the store's promotions live1 credit
GET /v1/promotions/mix-match/{groupId}Get a mix and match group live1 credit

Inventory

EndpointWhat it doesPrice
GET /v1/inventory/onhandList on-hand quantities live1 credit

Sales

EndpointWhat it doesPrice
GET /v1/sales/dailyList daily register totals1 credit
GET /v1/sales/movementList sales movement1 credit; 5 fields included, 1 more per extra field
GET /v1/sales/zreportGet the register Z reports of a business day live1 credit

Register tickets

EndpointWhat it doesPrice
GET /v1/ticketsList the store's register tickets live1 credit
GET /v1/tickets/{ticketId}Get a register ticket live with its lines and tenders1 credit

Invoices

EndpointWhat it doesPrice
GET /v1/invoicesList the store's POS invoices live1 credit
GET /v1/invoices/external/{externalId}Get an invoice live by the placing system's order id1 credit
GET /v1/invoices/{posInvoiceId}Get an invoice live by POS invoice id1 credit

Delivery routes

EndpointWhat it doesPrice
GET /v1/delivery/routesList the store's delivery routes live1 credit

Purchasing and receiving

EndpointWhat it doesPrice
GET /v1/purchase-ordersList the store's vendor purchase orders live1 credit
GET /v1/purchase-orders/{posPurchaseOrderId}Get a purchase order live by POS purchase order id1 credit
GET /v1/receivingList the store's receiving documents live1 credit
GET /v1/receiving/{posReceivingId}Get a receiving document live by POS receiving id1 credit

Accounting export

EndpointWhat it doesPrice
GET /v1/accounting/journal-entriesList mapped journal entries by store-day live1 credit
GET /v1/accounting/mappingGet the store's account mapping keys live1 credit
GET /v1/accounting/sales-summariesList register-log sales summaries by store-day live1 credit

Customers

EndpointWhat it doesPrice
GET /v1/customersList the store's customers live1 credit
GET /v1/customers/lookupLook up POS customers by phone1 credit
GET /v1/customers/{posCustomerId}Get a customer live by POS customer id1 credit

Tenders

EndpointWhat it doesPrice
GET /v1/tendersList the register's tender types1 credit

Orders

EndpointWhat it doesPrice
POST /v1/ordersCreate order intake request16 credits
GET /v1/orders/external/{externalOrderId}Get order intake status by external order id1 credit
GET /v1/orders/{orderId}Get order intake status1 credit

Webhook receivers

EndpointWhat it doesPrice
GET /v1/webhooksList your webhook receiversfree
POST /v1/webhooksRegister a webhook receiverfree
DELETE /v1/webhooks/{webhookId}Remove a webhook receiverfree
GET /v1/webhooks/{webhookId}Get a webhook receiverfree
GET /v1/webhooks/{webhookId}/deliveriesList a receiver's recent deliveriesfree
POST /v1/webhooks/{webhookId}/rotate-secretRotate a receiver's signing secretfree
POST /v1/webhooks/{webhookId}/testSend a test event to a receiverfree

Your key and usage

EndpointWhat it doesPrice
GET /v1/capabilitiesList public API capabilitiesfree
GET /v1/meDescribe the calling keyfree
GET /v1/usage/currentGet current API usagefree

Status and the document

EndpointWhat it doesPrice
GET /healthzCheck API Edge healthfree
GET /openapi.jsonFetch OpenAPI documentfree
GET /readyzCheck API Edge readinessfree

Webhooks

Events CompuDime sends to your receiver. See Webhooks.

Schemas