API Reference

Endpoints

Browse every API endpoint by domain and resource. Open any endpoint for parameters, request and response schemas, and code examples.

Auth

API Key

5 endpoints

Create API Key

/v1/auth/api-keys

List API Keys

/v1/auth/api-keys

Retrieve API Key

/v1/auth/api-keys/{id}

Revoke API Key

/v1/auth/api-keys/{id}

Rotate API Key

/v1/auth/api-keys/{id}/actions/rotate

Core

Sandbox

4 endpoints

Create Sandbox

/v1/core/sandboxes

List Sandboxes

/v1/core/sandboxes

Retrieve Sandbox

/v1/core/sandboxes/{id}

Delete Sandbox

/v1/core/sandboxes/{id}

Request Log

2 endpoints

List Request Logs

/v1/core/request-logs

Retrieve Request Log

/v1/core/request-logs/{id}

Audit Event

3 endpoints

List Audit Events

/v1/core/audit-events

List Audit Event Resource Types

/v1/core/audit-events/resource-types

Retrieve Audit Event

/v1/core/audit-events/{id}

Search

1 endpoint

Search

/v1/core/search

Address Validation

2 endpoints

List Address Suggestions

/v1/core/addresses/suggestions

Validate Address

/v1/core/addresses/actions/validate

Email Logs

2 endpoints

List Email Logs

/v1/core/email-logs

Retrieve Email Log

/v1/core/email-logs/{id}

Catalog

Units

5 endpoints

Create Unit

/v1/catalog/units

Update Unit

/v1/catalog/units/{id}

List Units

/v1/catalog/units

Retrieve Unit

/v1/catalog/units/{id}

Delete Unit

/v1/catalog/units/{id}

Unit Groups

10 endpoints

Create 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}

Create Unit Group Associated Unit

/v1/catalog/unit-groups/{unit_group_id}/units

+4 more

Properties

10 endpoints

Create Property

/v1/catalog/properties

Update Property

/v1/catalog/properties/{id}

List Properties

/v1/catalog/properties

Retrieve Property

/v1/catalog/properties/{id}

Delete Property

/v1/catalog/properties/{id}

Create Attribute

/v1/catalog/properties/{property_id}/attributes

+4 more

Items

6 endpoints

List Items

/v1/catalog/items

Retrieve Item

/v1/catalog/items/{id}

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

Remove Item Attribute

/v1/catalog/items/{id}/attributes/{attribute_id}

Item Categories

8 endpoints

Create 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}

Add Item Category Property

/v1/catalog/item-categories/{id}/properties/{property_id}

+2 more

Materials

5 endpoints

Create Material

/v1/catalog/materials

Update Material

/v1/catalog/materials/{id}

List Materials

/v1/catalog/materials

Retrieve Material

/v1/catalog/materials/{id}

Delete Material

/v1/catalog/materials/{id}

Parts

5 endpoints

Create Part

/v1/catalog/parts

Update Part

/v1/catalog/parts/{id}

List Parts

/v1/catalog/parts

Retrieve Part

/v1/catalog/parts/{id}

Delete Part

/v1/catalog/parts/{id}

Product Lines

5 endpoints

Create 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}

Products

6 endpoints

Create Product

/v1/catalog/products

Update Product

/v1/catalog/products/{id}

List Products

/v1/catalog/products

Retrieve Product

/v1/catalog/products/{id}

Delete Product

/v1/catalog/products/{id}

Change Product Product Line

/v1/catalog/products/{id}/product-line/{product_line_id}

Finance

Payment Terms

5 endpoints

Create Payment Term

/v1/finance/payment-terms

Update Payment Term

/v1/finance/payment-terms/{id}

List Payment Terms

/v1/finance/payment-terms

Retrieve Payment Term

/v1/finance/payment-terms/{id}

Delete Payment Term

/v1/finance/payment-terms/{id}

Transactions

3 endpoints

List Adjustment Types

/v1/finance/adjustment-types

List Transaction Methods

/v1/finance/transaction-methods

List Transaction Types

/v1/finance/transaction-types

