sk_us_api v1.0.14
sk_us_api
SkUsApi - JavaScript client for sk_us_api A stock keeping unit (SKU) represents a specific product variation.
This SDK is automatically generated by the OpenAPI Generator project:
- API version: 1.0.13
- Package version: 1.0.13
- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen
Installation
For Node.js
npm
To publish the library as a npm, please follow the procedure in "Publishing npm packages".
Then install it via:
npm install sk_us_api --save
Local development
To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json
(and this README). Let's call this JAVASCRIPT_CLIENT_DIR
. Then run:
npm install
Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR
:
npm link
Finally, switch to the directory you want to use your sk_us_api from, and run:
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
You should now be able to require('sk_us_api')
in javascript files from the directory you ran the last command above from.
git
If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:
npm install GIT_USER_ID/GIT_REPO_ID --save
For browser
The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify
, perform the following (assuming main.js is your entry file, that's to say your javascript file where you actually use this library):
browserify main.js > bundle.js
Then include bundle.js in the HTML pages.
Webpack Configuration
Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:
module: {
rules: [
{
parser: {
amd: false
}
}
]
}
Getting Started
Please follow the installation instruction and execute the following JS code:
var SkUsApi = require('sk_us_api');
var api = new SkUsApi.SKUsApi()
var opts = {
'skuRequest': new SkUsApi.SkuRequest() // {SkuRequest}
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.createSkus(opts, callback);
Documentation for API Endpoints
All URIs are relative to https://virtserver.swaggerhub.com/DigitalRiverX
Class | Method | HTTP request | Description |
---|---|---|---|
SkUsApi.SKUsApi | createSkus | POST /skus | Creates a SKU. |
SkUsApi.SKUsApi | deleteSkus | DELETE /skus/{id} | Deletes a SKU by ID. |
SkUsApi.SKUsApi | listSkus | GET /skus | Returns a list of SKUs. |
SkUsApi.SKUsApi | retrieveSkus | GET /skus/{id} | Gets a SKU by ID. |
SkUsApi.SKUsApi | updateSkus | POST /skus/{id} | Updates a SKU. |
SkUsApi.SKUsApi | upsertSkus | PUT /skus/{id} | Upserts a SKU. |
Documentation for Models
- SkUsApi.Error
- SkUsApi.Errors
- SkUsApi.InlineResponse200
- SkUsApi.Sku
- SkUsApi.SkuRequest
- SkUsApi.SkuUpsertRequest
- SkUsApi.UpdateSkuRequest
Documentation for Authorization
All endpoints do not require authorization.