Get Started

Changelog

Product updates for the ShelfCycle Developer API.

Public API v1.36

Added complete commercial account setup and more reliable account discovery for connected workflows.

New

  • Resolve and maintain representatives and payment terms, and select eligible ledger accounts before creating commercial profiles.
  • Create customers with account ownership, payment terms, customer-service representatives, credit limits, and source-identified addresses.
  • Create suppliers with tax IDs, payment terms, credit limits, preferred units of measure, cost accounts, supplier representatives, and source-identified ship-from locations.
  • Find customers by ownership, setup details, and qualifying shipped sales, and continue through larger result sets.

Useful for

  • Bring complete customer and supplier setup into one connected onboarding workflow.
  • Keep source IDs for accounts, contacts, notes, and addresses so later updates return to the right record.
  • Resume safely after an interruption and verify saved details before continuing.
  • Keep a new account record separate when it resembles an existing one but represents a distinct business record.

Access

  • Company Reference read access covers representative, payment-term, and eligible ledger-account directories.
  • Company Reference write access covers creating and maintaining representatives and payment terms, together with each person's current account access.
  • Existing v1.35.2 connections remain compatible with v1.36.

Public API v1.35.2

Added reversible customer and supplier record maintenance and more precise product variant creation.

New

  • Archive and restore customers, suppliers, customer and supplier contacts, customer addresses, and supplier ship-from locations.
  • Preview each change, apply it against the latest record, and receive clear confirmation of the resulting archive state.
  • Create distinct product variants for the same supplier when package quantities differ, even when family and packaging are shared.

Useful for

  • Keep customer and supplier directories current while preserving records that may need to be restored later.
  • Carry routine record housekeeping through the same connected workflows used for profile maintenance.
  • Maintain several pack sizes for one supplier relationship without treating legitimate variants as duplicates.

Access

  • Existing customer, supplier, and contact maintenance access now covers the matching archive and restore actions when the acting person's current permissions allow them.
  • Existing v1.35.1 connections remain compatible with v1.35.2.

Public API v1.35.1

Added complete cost schedules, precise corrections, and batch maintenance for Cost Book.

New

  • Save single-rate or quantity-based supplier cost schedules with terms and the exact commercial arrangement.
  • Correct a saved Cost Book event while preserving the original record, source details, and full history.
  • Apply up to 50 approved Cost Book changes together, with an ordered result for every item and safe continuation after an interruption.

Useful for

  • Pricing teams can maintain rate breaks, supplier terms, and origin-specific costs without losing commercial context.
  • Connected workflows can keep larger approved cost sets current while preserving a clear record of every change.
  • Finance and operations teams can review what changed, what it replaced, and which submitted items need attention.

Access

  • Cost Book viewing and maintenance continue to use the existing Cost Book access settings.
  • Existing v1.35 connections remain compatible with v1.35.1.

Public API v1.35

Added Customer AR Intelligence for payment patterns, current exposure, and invoice charge analysis.

New

  • Measure how customer invoices settle over time, including final-settlement pace and timing against due dates.
  • Rank current customer exposure using posted receivables, uninvoiced commitments, credit limits, and factual attention signals.
  • Trace matched invoice charges and credits by category or familiar description, with the exact rows behind each total.

Useful for

  • Finance and collections teams can bring payment patterns and current exposure into shared reviews and worklists.
  • Sales and account teams can see when open commitments change a customer's total position before invoicing.
  • Billing and operations teams can answer how much was charged for items such as freight, tariffs, or handling and show the supporting invoice lines.

Access

  • Customer AR Intelligence uses existing Reports access together with each person's current Invoice access.
  • Existing v1.34.1 connections remain compatible with v1.35.

Public API v1.34.1

Added clearer reorder risk context with the exact gap to each configured threshold.

New

  • See the projected deficit for every configured product-and-warehouse position: the exact gap between projected availability and its reorder point.
  • Understand each gap alongside on-hand, allocated, and committed quantities.
  • Bring the same reorder risk explanation into connected dashboards, workflows, and assistants.

