Retrieve Priority

Beta
GET/v1/sales/priorities/{id}

This endpoint is idempotent. Learn more

Returns a priority by ID or code.

Permissions requiredValues:priorities:read
The role behind your API key or agent must grant every one of these permissions.
idstring

Priority ID or code.

Accepts either a priority ID or one of the codes low, normal, high.

include[]optional arrayenumValues:owner

Sub-objects to expand in the response. When omitted, sub-objects are returned as null.

idstring

Priority ID.

objectstringenumValues:priority

Resource type identifier.

codestringenumValues:lownormalhigh

Machine-readable code identifying the priority level.

  • low: lowest urgency; worked after normal and high.
  • normal: default urgency for most orders and picks.
  • high: highest urgency; worked ahead of normal and low.
namestring

Display name of the priority level.

ownerownerExpandablenullable

Owner of this resource.

Priorities are platform-provided and shared across all accounts, so the owner is always the Augno system owner.

objectstringenumValues:owner

Resource type identifier.

typestringenumValues:systemaccount

Where this resource came from.

  • system: a platform-provided default shared across all accounts; not editable.
  • account: created and owned by a specific account; the account field identifies which.
accountaccountnullable

The account that owns this resource.

Present only when type is account; system-owned resources have no owning account.

Always returned as null in this endpoint.
created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

Responses

200

Successful response for Retrieve Priority