Identity

Account Users

7 endpoints

Create 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 endpoint

Upload Account Favicon

/v1/identity/accounts/{id}/favicon

Roles

5 endpoints

Create Role

/v1/identity/roles

Update Role

/v1/identity/roles/{id}

List Roles

/v1/identity/roles

Retrieve Role

/v1/identity/roles/{id}

Delete Role

/v1/identity/roles/{id}

Messaging

Notifications

9 endpoints

Send 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 endpoints

List 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 endpoints

Create 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 endpoints

Update 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 endpoints

Add Participant

/v1/messaging/conversations/{id}/participants

Remove Participant

/v1/messaging/conversations/{id}/participants/{pid}

Update Participant Role

/v1/messaging/conversations/{id}/participants/{pid}/actions/set-role

Messaging Groups

7 endpoints

Create 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 endpoint

Create Attachment Upload URL

/v1/messaging/conversations/{id}/attachments/actions/upload-url

Message Blocks

3 endpoints

Block User

/v1/messaging/blocks

List Blocks

/v1/messaging/blocks

Unblock User

/v1/messaging/blocks/{id}

Notification Preferences

2 endpoints

List Notification Preferences

/v1/messaging/preferences

Upsert Notification Preference

/v1/messaging/preferences

Messaging Contacts

1 endpoint

List Messaging Contacts

/v1/messaging/contacts

Email Domains

5 endpoints

Create Email Domain

/v1/messaging/email-domains

List Email Domains

/v1/messaging/email-domains

Get Email Domain

/v1/messaging/email-domains/{id}

Delete Email Domain

/v1/messaging/email-domains/{id}

Verify Email Domain

/v1/messaging/email-domains/{id}/actions/verify

Email Inboxes

5 endpoints

Create Email Inbox

/v1/messaging/email-inboxes

Update Email Inbox

/v1/messaging/email-inboxes/{id}

List Email Inboxes

/v1/messaging/email-inboxes

Get Email Inbox

/v1/messaging/email-inboxes/{id}

Delete Email Inbox

/v1/messaging/email-inboxes/{id}

Operations

Shipping Terms

5 endpoints

Create Shipping Term

/v1/operations/shipping-terms

Update Shipping Term

/v1/operations/shipping-terms/{id}

List Shipping Terms

/v1/operations/shipping-terms

Retrieve Shipping Term

/v1/operations/shipping-terms/{id}

Delete Shipping Term

/v1/operations/shipping-terms/{id}

Carriers

5 endpoints

Create Carrier

/v1/operations/carriers

Update Carrier

/v1/operations/carriers/{id}

List Carriers

/v1/operations/carriers

Retrieve Carrier

/v1/operations/carriers/{id}

Delete Carrier

/v1/operations/carriers/{id}

Service Levels

5 endpoints

Create 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}

Location

7 endpoints

Create Location

/v1/operations/locations

Update Location

/v1/operations/locations/{id}

List Location Types

/v1/operations/location-types

List Locations

/v1/operations/locations

Retrieve Location Type

/v1/operations/location-types/{id}

Retrieve Location

/v1/operations/locations/{id}

+1 more

Scanning Stations

5 endpoints

Create 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 endpoints

Create Account Group

/v1/sales/account-groups

Update Account Group

/v1/sales/account-groups/{id}

List Account Groups

/v1/sales/account-groups

Retrieve Account Group

/v1/sales/account-groups/{id}

Delete Account Group

/v1/sales/account-groups/{id}

Address

5 endpoints

Create Address

/v1/sales/addresses

Update Address

/v1/sales/addresses/{id}

List Addresses

/v1/sales/addresses

Retrieve Address

/v1/sales/addresses/{id}

Delete Address

/v1/sales/addresses/{id}

Account Statuses

2 endpoints

List Account Statuses

/v1/sales/account-statuses

Retrieve Account Status

/v1/sales/account-statuses/{id}

Priorities

2 endpoints

List Priorities

/v1/sales/priorities

Retrieve Priority

/v1/sales/priorities/{id}

Customers