Useful for

  • Purchasing and operations teams can prioritize the positions with the largest threshold gaps.
  • Inventory dashboards can show not only which positions need attention, but by how much and why.
  • Connected assistants can turn reorder questions into clear views with current demand context.

Access

  • Projected deficit is available through existing Reorder Status access.
  • Existing v1.34 connections remain compatible with v1.34.1.

Public API v1.34

Added trusted stock-out counts and configured reorder status for inventory workflows.

New

  • Count products with no available stock and product-and-warehouse positions with no available stock from one inventory response.
  • Focus inventory results on physically empty, fully allocated, or positive-availability positions.
  • Review configured reorder points with current stock, committed demand, projected availability, and Critical, Low, or OK status.

Useful for

  • Inventory dashboards can present complete stock-out counts without counting only the rows on the current page.
  • Operations teams can focus attention on products already below their reorder point or likely to fall below it after committed demand.
  • Connected assistants can answer availability and reorder questions with the same current product-and-warehouse view used across ShelfCycle.

Access

  • Stock-out counts and availability filters use Inventory access.
  • Configured reorder status uses the new Reorder Status access together with each person's current Product and Lot access.
  • Existing v1.33 connections remain compatible with v1.34.

Public API v1.33

Added Certification Intelligence for connected quality, purchasing, and customer workflows.

New

  • Browse the certification types used by the organization for suppliers, customers, products, and customer addresses.
  • Find stored certification records by type, subject, status, date, or evidence filename and inspect one exact record.
  • Find the customers, suppliers, products, or customer addresses with matching current certification records, including exact record counts.

Useful for

  • Quality teams can assemble current certification views across the records they are authorized to see.
  • Purchasing and customer workflows can check the certification information stored for an exact business record before follow-up.
  • Connected assistants can answer certification questions from structured ShelfCycle records and their recorded dates and evidence filenames.

Access

  • Certification Intelligence uses Certification access together with each person's current access to the related supplier, customer, product, or customer address.
  • Existing v1.32 connections remain compatible with v1.33.

Public API v1.32

Added tag-based directories and regulatory product discovery for connected workflows.

New

  • Browse the organization's tag vocabulary and find authorized customers, suppliers, products, or product families carrying one exact tag.
  • Find products and product families by UN/NA number, CAS number, hazard class, packing group, or name.
  • See related tags alongside Entity Resolution results when the connected workflow has tag access.

Useful for

  • Sales, purchasing, and operations workflows can work from shared business groupings such as preferred suppliers, strategic customers, or product collections.
  • Product intake, safety, and compliance workflows can discover the right catalog records from familiar regulatory identifiers.
  • Connected tools can move from a broad tag or product directory to the exact record needed for detail, reporting, or an action.

Access

  • Tag directories use Tags access together with each person's current access to the selected record type.
  • Product Directory uses existing Product access.
  • Existing v1.31 connections remain compatible with v1.32.

Public API v1.31

Added trusted entity matching for connected workflows.

New

  • Turn familiar customer, supplier, product, product-family, sales-order, and purchase-order wording into authorized ShelfCycle IDs.
  • See whether ShelfCycle found one clear match, several candidates that need clarification, or no match, with the evidence behind each candidate.
  • Use the same matching behavior available in ShelfCycle Assistant so connected tools and in-product workflows resolve business records consistently.

Useful for

  • Quote, order, document, and email workflows can translate the wording people use into the exact record a connected action needs.
  • Agents can obtain a stable ID before reading detail, running a report, or checking a proposed write.
  • Workflows can handle ambiguity deliberately instead of guessing when several records look alike.

Access

  • Entity Resolution uses the existing search:read scope together with each person's current access to the selected record type.
  • Existing v1.30.1 connections remain compatible with v1.31.

Public API v1.30.1

Added origin-specific supplier costs for more precise purchasing and pricing workflows.

New

  • Keep separate current costs for the same product and supplier at each ship-from location, with the Incoterm carried alongside the cost.
  • Review Cost Book entries by ship-from location, including the supplier's general cost when no location is recorded.
  • Select Current Source at the supplier-and-location level, with every eligible origin available for review before a change.

