COcoupa
Commodity

Query commodities

Query commodities

get/commodities

Request

  • Base URL
    https://r38.coupadev.com/api
  • Auth
    • OAuth 2
      Authorization codehttps://r38.coupadev.com/oauth2/authorizations/new
      Token URLhttps://r38.coupadev.com/oauth2/token
    • or OAuth 2
      Client credentials
      Token URLhttps://r38.coupadev.com/oauth2/access_tokens
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Query parameters

limitinteger
offsetinteger
order_bystring
dir'asc' | 'desc'
return_object'limited' | 'shallow' | 'none'
filterstring

Response

Commodity objects

activeboolean

A false value will inactivate the account making it no longer available to users. A true value will make it active and available to users.

category'goods' | 'services' string(255)

Category

created-atstring datetime

Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ

deductibility'fully_deductible' | 'partially_deductible' | 'not_deductible' string(255)

Deductibility

idinteger

Coupa unique identifier

imported-from-taxonomyboolean

A true value will tell that the commodity is imported from Coupa Taxonomy. A false value will tell that the value is created by a user or system

namestring string(255) required

name

parentCommodity circular
preferred'Yes' | 'No' | 'Automatic' | 'Always' | 'Never' string(255)

A Yes/No value will mark/unmark commodity as preferred. Set to Automate if you want the system to mark preferred. 'Automatic' option is available only if 'Automatic Guided Requests configuration' is enabled in company information

subcategory'raw_materials' | 'investment_goods' | 'services_exceptions' string(255)

Subcategory

translated-namestring string

Translated name

updated-atstring datetime

Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ

Changes

No recorded changes to this operation across all 1 revision of this API.