cannedUoms

query · in the family Reading your records

What it does

The platform’s preset units of measure (each, pair, kilogram…) — copy or reference them instead of redefining the basics.

The canned UoM registry. Requires authentication.

What happens

Reads only.

Who may call it

Capability area: Reading your records — Looking up and listing the records of your organization.

• Owner
• System Administrator
• Manager
• Associate Manager
• Warehouse Associate
• Sales Associate
• An API key whose scope allows api:cannedUoms

Returns

CannedUom [CannedUom!]! — One canned unit of measure.

Example request

query ExampleCannedUoms {
  cannedUoms {
    code
    caption
    dimensionClass
    factorToBase
  }
}

Example response

{
  "data": {
    "cannedUoms": [
      {
        "code": "BJ-001",
        "caption": "Blue jeans",
        "dimensionClass": "count",
        "factorToBase": 1.5
      }
    ]
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": null,
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

Errors this call can answer

• VALIDATION/INVALID — Something in the request is not valid. (VALIDATION)
• AUTHN/REQUIRED — Sign in to do this. (AUTHN)
• AUTHZ/FORBIDDEN — Your role does not allow this action. (AUTHZ)
• RATE_LIMIT/THROTTLED — Too many requests in a short time. (RATE_LIMIT)