Account Statuses

The account_status object

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

idstring

Account status ID.

objectstringenumValues:account_status

Resource type identifier.

codestringenumValues:normalpreferredhold_shipment

Machine-readable status code.

This is the value used as a customer's status.

  • normal: standard account with no restrictions.
  • preferred: account flagged as preferred (e.g. for prioritized handling).
  • hold_shipment: shipments to this account are held; orders may still be placed.
  • hold_all: all activity for this account is held.
namestring

Human-readable label for the status.

ownerownernullable

Owner of this resource.

Account statuses are system-owned platform defaults shared across all accounts.

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.

Used by

GETList Account StatusesAccount StatusesGETRetrieve Account StatusAccount Statuses