Skip to main content

 

 

Coupa Success Portal

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.

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

See Integration Best Practices for more info.

Actions

The Items API allows you to:

Verb Path Action Description
POST /api/items create Create item
GET /api/items index Query items
GET /api/items/:id show Show 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
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
item-number Unique item number   yes   yes yes string
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
storage-quantity storage_quantity       yes yes integer
storage-uom storage_uom       yes yes UoM
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

The Commodity and UOM must already exist in the system.

  • Was this article helpful?