Useful for

  • Purchasing teams can maintain distinct costs from multiple terminals without one origin replacing another.
  • Pricing workflows can follow the intended supplier origin while retaining a general supplier cost for situations where no location-specific cost is recorded.
  • Connected dashboards and assistants can distinguish the commercial basis and origin behind each supplier cost.

Access

  • Existing Cost Book and Current Source access applies to the new origin details.
  • Existing v1.30 connections remain compatible with v1.30.1.

Public API v1.30

Added a trusted current inventory view across products and warehouses.

New

  • Review current on-hand, allocated, available, and quarantined-on-hand quantities by product and physical warehouse.
  • Keep package counts and base-unit quantities in their stated basis, with product, family, packaging, and warehouse context on every row.
  • Narrow results by product, product family, or warehouse, and continue larger result sets while retaining the total matched population and observation time.

Useful for

  • Inventory dashboards can show what is physically on hand, already allocated, available, and quarantined across locations from one current view.
  • Service, purchasing, and operations workflows can answer what is available and where without blending package counts or units across products.
  • Agents can distinguish a confirmed zero balance from an unknown match when checking an exact product and warehouse.

Access

  • Inventory balances use the inventory:read scope together with the acting person's current Product and Lot viewing access.
  • Full-access keys receive inventory viewing automatically, while restricted keys can be granted the scope for the workflows that need it.

Public API v1.29.2

Kept connected sales reporting aligned with ShelfCycle margin views by recognizing recovered pass-through charges.

New

  • Sales summaries now recognize mapped recovered pass-through charges when calculating fulfillment costs and gross profit.
  • Connected margin views now use the same recovered-charge treatment as Sales Performance in ShelfCycle.
  • Charge-only groups retain their sales, cost, and gross profit amounts while leaving the gross profit percentage blank when there is no meaningful sales base.

Useful for

  • Finance and commercial teams can compare connected reporting with ShelfCycle from a consistent view of recovered charges and margin.
  • Dashboards and reporting workflows can include charge-only amounts without presenting a misleading margin percentage.

Public API v1.29.1

Made connected workflows easier to verify, refresh, and pace at scale.

New

  • Receive a reusable proof of verification when an uploaded file is attached to a product, customer, supplier, or purchase order, including the verified checksum, file size, file type, and verification time.
  • See when purchase execution last changed across the purchase order, line, and receiving activity, with direct links to receipt history and purchase-order documents.
  • Read the full request allowance, remaining requests, and reset time on authenticated responses so connected workflows can pace work smoothly.

Useful for

  • Document intake and onboarding workflows can retain clear proof that ShelfCycle verified the uploaded file when it was attached, and recover the same receipt on a safe retry.
  • Purchasing workflows can quickly recognize lines with newer operational activity and move directly from a line to its receiving history or supporting documents.
  • Order workflows can look up as many as 25 exact order references at once and review up to 500 lines per order-detail page.

Notes

  • Existing v1.29 integrations remain compatible with v1.29.1.
  • These capabilities continue to respect each API key and each person's current ShelfCycle access.

Public API v1.29

Added Current Source management for clear, consistent product cost decisions.

New

  • See whether a product follows its assigned supplier, an explicitly selected Current Source, or still needs a source decision, together with eligible supplier choices and selection details.
  • Preview, set, replace, or clear the Current Source for a variable-supplier product, then verify the resulting source through the same product endpoint.
  • Request product cost context without supplying a supplier when ShelfCycle can follow the product's assigned supplier, selected Current Source, or only eligible Cost Book lane.

Useful for

  • Pricing and purchasing teams can carry an intentional supplier choice into connected tools while keeping Cost Book context aligned around the same product.
  • Agents and automated workflows can distinguish a selected Current Source from the most recently observed Cost Book entry and ask for a supplier choice when needed.

Notes

  • Current Source viewing and management have separate scopes and continue to follow each person's current ShelfCycle permissions.
  • Full access keys include both Current Source scopes automatically, and every selected source reports who selected it and when.

Public API v1.28

Added a current purchase execution view, exact receiving history, and purchase-order document workflows.

