API Reference
Endpoints
Browse every API endpoint by domain and resource. Open any endpoint for parameters, request and response schemas, and code examples.
AI
Agent
6 endpointsAgent Runs
6 endpointsAgent Tools
2 endpointsAuth
Core
Sandbox
4 endpointsRequest Log
2 endpointsAudit Event
3 endpointsSearch
1 endpointAddress Validation
2 endpointsEmail Logs
2 endpointsAnalytics
4 endpointsUtils
1 endpointCatalog
Units
6 endpointsUnit Groups
11 endpointsCreate Unit Group
/v1/catalog/unit-groups
Update Unit Group
/v1/catalog/unit-groups/{id}
List Unit Groups
/v1/catalog/unit-groups
Retrieve Unit Group
/v1/catalog/unit-groups/{id}
Delete Unit Group
/v1/catalog/unit-groups/{id}
Bulk Upsert Unit Groups
/v1/catalog/unit-groups/actions/bulk-upsert
+5 more
Properties
11 endpointsItems
9 endpointsList Items
/v1/catalog/items
Retrieve Item
/v1/catalog/items/{id}
Bulk Reconcile Items
/v1/catalog/items/actions/bulk-reconcile
Add Item Attribute
/v1/catalog/items/{id}/attributes/{attribute_id}
Change Item Category
/v1/catalog/items/{id}/category/{category_id}
Retrieve Item Inventory
/v1/catalog/items/{id}/inventory
+3 more
Item Categories
9 endpointsCreate Item Category
/v1/catalog/item-categories
Update Item Category
/v1/catalog/item-categories/{id}
List Item Categories
/v1/catalog/item-categories
Retrieve Item Category
/v1/catalog/item-categories/{id}
Delete Item Category
/v1/catalog/item-categories/{id}
Bulk Upsert Item Categories
/v1/catalog/item-categories/actions/bulk-upsert
+3 more
Materials
6 endpointsParts
6 endpointsProduct Lines
6 endpointsCreate Product Line
/v1/catalog/product-lines
Update Product Line
/v1/catalog/product-lines/{id}
List Product Lines
/v1/catalog/product-lines
Retrieve Product Line
/v1/catalog/product-lines/{id}
Delete Product Line
/v1/catalog/product-lines/{id}
Bulk Upsert Product Lines
/v1/catalog/product-lines/actions/bulk-upsert
Finance
Payment Terms
5 endpointsIdentity
Account Users
7 endpointsCreate Account User
/v1/identity/account-users
Update Account User
/v1/identity/account-users/{id}
List Account Users
/v1/identity/account-users
Retrieve Account User
/v1/identity/account-users/{id}
Activate Account User
/v1/identity/account-users/{id}/actions/activate
Disable Account User
/v1/identity/account-users/{id}/actions/disable
+1 more
Account
1 endpointRoles
5 endpointsPermission Groups
1 endpointMessaging
Notifications
9 endpointsSend Notification
/v1/messaging/notifications
List Notifications
/v1/messaging/notifications
Get Notification Unread Count
/v1/messaging/notifications/unread-count
Get Cross-Account Unread Summary
/v1/messaging/notifications/unread-summary
Retrieve Notification
/v1/messaging/notifications/{id}
Mark All Notifications Seen
/v1/messaging/notifications/actions/mark-all-seen
+3 more
Announcements
5 endpointsList Announcements
/v1/messaging/announcements
Retrieve Announcement
/v1/messaging/announcements/{id}
Mark Announcement Dismissed
/v1/messaging/announcements/{id}/actions/dismiss
Mark Announcement Read
/v1/messaging/announcements/{id}/actions/read
Mark Announcement Seen
/v1/messaging/announcements/{id}/actions/seen
Conversations
20 endpointsCreate Conversation
/v1/messaging/conversations
Update Conversation
/v1/messaging/conversations/{id}
List Conversations
/v1/messaging/conversations
Retrieve Conversation
/v1/messaging/conversations/{id}
Link Record
/v1/messaging/conversations/{id}/links
List Links
/v1/messaging/conversations/{id}/links
+14 more
Messages
6 endpointsUpdate Reply Draft
/v1/messaging/messages/{id}
Send Message
/v1/messaging/conversations/{id}/messages
List Messages
/v1/messaging/conversations/{id}/messages
Approve And Send Reply Draft
/v1/messaging/messages/{id}/actions/approve-send
Cancel Scheduled Message
/v1/messaging/messages/{id}/actions/cancel
Reject Reply Draft
/v1/messaging/messages/{id}/actions/reject
Conversation Participants
3 endpointsMessaging Groups
7 endpointsCreate Messaging Group
/v1/messaging/groups
Update Messaging Group
/v1/messaging/groups/{id}
List Messaging Groups
/v1/messaging/groups
Retrieve Messaging Group
/v1/messaging/groups/{id}
Delete Messaging Group
/v1/messaging/groups/{id}
Add Messaging Group Member
/v1/messaging/groups/{id}/members
+1 more
Message Attachments
1 endpointMessage Blocks
3 endpointsNotification Preferences
2 endpointsMessaging Contacts
1 endpointEmail Domains
5 endpointsOperations
Shipping Terms
5 endpointsCarriers
5 endpointsService Levels
5 endpointsCreate Service Level
/v1/operations/carriers/{carrier_id}/service-levels
Update Service Level
/v1/operations/carriers/{carrier_id}/service-levels/{id}
List Service Levels
/v1/operations/carriers/{carrier_id}/service-levels
Retrieve Service Level
/v1/operations/carriers/{carrier_id}/service-levels/{id}
Delete Service Level
/v1/operations/carriers/{carrier_id}/service-levels/{id}
Departments
5 endpointsMachines
5 endpointsMachine Downtime
6 endpointsCreate Machine Downtime Event
/v1/operations/machine-downtime-events
Update Machine Downtime Event
/v1/operations/machine-downtime-events/{id}
List Machine Downtime Events
/v1/operations/machine-downtime-events
List Machine Downtime Reasons
/v1/operations/machine-downtime-reasons
Retrieve Machine Downtime Event
/v1/operations/machine-downtime-events/{id}
Delete Machine Downtime Event
/v1/operations/machine-downtime-events/{id}
Machine Status
1 endpointDemand Overrides
6 endpointsCreate Demand Override
/v1/operations/demand-overrides
Update Demand Override
/v1/operations/demand-overrides/{id}
List Demand Override Types
/v1/operations/demand-override-types
List Demand Overrides
/v1/operations/demand-overrides
Retrieve Demand Override
/v1/operations/demand-overrides/{id}
Delete Demand Override
/v1/operations/demand-overrides/{id}
Production Schedules
23 endpointsGenerate Production Schedule
/v1/operations/production-schedules
List Production Schedules
/v1/operations/production-schedules
Retrieve Current Production Schedule
/v1/operations/production-schedules/current
List Schedule Deviation Types
/v1/operations/schedule-deviation-types
Retrieve Production Schedule
/v1/operations/production-schedules/{id}
Delete Production Schedule
/v1/operations/production-schedules/{id}
+17 more
Production Schedule Settings
11 endpointsUpsert Production Schedule Item Setting
/v1/operations/production-schedule-settings/items/{item_id}
List Fulfillment Recommendations
/v1/operations/fulfillment-recommendations
Retrieve Production Schedule Settings
/v1/operations/production-schedule-settings
List Production Schedule Item Settings
/v1/operations/production-schedule-settings/items
List Production Schedule Resource Settings
/v1/operations/production-schedule-settings/resources
Retrieve Production Schedule Item Setting
/v1/operations/production-schedule-settings/items/{item_id}
+5 more
Operating Calendars
8 endpointsCreate Operating Calendar
/v1/operations/operating-calendars
Update Operating Calendar
/v1/operations/operating-calendars/{id}
List Operating Calendars
/v1/operations/operating-calendars
Retrieve Operating Calendar
/v1/operations/operating-calendars/{id}
Delete Operating Calendar
/v1/operations/operating-calendars/{id}
Create Operating Calendar Closure
/v1/operations/operating-calendars/{id}/closures
+2 more
Location
8 endpointsShipment
1 endpointScanning Stations
5 endpointsCreate Scanning Station
/v1/operations/scanning-stations
Update Scanning Station
/v1/operations/scanning-stations/{id}
List Scanning Stations
/v1/operations/scanning-stations
Retrieve Scanning Station
/v1/operations/scanning-stations/{id}
Delete Scanning Station
/v1/operations/scanning-stations/{id}
Sales
Account Groups
5 endpointsAccount Prices
6 endpointsCreate Account Price
/v1/sales/account-prices
Update Account Price
/v1/sales/account-prices/{id}
List Account Prices
/v1/sales/account-prices
Retrieve Account Price
/v1/sales/account-prices/{id}
Delete Account Price
/v1/sales/account-prices/{id}
Export Price List
/v1/sales/account-prices/actions/export-price-list
Address
5 endpointsAccount Statuses
2 endpointsSales Targets
3 endpointsPriorities
2 endpointsCustomers
7 endpointsContacts
1 endpointOrder Discounts
6 endpointsCreate Order Discount
/v1/sales/order-discounts
Update Order Discount
/v1/sales/order-discounts/{id}
List Order Discounts
/v1/sales/order-discounts
Retrieve Order Discount
/v1/sales/order-discounts/{id}
Delete Order Discount
/v1/sales/order-discounts/{id}
Find Order Discount by Code
/v1/sales/order-discounts/actions/find-by-code
Sales Order Statuses
1 endpointVolume Discounts
5 endpointsSales Orders
19 endpointsCreate Sales Order
/v1/sales/sales-orders
Quote Sales Order Prices
/v1/sales/sales-orders/price-quote
Update Sales Order
/v1/sales/sales-orders/{id}
List Sales Orders
/v1/sales/sales-orders
Retrieve Sales Order
/v1/sales/sales-orders/{id}
Delete Sales Order
/v1/sales/sales-orders/{id}
+13 more
Settings
Portal Domains
5 endpointsObjects
The resources the API returns. Open an object for its attributes, an example, and the endpoints that use it.
AI
Auth
Core
Audit Event
audit_eventAn immutable record of a single change to a resource, capturing who made the change, what changed, and when.
Email Logs
email_logA record of an email the platform sent on the account's behalf, such as an order acknowledgement or a user invitation.
Jobs
jobRecords a piece of work the API accepted and carries out asynchronously.
Request Log
request_logA log of a single API request, capturing its route, outcome, latency, and actor.
Sandbox
sandboxAn isolated test account owned by a production account.
Catalog
Item Categories
item_categoryA grouping of related catalog items that defines the unit group and properties available to the items within it.
Items
itemAn entry in your catalog: something you sell, consume, or build with.
Materials
materialA material in the account's catalog: a raw material or component consumed in production.
Parts
partA part in the account's catalog: a component used in production.
Product Lines
product_lineA named grouping of related products in your catalog.
Products
productA catalog entry as it is sold: an inventory item together with its product type, product line, and customer portal visibility.
Properties
propertyA named characteristic used to classify items, such as `Color` or `Size`.
Unit Groups
unit_groupA named collection of units that share one dimension, defining which units a product can be ordered in.
Units
unitUnit of measurement used for conversions and product quantities.
Finance
Identity
Messaging
Announcements
announcementA broadcast announcement shown in the notification (bell) feed, carrying the calling user's own read state.
Conversations
conversationA conversation thread the caller participates in.
Email Domains
email_domainA domain registered with the email bridge for sending and receiving mail.
Email Inboxes
email_inboxA routable email inbox on a verified domain.
Messages
listA single page of resources, together with the metadata needed to page through the rest of the result set.
Messaging Groups
messaging_groupA reusable roster: a named set of members (users and/or agents) that seeds new conversations.
Notifications
notificationAn in-app notification addressed to a single user, shown in their notification (bell) feed.
Operations
Carriers
carrierA shipping carrier configured for fulfilling orders.
Demand Overrides
demand_overrideAn adjustment to the demand a production schedule is planned against.
Departments
departmentA functional area of a production operation, such as fabrication or packaging, that groups scanning stations and machines.
Location
location_typeA level in the storage location hierarchy, such as a building or a bin.
Machine Downtime
machine_downtime_eventA period during which a machine was not running.
Machines
machineA piece of production equipment, such as a CNC router or press, assigned to a department.
Operating Calendars
operating_calendarOperatingCalendar is the set of days one party to a shipment operates.
Production Schedules
production_scheduleA saved production schedule.
Scanning Stations
scanning_stationA station on the production floor where operators scan batches to perform a batch operation, such as initializing or moving a batch.
Service Levels
service_levelA shipping speed or method offered by a carrier, such as ground or overnight.
Shipping Terms
shipping_termA named freight pricing rule that decides what a buyer pays for shipping.
Sales
Account Groups
account_groupA named grouping of customer accounts, used for pricing rules or to categorize accounts.
Account Prices
account_priceA customer-specific price for a product line.
Account Statuses
account_statusA lookup value describing the standing of a customer account, such as whether shipments or all activity should be held.
Address
addressA saved address that can be used for billing and shipping on sales orders, invoices, and shipments.
Customers
customerA business you sell to, with its contact details, default fulfillment settings, and order policies.
Order Discounts
order_discountA discount code that can be applied to a sales order.
Priorities
priorityPriority level used to order work on sales orders, purchase orders, and picks.
Sales Orders
sales_orderAn order placed by a customer, tracked from estimate through fulfillment.
Volume Discounts
volume_discountA quantity-based discount with tiered percentage rates.