Skip to main content

 

 

Coupa Success Portal

Order Pad API

The Order Pad API lets you create a list, set, or kit of frequently requested items within a supplier catalog for easy ordering.

The URL to access order pad is: https://<instance>/api/order_pads

Use the API key from the API user (created from: /api_keys) to be able to retrieve expense reports from all users. If you use individual API keys, you will get expense reports for specified user.

See Integration Best Practices for more info.

Actions

Order Pad

Order Pad API allows you to:

Verb Path Action Description
POST /api/order_pads create Create order pad
GET /api/order_pads index Query order pads
GET /api/order_pads/:id show Show order pad
PATCH /api/order_pads/:id update Update order pad
PUT /api/order_pads/:id update Update order pad

Order Pad Lines

Order Pad Lines allows you to:

Verb Path Action Description
POST /api/order_pads/:order_pad_id/order_pad_lines create Create order pad line
GET /api/order_pads/:order_pad_id/order_pad_lines index Query order pad lines
GET /api/order_pads/:order_pad_id/order_pad_lines/:id show Show order pad line
PATCH /api/order_pads/:order_pad_id/order_pad_lines/:id update Update order pad line
PUT /api/order_pads/:order_pad_id/order_pad_lines/:id update Update order pad line

Elements

Order Pad

Element Description Type API In API Out Required Length Allowable Values
add-all-items add all items integer yes   no -  
any-supplier any supplier boolean yes yes no -  
base-value base value integer yes yes yes -  
base-value-currency base value currency Currency yes yes no -  
business-groups business groups BusinessGroup yes yes no -  
created-at Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ datetime   yes no -  
created-by User who created integer   yes no -  
id Coupa unique identifier integer   yes no -  
locked locked boolean yes yes no -  
name name string yes yes yes -  
order-pad-lines order pad lines OrderPadLine yes yes no -  
order-pad-sections order pad sections OrderPadSection yes yes no -  
suppliers suppliers Supplier yes yes no -  
updated-at Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ datetime   yes no -  
updated-by User who updated integer   yes no -  
use-base-value use base value boolean yes yes no -  

Order Pad Lines

Element Description Type API In API Out Required Length Allowable Values
amount amount decimal yes yes      
created-at Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ datetime   yes      
created-by User who created integer   yes      
id Coupa unique identifier integer   yes      
item item Item yes yes yes    
key-item key_item boolean yes yes      
order-amount-method order_amount_method string yes yes yes   amount, par
order-pad-section order_pad_section OrderPadSection yes yes      
par-level par_level decimal yes yes      
position position integer yes yes      
supplier-id supplier_id integer yes yes yes    
updated-at Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ datetime   yes      
updated-by User who updated integer   yes      

 

  • Was this article helpful?