• Last edited on: 13 May 2022

Items API (/items)

Use the catalog items API to create, update, or query goods not provided by suppliers that your employees will select from when creating a requisition.

Use the catalog items API to create, update, or query goods not provided by suppliers that your employees will select from when creating a requisition.

The URL to access items is: https://<instance>/api/items

See Integration Best Practices for more info.

API Objects

wiki.tree();

Actions

The Items API allows you to:

Verb Path Action Description
POST /api/items create Create item
GET /api/items/:id/image image /api/items/:id/image
GET /api/items index Query items
GET /api/items/:id show Show item
PATCH /api/items/:id update Update item
PUT /api/items/:id update Update item

Elements

The following elements are available for the Items API:

Element Description Required Field? Unique? Allowable Value Api_In Field? Api_Out Field? Data Type
active Is the item given for this supplier & contract active? and if NOT then DELETE       yes yes boolean
allow-partial-quantity  Allow partial quantity in cycle counts  yes boolean
commodity Commodity       yes yes Commodity
connect-item-id connect_item_id       yes   integer
consumption-quantity consumption_quantity       yes yes integer
consumption-uom consumption_uom       yes yes UoM
created-at Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ         yes datetime
created-by User who created         yes User
description Item desciption yes     yes yes text
external-image-url External image URL for item image         yes string
id Coupa unique identifier         yes integer
image-url URL for item image (will be copied into Coupa on item create/update)       yes   string
inventory-lot-expiration-type  Lot expiration type  yes string
inventory-lot-tracking-enabled  Enable lot tracking  yes boolean
item-number Unique item number   yes   yes yes string
item-type Item Type no no any yes yes Item
manufacturer-name Manufacturer name yes     yes yes string(255)
manufacturer-part-number Manufacturer part number   yes   yes yes string(255)
name Item name yes     yes yes string
net-weight net_weight yes     yes   decimal
net-weight-uom net_weight_uom       yes   UoM
pack-qty pack_qty yes     yes   decimal
pack-uom pack_uom       yes   UoM
pack-weight pack_weight yes     yes   decimal
receive-catch-weight receive_catch_weight       yes   boolean
receiving-form receiving_form       yes yes
reorder-alerts reorder_alerts         yes
reorder-point reorder_point       yes   float
require-asset-tag  Require asset tag  yes boolean
require-inspection  Require inspection  yes boolean
storage-quantity storage_quantity       yes yes integer
storage-uom storage_uom       yes yes UoM
tax_detail Tax detail       yes yes  
uom Unit of Measure       yes yes UoM
updated-at Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ         yes datetime
updated-by User who updated         yes User
use-pack-weight use_pack_weight       yes   boolean
Note

The Commodity and UOM must already exist in the system.

Related Items


Differences between XML and JSON in Coupa

16 December 2016

Tagging API

24 April 2017

Use the Tagging API to bring in and export tags to your third-party system.

Integration Runs API

24 April 2017

Use this API to create, query, or update an integration run, as well as update the status.

Dispute Reason API

05 August 2017