Difference between revisions of "XcelData:Terms"
(Created page with "= Terms commonly used in the API = == API Key == '''''uuid:''' 00000000-0000-0000-0000-000000000000'' The stores API key. == Output Format == '''''enum:''' json or xml'' T...") |
|||
| Line 1: | Line 1: | ||
= Terms commonly used in the API = | = Terms commonly used in the API = | ||
| − | == | + | == api-key == |
'''''uuid:''' 00000000-0000-0000-0000-000000000000'' | '''''uuid:''' 00000000-0000-0000-0000-000000000000'' | ||
| − | + | A valid API key. Store API keys can be obtained from [https://app.xceldata.com/customers app.xceldata.com/customers] | |
| − | == | + | ==adj-buy== |
| + | '''''integer or decimal:''' 0-200'' | ||
| + | |||
| + | Adjusts the buy amount by '''n''' percent. | ||
| + | |||
| + | ==adj-loan== | ||
| + | '''''integer or decimal:''' 0-200'' | ||
| + | |||
| + | Adjusts the buy amount by '''n''' percent. | ||
| + | |||
| + | ==adj-sell== | ||
| + | '''''integer or decimal:''' 0-200'' | ||
| + | |||
| + | Adjusts the buy amount by '''n''' percent. | ||
| + | |||
| + | ==unit-type== | ||
| + | '''''enum:''' dwt or gr'' | ||
| + | |||
| + | Specifies Pennyweight or Grams (what will be shown to tellers) | ||
| + | |||
| + | == output-format == | ||
'''''enum:''' json or xml'' | '''''enum:''' json or xml'' | ||
| − | + | Specifies XML or JSON output. | |
Revision as of 17:43, 26 April 2018
Contents
Terms commonly used in the API
api-key
uuid: 00000000-0000-0000-0000-000000000000
A valid API key. Store API keys can be obtained from app.xceldata.com/customers
adj-buy
integer or decimal: 0-200
Adjusts the buy amount by n percent.
adj-loan
integer or decimal: 0-200
Adjusts the buy amount by n percent.
adj-sell
integer or decimal: 0-200
Adjusts the buy amount by n percent.
unit-type
enum: dwt or gr
Specifies Pennyweight or Grams (what will be shown to tellers)
output-format
enum: json or xml
Specifies XML or JSON output.
