Cloud Commerce Consumer Procurement API: Node.js Client

release levelnpm version

Cloud Commerce Consumer Procurement API client for Node.js

A comprehensive list of changes in each version may be found inthe CHANGELOG.

Read more about the client libraries for Cloud APIs, including the olderGoogle APIs Client Libraries, inClient Libraries Explained.

Table of contents:

Quickstart

Before you begin

  1. Select or create a Cloud Platform project.
  2. Enable billing for your project.
  3. Enable the Cloud Commerce Consumer Procurement API API.
  4. Set up authentication so you can access theAPI from your local workstation.

Installing the client library

npm install @google-cloud/procurement

Using the client library

/** * This snippet has been automatically generated and should be regarded as a code template only. * It will require modifications to work. * It may require correct/in-range values for request initialization. * TODO(developer): Uncomment these variables before running the sample. *//** *  Required. The parent resource to query for orders. *  This field has the form `billingAccounts/{billing-account-id}`. */// const parent = 'abc123'/** *  The maximum number of entries requested. *  The default page size is 25 and the maximum page size is 200. */// const pageSize = 1234/** *  The token for fetching the next page. */// const pageToken = 'abc123'/** *  Filter that you can use to limit the list request. *  A query string that can match a selected set of attributes *  with string values. For example, `display_name=abc`. *  Supported query attributes are *  * `display_name` *  If the query contains special characters other than letters, *  underscore, or digits, the phrase must be quoted with double quotes. For *  example, `display_name="foo:bar"`, where the display name needs to be *  quoted because it contains special character colon. *  Queries can be combined with `OR`, and `NOT` to form more complex queries. *  You can also group them to force a desired evaluation order. *  For example, `display_name=abc OR display_name=def`. */// const filter = 'abc123'// Imports the Procurement libraryconst {ConsumerProcurementServiceClient} =  require('@google-cloud/procurement').v1alpha1;// Instantiates a clientconst procurementClient = newConsumerProcurementServiceClient();async function callListOrders() {  // Construct request  const request = {    parent,  };  // Run request  const iterable = await procurementClient.listOrdersAsync(request);  for await (const response of iterable) {    console.log(response);  }}callListOrders();

Samples

Samples are in thesamples/ directory. Each sample'sREADME.md has instructions for running its sample.

SampleSource CodeTry it
Consumer_procurement_service.cancel_ordersource codeOpen in Cloud Shell
Consumer_procurement_service.get_ordersource codeOpen in Cloud Shell
Consumer_procurement_service.list_orderssource codeOpen in Cloud Shell
Consumer_procurement_service.modify_ordersource codeOpen in Cloud Shell
Consumer_procurement_service.place_ordersource codeOpen in Cloud Shell
License_management_service.assignsource codeOpen in Cloud Shell
License_management_service.enumerate_licensed_userssource codeOpen in Cloud Shell
License_management_service.get_license_poolsource codeOpen in Cloud Shell
License_management_service.unassignsource codeOpen in Cloud Shell
License_management_service.update_license_poolsource codeOpen in Cloud Shell
Consumer_procurement_service.get_ordersource codeOpen in Cloud Shell
Consumer_procurement_service.list_orderssource codeOpen in Cloud Shell
Consumer_procurement_service.place_ordersource codeOpen in Cloud Shell
Quickstartsource codeOpen in Cloud Shell

TheCloud Commerce Consumer Procurement API Node.js Client API Reference documentationalso contains samples.

Supported Node.js Versions

Our client libraries follow theNode.js release schedule.Libraries are compatible with all currentactive andmaintenance versions ofNode.js.If you are using an end-of-life version of Node.js, we recommend that you updateas soon as possible to an actively supported LTS version.

Google's client libraries support legacy versions of Node.js runtimes on abest-efforts basis with the following warnings:

  • Legacy versions are not tested in continuous integration.
  • Some security patches and features cannot be backported.
  • Dependencies cannot be kept up-to-date.

Client libraries targeting some end-of-life versions of Node.js are available, andcan be installed through npmdist-tags.The dist-tags follow the naming conventionlegacy-(version).For example,npm install @google-cloud/procurement@legacy-8 installs client librariesfor versions compatible with Node.js 8.

Versioning

This library followsSemantic Versioning.

This library is considered to bestable. The code surface will not change in backwards-incompatible waysunless absolutely necessary (e.g. because of critical security issues) or withan extensive deprecation period. Issues and requests againststable librariesare addressed with the highest priority.

More Information:Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See theContributing Guide.

Please note that thisREADME.md, thesamples/README.md,and a variety of configuration files in this repository (including.nycrc andtsconfig.json)are generated from a central template. To edit one of these files, make an editto its templates indirectory.

License

Apache Version 2.0

SeeLICENSE

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-10-30 UTC.