6 endpoints

Create Customer

/v1/sales/customers

Update Customer

/v1/sales/customers/{id}

List Customers

/v1/sales/customers

Retrieve Customer

/v1/sales/customers/{id}

Delete Customer

/v1/sales/customers/{id}

Merge Customers

/v1/sales/customers/{id}/actions/merge

Contacts

1 endpoint

Find Contact by Email

/v1/sales/contacts/actions/find-by-email

Sales Order Statuses

1 endpoint

List Sales Order Statuses

/v1/sales/sales-orders/statuses

Sales Orders

18 endpoints

Create 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}

+12 more

Settings

Portal Domains

5 endpoints

Create Portal Domain

/v1/settings/portal-domains

List Portal Domains

/v1/settings/portal-domains

Get Portal Domain

/v1/settings/portal-domains/{id}

Delete Portal Domain

/v1/settings/portal-domains/{id}

Verify Portal Domain

/v1/settings/portal-domains/{id}/actions/verify

Account Integrations

4 endpoints

Create Account Integration

/v1/settings/integrations

Update Account Integration

/v1/settings/integrations/{id}

List Account Integrations

/v1/settings/integrations

Delete Account Integration

/v1/settings/integrations/{id}

Objects

The resources the API returns. Open an object for its attributes, an example, and the endpoints that use it.

Auth

API Key

An API key used to authenticate requests to the Augno API.

Core

Audit Event

Immutable audit event record.

Email Logs

A record of an email sent on the account's behalf, such as an invoice or a user invitation.

Request Log

A log of a single API request, capturing its route, outcome, latency, and actor.

Sandbox

Sandbox account for isolated testing.

Catalog

Item Categories

item_category

A grouping of related catalog items that defines the unit group and properties available to the items within it.

Items

Item is an inventory item (product, material, or part).

Materials

A material in the account's catalog: a raw material or component consumed in production.

Parts

A part in the account's catalog: a component used in production.

Product Lines

Product line resource.

Products

Product pairs an inventory item with how it is sold: its product type, optional product line, and customer portal visibility.

Properties

A named characteristic used to classify items, such as `Color` or `Size`.

Unit Groups

Named collection of units sharing one dimension, defining which units products can be ordered in along with per-unit discounts and customer portal visibility.

Units

Unit of measurement used for conversions and product quantities.

Finance

Payment Terms

A payment term describing when payment is due (e.g.

Identity

Account Users

A user's membership in an account, carrying the account-specific status, role, and department.

Roles

A named set of permissions that can be assigned to users to control what they can access.

Messaging

Announcements

A broadcast announcement shown in the bell feed, with the caller's per-user read state.

Conversations

A conversation thread the caller participates in.

Email Domains

A domain registered with the email bridge for sending and receiving mail.

Email Inboxes

A routable email inbox on a verified domain.

Messages

List represents a paginated list of resources.

Messaging Groups

messaging_group

A reusable roster: a named set of members (users and/or agents) that seeds new conversations.

Notifications

An in-app notification in the user's bell feed.

Operations

Carriers

A shipping carrier configured for fulfilling orders.

Location

location_type

A level in the storage location hierarchy, such as a building or a bin.

Scanning Stations

scanning_station

A station on the production floor where operators scan batches to perform a batch operation, such as initializing or moving a batch.

Service Levels

service_level

Shipping service level for a carrier.

Shipping Terms

shipping_term

A shipping term defining how freight charges are calculated for an order.

Sales

Account Groups

account_group

A named grouping of customer accounts, used for pricing rules or to categorize accounts.

Account Statuses

account_status

AccountStatus is a lookup value describing the standing of a customer account, such as whether shipments or all activity should be held.

Address

A saved address that can be used for billing and shipping on sales orders, invoices, and shipments.

Customers

A business you sell to, with its contact details, default fulfillment settings, and order policies.

Priorities

Priority level used to order work on sales orders, purchase orders, and picks.

Sales Orders

Full sales order resource.

Settings

Portal Domains

portal_domain

A custom domain that serves the account's customer portal (e.g.