New

  • Review current purchase-order lines by supplier, product, product family, or due date, with clear expected, received, remaining, and over-received quantities when they share a reliable basis.
  • Distinguish six receiving states, from no receipt evidence and planned receipts through partial, complete, over-received, or basis-unknown activity, then open the exact receipt events behind each line.
  • Upload, attach, and read purchase-order documents through the same reviewable document workflow available for customer, supplier, and product records.

Useful for

  • Purchasing and operations teams can focus open-order follow-up on the lines that are still expected, partially received, or need evidence reviewed.
  • Agents and connected workflows can bring receiving activity and supplier documents together around the exact purchase order and product line.

Notes

  • Purchase execution and document access follow each person's current ShelfCycle permissions, with separate read and document-association scopes for restricted keys.
  • Full access keys include both new scopes automatically, and current execution results include signed continuation for larger result sets.

Public API v1.27

Added opportunity management and pipeline views for customer- and supplier-side growth.

New

  • Create and maintain opportunities linked to an existing customer or supplier, including the owner, products, estimated value, description, and structured details.
  • Move opportunities from lead to in progress, close them as won or lost, and review the latest status history in one place.
  • Find opportunities by relationship, owner, product, status, date, or matching text, then summarize the pipeline by stage, owner, or customer and supplier activity.

Useful for

  • Sales and operations teams can keep opportunity follow-up current from intake tools, dashboards, and daily workflows.
  • Teams can prioritize open work, review ownership, and answer pipeline questions from the same current view used across ShelfCycle.

Notes

  • Estimated values retain their stated currency, and pipeline views distinguish opportunities without an entered estimate.
  • Opportunity access follows each person's current ShelfCycle permissions across customer, supplier, and product relationships.

Public API v1.26

Added a current accounts receivable view that shows who owes you, how much, and how overdue it is.

New

  • See current receivables by customer and currency, organized into current, 1-30, 31-60, 61-90, and more-than-90-day aging buckets.
  • Review open invoices, unapplied credits, net receivables, past-due amounts and counts, and oldest due dates together.
  • Narrow the view to one customer or currency and rank customers by net balance, past-due invoices, more-than-90-day balances, or oldest days past due.

Useful for

  • Finance and operations teams can focus collections work on the customers and balances that need attention now.
  • Agents and reporting workflows can answer receivables questions from the same current, permission-aware view used across ShelfCycle.

Notes

  • Unapplied credits are shown separately and included in net receivables, keeping past-due invoice exposure clear.
  • Each currency is totaled and ranked on its own, and receivables access follows the acting user's current ShelfCycle permissions.

Public API v1.25

Added complete Price Book visibility and precise, reviewable sale-price updates.

New

  • Review active, scheduled, expired, and historical Price Book entries by product, customer, location, warehouse, terms, currency, or source.
  • See exact entered prices alongside package and base-unit context, effective dates, customer details, source information, and overlapping entries.
  • Preview and apply one exact Price Book update with the full affected set, preserved history, and a saved result that is safe to retry.

Useful for

  • Teams can review customer and list pricing in one governed view before preparing a quote, repricing a product, or checking a scheduled change.
  • Agents can compare compatible prices, explain how a package price relates to its base unit, and carry an approved price into ShelfCycle with a clear receipt.

Notes

  • Price Book viewing and updating can be granted separately and always follow the acting user's current ShelfCycle access.
  • Public updates use the organization's base currency and preserve the submitted value, stored value, and conversion details when a package price begins as a base-unit price.

Public API v1.24

Expanded sales and purchase order discovery with richer detail and reliable continuation.

New

  • Find sales orders by customer, product, product family, linked purchase order, status, ordered date, last update, or exact identifiers.
  • Find purchase orders by supplier, product, product family, linked sales order, status, due date, last update, or exact identifiers.
  • Review order lines in consistent pages alongside shipment or receipt progress, related order links, document totals, and resolved currency.

Useful for

  • Teams can keep order workflows current and move from a customer, supplier, product, or related order directly to the right documents.
  • Agents can answer detailed order-status, fulfillment, receiving, and line-item questions from the same authorized order view.

