Javasript SDK for the Ordercloud HeadStart API
npm install @ordercloud/headstart-sdkshell
npm install @ordercloud/headstart-sdk --save
`
Usage
`typescript
import { HeadStartSDK } from '@ordercloud/headstart-sdk';
let page = 1;
let pageSize = 100;
let search = "boots"
let taxCategory = "P0" // tangible personal property
let taxCodes: ListPage = await MarketplaceSDK.TaxCodes.GetTaxCodes({ filters: { Category: taxCategory }, search, page, pageSize });
`
🔐 Authentication
Marketplace Authentication uses tokens from the Ordercloud auth server
`javascript
// Login
HeadStartSDK.Tokens.SetAccessToken("ordercloud-access-token");
// Logout
HeadStartSDK.Tokens.RemoveAccessToken();
`
🔍 Filtering
All of the filtering options you love from the API are available through the SDK as well. Simply build an object that matches the model of the item you're filtering on where the value is the value you'd like to filter on.
Let's run through a couple scenarios and what the call will look like with the SDK:
My products where xp.Featured is true
`javascript
Me.ListProducts({ filters: { xp: { Featured: true } } })
.then(productList => console.log(productList));
`
My orders submitted after April 20th, 2018
`javascript
Me.ListOrders({ filters: { DateSubmitted: '>2018-04-20' } })
.then(orderList => console.log(orderList))
`
Users with the last name starting with Smith:
`javascript
Users.List('my-mock-buyerid', { filters: { LastName: 'Smith*' } })
.then(userList => console.log(userList));
`
Users with the last name starting with Smith or users with the last name ending with Jones
`javascript
Users.List('my-mock-buyerid', { filters: { LastName: 'Smith|Jones' } })
.then(userList => console.log(userList));
`
Products where xp.Color is not red and not blue
`javascript
Products.List({ filters: { xp: { Color: ['!red', '!blue'] } } })
.then(productList => console.log(productList));
``