Notes

  • Continuation links keep larger result sets consistent from the first page through the last.
  • Order access continues to follow each key's access and the acting user's current ShelfCycle permissions.

Public API v1.23

Added file uploads for products, customers, and suppliers, plus current Product SDS assignment.

New

  • Upload PDFs, images, and modern Office files, then attach them to the selected product, customer, or supplier.
  • Assign an uploaded PDF or image as a product's current SDS and verify it through the product's document list.
  • Use the same upload flow for one-off files or resumable batches of product, customer, and supplier documents.

Useful for

  • Teams can complete product setup from an incoming SDS without switching to a separate file-upload step.
  • Onboarding and data-migration workflows can bring source documents into ShelfCycle and attach each file to the right record.

Notes

  • Uploaded files remain protected by ShelfCycle access controls and are attached only after the target record is selected.
  • Existing HTTPS document-link workflows continue to work alongside uploaded files.

Public API v1.22

Added complete note activity counts, rankings, and recent-note excerpts across the organization.

New

  • Count all matching notes in a chosen date range and group activity by day, note type, author, or subject.
  • Review newest-first note excerpts with their authors and subjects, narrowed by note type, author, subject, or matching text.
  • Narrow notes for a selected customer, supplier, or product by activity date and note type.

Useful for

  • Teams can produce complete weekly activity summaries and see which people, customers, suppliers, products, or note types account for the most activity.
  • Agents can answer questions about recent customer touches from exact totals, then review the matching excerpts for context.

Notes

  • Date ranges follow the organization's timezone, and each response reports the total number of matching notes even when only part of the result is shown.
  • Note activity uses notes:read and the acting user's current ShelfCycle access to notes.

Public API v1.21

Added Cost Book reads, cost context, and verified direct or constructed cost updates.

New

  • Read current Cost Book entries or the history for an exact product and supplier, including the full cost construction, source details, effective dates, and completeness.
  • Compare current and prior Cost Book entries with completed purchase and open purchase order evidence for an exact product and supplier.
  • Create or supersede direct and constructed Cost Book entries with optional readiness checks, protection against overwriting a newer cost, safe retries, and the full saved entry in the response.

Useful for

  • Teams can turn reviewed supplier quotes into Cost Book updates while preserving the source, effective dates, and full cost construction.
  • Agents can evaluate current costs against recent purchasing evidence and explain which components make up a product's total cost.

Notes

  • Cost Book amounts use exact decimal-string cents per product base unit in the organization's base currency.
  • Cost Book viewing and updating can be granted separately and always follow the acting user's current ShelfCycle access.

Public API v1.20

Expanded governed reports with flexible sales and purchasing period comparisons.

New

  • Sales and purchase summaries can compare any two explicit, bounded date windows, including quarter-over-quarter, year-over-year, and custom-period analysis.
  • Comparison rows include primary and comparison measures, signed changes, and new, lost, or retained activity classification.
  • Report totals and ranking metadata describe the complete filtered population before pagination, with sorting by current values, comparison values, or change.

Useful for

  • Teams can rank the largest sales, gross-profit, margin, or purchase-spend changes and identify newly active or no-longer-active customers and suppliers.
  • Agents can answer period-over-period questions in one governed report call while distinguishing a ranked page from a complete result set.

Notes

  • Report access still requires reports:read plus the acting user's live ShelfCycle permissions, and money remains cents-as-string in the org base currency.
  • Sales comparisons use customer, product-family, product-code, salesperson, or supplier groupings. Month rollups remain available for single-period reporting.

Public API v1.19

Added governed report rollups for sales, purchasing, and open order value.

New

  • New reports:read scope with GET /reports for catalog discovery and GET /reports/{reportKey} for read-only report runs.
  • Catalog rows publish available keys, parameters, dimensions, measures, and allowedForThisKey so clients can choose only reports the current key and actor can run.
  • Initial reports cover sales-summary, purchase-summary, and open-sales-orders with paged rows and string-cent money fields in the org base currency.

Useful for

  • Teams can power customer, product-family, product-code, supplier, salesperson, month, purchase-spend, and open-order dashboards from the same governed API surface.
  • Agents can discover report availability before running a rollup and keep unsupported report access out of automated workflows.

Notes

  • Report access requires reports:read plus the acting user's live ShelfCycle permissions.
  • Reports are read-only rollups. Order changes, purchase-order changes, row-level exports, scheduling, files, inventory valuation, cost recalculation, AR/AP/GL, and accounting work still happen in ShelfCycle.

Public API v1.18

Added parent-scoped document links for products, customers, and suppliers.

New

  • Products, customers, and suppliers now support parent-scoped document lists after a caller selects a visible record.
  • Authorized writes can attach one HTTPS file link to an active parent with dry-run readiness, idempotency, duplicate checks, and readback guidance.
  • Product document lists include the product SDS pointer when one is available, alongside attached document rows.

Useful for

  • Customer onboarding can attach W-9s, credit applications, COIs, SDS/TDS files, specs, or similar source files to the exact record already chosen by the workflow.
  • Teams can let agents collect links from intake systems while ShelfCycle keeps file access tenant-bound and parent-scoped.

Notes

  • ShelfCycle-hosted files return short-lived signed read URLs; external HTTPS links return their original URL.
  • Use these routes when a workflow needs to add or review file links for the selected product, customer, or supplier. File uploads, document deletion, sales order or purchase order changes, inventory, pricing, costing, and accounting still happen in ShelfCycle.

Public API v1.17

Expanded product setup into bounded product and product-family maintenance.

New

  • Product records now support PATCH with dry-run readiness, optimistic concurrency, duplicate checks, and impact analysis.
  • Product families now support create and update workflows for public-safe identity, CAS, formula, UN, signal-word, and hazard-symbol fields.
  • GET /me reports product and product-family capabilities separately so integrations can verify create and update access before acting.

Useful for

  • Teams can keep reviewed catalog facts aligned as intake, SDS/TDS review, and supplier context changes.
  • Agents can preview order-sensitive effects before changing product identity, packaging, supplier, or regulatory fields.

Notes

  • Catalog writes stay bounded to safe setup fields and continue to leave packaging, suppliers, inventory, prices, costs, orders, documents, and accounting untouched.

Public API v1.16

Added product setup references and bounded product create with dry-run readiness.

New

  • New products:write scope for bounded product catalog creation from existing product family, packaging, and optional supplier references.
  • New product setup references: GET /product-families, GET /product-families/{id}, and GET /reference/product-packaging.
  • POST /products supports dryRun=true, idempotent execution, duplicate checks, reference eligibility checks, and verification guidance.

Useful for

  • Teams can move intake and onboarding workflows from manual handoffs into controlled catalog creation.
  • Agents can verify product family, packaging, supplier visibility, duplicates, and variable-quantity rules before writing.

Notes

  • Product create is setup-only. It does not update products, create product families or packaging, create suppliers, mutate inventory, pricing, costs, orders, lots, documents, or accounting records.

Public API v1.15

Added parent-scoped customer location, customer address, and supplier ship-from reads and writes.

New

  • Customer location endpoints now support parent-scoped list, detail, create, and update under /customers/{id}/locations.
  • Customer address endpoints now support parent-scoped list, detail, create, and update under /customers/{id}/locations/{locationId}/addresses.
  • Supplier ship-from endpoints now support parent-scoped list, detail, create, and update under /suppliers/{id}/ship-from-locations.

Useful for

  • Onboarding and agent workflows can add ship-to, bill-to, and supplier pickup locations after resolving the exact parent.
  • Dry-run checks can surface duplicates, archived or invisible parents, address-role issues, stale records, and verification availability before mutation.

Notes

  • These endpoints stay scoped to the selected customer or supplier and exclude broad exports, primary switching, archived records, supplier root address changes, and sensitive finance, tax, or ledger fields.

Public API v1.14

Added repair-aware responses that show clients how to correct a request and continue cleanly.

New

  • Validation responses can return structured repair details, including next actions, accepted values, date-window guidance, documentation links, examples, and retry advice.
  • Search, contacts, sales-order, and purchase-order requests now provide more specific guidance when a parameter, filter, or value needs attention.
  • Rate-limit responses now include clearer wait guidance for clients that need to back off cleanly.

Useful for

  • Agents and integrations can use the response itself to choose the next safe request.
  • Teams get fewer stalled workflows when a request needs a small correction.

Notes

  • Repair guidance is additive. Existing scopes, permissions, idempotency, concurrency, and write-readiness checks continue to apply.

Public API v1.13

Added non-mutating readiness checks for supported writes before submitting a change.

New

  • Supported note, contact, customer, and supplier write endpoints now accept dryRun=true for readiness checks.
  • Readiness responses return whether the write is ready, what still needs attention, and the guidance needed to submit or verify the change.
  • GET /me reports write-readiness availability for each permitted write capability.

Useful for

  • Teams can put review gates or automated policies in front of writes without building a separate rules layer.
  • Authorized callers can still execute directly when their own policy allows it.

Notes

  • Execution still rechecks every invariant and keeps the same idempotency and concurrency protections.

Public API v1.12

Added active customer and supplier reference directories for cleaner matching before detail reads and writes.

New

  • New company-reference:read scope for active customer and supplier matching hints.
  • New /reference/customers and /reference/suppliers endpoints with cursor pagination.
  • Reference rows include stable identifiers, display names, common alternate names, website and email matching signals, location summaries, status, and ShelfCycle URLs.

Useful for

  • Integrations can build local matching caches without pulling full company profiles.
  • Callers can match broadly first, then fetch exact records before business decisions or writes.

Notes

  • Reference rows are active-only matching hints, not full customer or supplier profiles.

Public API v1.11

Expanded order document reads with changed-record discovery and scoped commercial economics.

New

  • Sales-order and purchase-order finders now support paired updatedAtFrom/updatedAtTo windows for parent-row changed-record discovery.
  • New commercial-economics:read scope unlocks permitted profit, margin, cost basis, landed-cost, and total explanation fields on scoped order document reads.
  • Sales-order detail can expose commercialEconomics, line-item costBasis, and participation metadata for marginable and non-margin amounts.
  • Purchase-order detail can expose base and landed line amounts, totals explanations, economics participation, and counterparty relationship metadata.

Useful for

  • Order workflows can find recently changed documents without switching into broad exports.
  • Permitted users can see commercial context and totals participation clearly enough to reconcile downstream decisions.

Notes

  • Commercial economics access is scope and permission gated. Read-only order endpoints stay read-only.

Public API v1.1

Expanded the API into a fuller workflow surface for resolving records, reading details, and writing bounded profiles.

New

  • Search now resolves customers, suppliers, contacts, products, sales orders, purchase orders, and locations as typed result cards.
  • Finder endpoints were added for customers, suppliers, products, sales orders, and purchase orders.
  • Detail reads were added for core records, contacts, notes, sales orders, and purchase orders.
  • Customer and supplier profile creates and updates now support idempotency and optimistic concurrency.
  • Subject-scoped notes and parent-scoped contacts keep workflows focused on confirmed records.

Improved

  • Finder and detail responses now publish concrete, resource-specific shapes for generated clients.
  • Money, quantity, and order-line fields use stable formats that clients can treat consistently.

Notes

  • Finders stay filtered and resource-specific, keeping integrations focused on selected workflow context.

Developer API v1

Initial v1 release for resolving ShelfCycle records and writing supported notes or contacts back to confirmed records.

New

  • Bearer API key authentication with GET /me for tenant, scopes, key preview, and acting-user verification.
  • GET /search for typed candidate records with matched fields, parent context, and ShelfCycle URLs.
  • POST /notes and PATCH /notes for supported notes on confirmed customers, suppliers, or products.
  • POST /contacts and PATCH /contacts for supported customer and supplier contacts under existing parents.

Foundations

  • Writes must use stable Idempotency-Key values so retries do not create duplicate notes or contacts.
  • Updates require If-Match so callers can detect stale records before overwriting newer changes.
  • Errors return stable codes, request ids, and retry guidance for programmatic handling.

Notes

  • Supported writes are bounded to confirmed records and policy-approved workflows.